flowbase-cli 0.1.4__tar.gz → 0.1.5__tar.gz

{flowbase_cli-0.1.4 → flowbase_cli-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowbase-cli
-Version: 0.1.4
+Version: 0.1.5
 Summary: Command line client for the FlowBase OpenAPI
 Author: DeepFlowAI
 License: Apache-2.0

{flowbase_cli-0.1.4 → flowbase_cli-0.1.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "flowbase-cli"
-version = "0.1.4"
+version = "0.1.5"
 description = "Command line client for the FlowBase OpenAPI"
 readme = "README.md"
 requires-python = ">=3.11"

{flowbase_cli-0.1.4 → flowbase_cli-0.1.5}/src/flowbase_cli/__init__.py

@@ -1,3 +1,3 @@
 """FlowBase OpenAPI CLI."""
 
-__version__ = "0.1.4"
+__version__ = "0.1.5"

{flowbase_cli-0.1.4 → flowbase_cli-0.1.5}/src/flowbase_cli/endpoints.py

@@ -20,10 +20,53 @@ class Endpoint:
 
 
 ENDPOINTS = (
+    Endpoint("apps.list", "flowbase_apps_list", "GET", "/apps", "metadata:read", "List apps.", "flowbase apps list"),
+    Endpoint("apps.get", "flowbase_apps_get", "GET", "/apps/{app_id}", "metadata:read", "Get app metadata with groups and objects.", "flowbase apps get app_xxx"),
+    Endpoint("apps.create", "flowbase_apps_create", "POST", "/apps", "metadata:write", "Create an app draft.", "flowbase apps create --json-file app.json"),
+    Endpoint("apps.update", "flowbase_apps_update", "PUT", "/apps/{app_id}", "metadata:write", "Update an app draft.", "flowbase apps update app_xxx --label CRM --color '#2563EB'"),
+    Endpoint("apps.set-enabled", "flowbase_apps_set_enabled", "POST", "/apps/{app_id}/enabled", "metadata:write", "Enable or disable an app.", "flowbase apps set-enabled app_xxx --enabled --yes", True),
+    Endpoint("apps.delete", "flowbase_apps_delete", "DELETE", "/apps/{app_id}", "metadata:write", "Delete an empty app.", "flowbase apps delete app_xxx --yes", True),
+    Endpoint(
+        "apps.groups.create",
+        "flowbase_apps_groups_create",
+        "POST",
+        "/apps/{app_id}/groups",
+        "metadata:write",
+        "Create an app group draft.",
+        "flowbase groups create app_xxx --name Sales --icon IconFolder",
+    ),
+    Endpoint(
+        "apps.groups.update",
+        "flowbase_apps_groups_update",
+        "PUT",
+        "/apps/{app_id}/groups/{group_id}",
+        "metadata:write",
+        "Update an app group draft.",
+        "flowbase groups update app_xxx grp_xxx --name Sales",
+    ),
+    Endpoint(
+        "apps.groups.delete",
+        "flowbase_apps_groups_delete",
+        "DELETE",
+        "/apps/{app_id}/groups/{group_id}",
+        "metadata:write",
+        "Delete an app group (objects become ungrouped).",
+        "flowbase groups delete app_xxx grp_xxx --yes",
+        True,
+    ),
     Endpoint("objects.list", "flowbase_objects_list", "GET", "/objects", "metadata:read", "List object metadata.", "flowbase objects list"),
     Endpoint("objects.get", "flowbase_objects_get", "GET", "/objects/{object_id}", "metadata:read", "Get object and field metadata.", "flowbase objects get obj_xxx"),
     Endpoint("objects.create", "flowbase_objects_create", "POST", "/objects", "metadata:write", "Create an object draft.", "flowbase objects create --json-file object.json"),
     Endpoint("objects.update", "flowbase_objects_update", "PUT", "/objects/{object_id}", "metadata:write", "Update an object draft.", "flowbase objects update obj_xxx --label Customer --description 'Customer records'"),
+    Endpoint(
+        "objects.set-group",
+        "flowbase_objects_set_group",
+        "POST",
+        "/objects/{object_id}/group",
+        "metadata:write",
+        "Move an object into an app group or ungroup it.",
+        "flowbase objects set-group obj_xxx --group-id grp_xxx",
+    ),
     Endpoint("objects.delete", "flowbase_objects_delete", "DELETE", "/objects/{object_id}", "metadata:write", "Logically delete an object.", "flowbase objects delete obj_xxx --yes", True),
     Endpoint("objects.restore", "flowbase_objects_restore", "POST", "/objects/{object_id}/restore", "metadata:write", "Restore an object.", "flowbase objects restore obj_xxx --yes", True),
     Endpoint("fields.create", "flowbase_fields_create", "POST", "/objects/{object_id}/fields", "metadata:write", "Create a field draft.", "flowbase fields create obj_xxx --json-file field.json"),
@@ -97,6 +140,8 @@ ENDPOINTS = (
     ),
     Endpoint("records.list", "flowbase_records_list", "GET", "/objects/{object_id}/records", "records:read", "List records.", "flowbase records list obj_xxx --page 1"),
     Endpoint("records.get", "flowbase_records_get", "GET", "/objects/{object_id}/records/{record_id}", "records:read", "Get a record.", "flowbase records get obj_xxx rec_xxx"),
+    Endpoint("records.upload-attachment", "flowbase_records_upload_attachment", "POST", "/objects/{object_id}/fields/{field_id}/attachments", "records:write", "Upload an attachment before writing its ID to a record.", "flowbase records upload-attachment obj_xxx fld_xxx ./document.pdf"),
+    Endpoint("records.download-attachment", "flowbase_records_download_attachment", "GET", "/objects/{object_id}/records/{record_id}/attachments/{attachment_id}", "records:read", "Download an attachment bound to a record.", "flowbase records download-attachment obj_xxx rec_xxx att_xxx --output ./document.pdf"),
     Endpoint("records.create", "flowbase_records_create", "POST", "/objects/{object_id}/records", "records:write", "Create a record.", "flowbase records create obj_xxx --json-file record.json"),
     Endpoint("records.update", "flowbase_records_update", "PUT", "/objects/{object_id}/records/{record_id}", "records:write", "Replace active field values on a record.", "flowbase records update obj_xxx rec_xxx --json-file record.json"),
     Endpoint("records.delete", "flowbase_records_delete", "DELETE", "/objects/{object_id}/records/{record_id}", "records:write", "Delete a record.", "flowbase records delete obj_xxx rec_xxx --yes", True),

{flowbase_cli-0.1.4 → flowbase_cli-0.1.5}/src/flowbase_cli/main.py

@@ -4,7 +4,9 @@ from __future__ import annotations
 import argparse
 from decimal import Decimal
 import json
+import mimetypes
 import os
+import secrets
 import sys
 from pathlib import Path
 from typing import Any
@@ -97,20 +99,27 @@ class OpenApiClient:
         path_params: dict[str, Any] | None = None,
         query: dict[str, Any] | None = None,
         body: dict[str, Any] | None = None,
+        raw_body: bytes | None = None,
+        content_type: str | None = None,
+        accept: str = "application/json",
     ) -> bytes:
         endpoint = get_endpoint(endpoint_key)
         if not self.api_key:
             raise CliError(f"Missing API key. Set {ENV_API_KEY} or pass --api-key.")
         url = self.build_url(endpoint, path_params, query)
         headers = {
-            "Accept": "application/json",
+            "Accept": accept,
             "Authorization": f"Bearer {self.api_key}",
             "X-FlowBase-Channel": "cli",
         }
-        data = None
+        if body is not None and raw_body is not None:
+            raise CliError("JSON and raw request bodies cannot be used together.")
+        data = raw_body
         if body is not None:
             data = exact_json_dumps(body).encode("utf-8")
             headers["Content-Type"] = "application/json"
+        elif raw_body is not None and content_type:
+            headers["Content-Type"] = content_type
         request = Request(url, data=data, headers=headers, method=endpoint.method)
         try:
             with urlopen(request) as response:  # noqa: S310 - the user selects the FlowBase host.
@@ -164,6 +173,30 @@ def exact_json_dumps(value: Any) -> str:
     raise CliError(f"Unsupported JSON value: {type(value).__name__}")
 
 
+def multipart_upload(path_value: str) -> tuple[bytes, str]:
+    path = Path(path_value)
+    try:
+        content = path.read_bytes()
+    except OSError as exc:
+        raise CliError(f"Cannot read attachment: {exc}") from exc
+    filename = path.name.replace('"', "_").replace("\r", "_").replace("\n", "_") or "file"
+    boundary = f"flowbase-{secrets.token_hex(16)}"
+    content_type = mimetypes.guess_type(filename)[0] or "application/octet-stream"
+    ascii_name = filename.encode("ascii", errors="replace").decode("ascii")
+    disposition = (
+        f'Content-Disposition: form-data; name="upload"; filename="{ascii_name}"; '
+        f"filename*=UTF-8''{quote(filename, safe='')}\r\n"
+    ).encode("ascii")
+    payload = b"".join([
+        f"--{boundary}\r\n".encode("ascii"),
+        disposition,
+        f"Content-Type: {content_type}\r\n\r\n".encode("ascii"),
+        content,
+        f"\r\n--{boundary}--\r\n".encode("ascii"),
+    ])
+    return payload, f"multipart/form-data; boundary={boundary}"
+
+
 def print_output(data: bytes, *, pretty: bool, raw: bool) -> None:
     text = data.decode("utf-8", errors="replace")
     if raw:
@@ -276,6 +309,50 @@ def _payload_from_args(args: argparse.Namespace, direct: dict[str, Any], require
     return payload
 
 
+def handle_apps(args: argparse.Namespace) -> int:
+    action = args.apps_action
+    if action == "list":
+        return run_request(args, "apps.list")
+    if action == "get":
+        return run_request(args, "apps.get", path_params={"app_id": args.app_id})
+    if action == "create":
+        body = _payload_from_args(
+            args,
+            {"label": args.label, "key": args.key, "icon": args.icon, "color": args.color},
+            ("label", "key"),
+        )
+        return run_request(args, "apps.create", body=body)
+    if action == "update":
+        body = _payload_from_args(
+            args,
+            {"label": args.label, "icon": args.icon, "color": args.color},
+            ("label", "icon", "color"),
+        )
+        return run_request(args, "apps.update", path_params={"app_id": args.app_id}, body=body)
+    if action == "set-enabled":
+        return run_request(
+            args,
+            "apps.set-enabled",
+            path_params={"app_id": args.app_id},
+            body={"enabled": args.enabled},
+        )
+    return run_request(args, "apps.delete", path_params={"app_id": args.app_id})
+
+
+def handle_groups(args: argparse.Namespace) -> int:
+    action = args.groups_action
+    path = {"app_id": args.app_id}
+    if action == "create":
+        body = _payload_from_args(args, {"name": args.name, "icon": args.icon}, ("name",))
+        return run_request(args, "apps.groups.create", path_params=path, body=body)
+    if action == "update":
+        path["group_id"] = args.group_id
+        body = _payload_from_args(args, {"name": args.name, "icon": args.icon}, ("name", "icon"))
+        return run_request(args, "apps.groups.update", path_params=path, body=body)
+    path["group_id"] = args.group_id
+    return run_request(args, "apps.groups.delete", path_params=path)
+
+
 def handle_objects(args: argparse.Namespace) -> int:
     action = args.objects_action
     if action == "list":
@@ -285,13 +362,39 @@ def handle_objects(args: argparse.Namespace) -> int:
     if action == "create":
         body = _payload_from_args(
             args,
-            {"label": args.label, "key": args.key, "description": args.description},
+            {
+                "label": args.label,
+                "key": args.key,
+                "description": args.description,
+                "appId": args.app_id,
+            },
             ("label", "key", "description"),
         )
         return run_request(args, "objects.create", body=body)
     if action == "update":
-        body = _payload_from_args(args, {"label": args.label, "description": args.description}, ("label", "description"))
+        body = _payload_from_args(
+            args,
+            {
+                "label": args.label,
+                "description": args.description,
+                "appId": args.app_id,
+            },
+            ("label", "description"),
+        )
         return run_request(args, "objects.update", path_params={"object_id": args.object_id}, body=body)
+    if action == "set-group":
+        if args.ungrouped:
+            body = {"groupId": None}
+        elif args.group_id is not None:
+            body = {"groupId": args.group_id}
+        else:
+            raise CliError("Provide --group-id or --ungrouped.")
+        return run_request(
+            args,
+            "objects.set-group",
+            path_params={"object_id": args.object_id},
+            body=body,
+        )
     return run_request(args, f"objects.{action}", path_params={"object_id": args.object_id})
 
 
@@ -513,6 +616,31 @@ def handle_environments(args: argparse.Namespace) -> int:
 def handle_records(args: argparse.Namespace) -> int:
     action = args.records_action
     path = {"object_id": args.object_id}
+    if action == "upload-attachment":
+        body, content_type = multipart_upload(args.file)
+        data = client_from_args(args).request(
+            "records.upload-attachment",
+            path_params={**path, "field_id": args.field_id},
+            raw_body=body,
+            content_type=content_type,
+        )
+        print_output(data, pretty=args.pretty, raw=args.raw)
+        return 0
+    if action == "download-attachment":
+        data = client_from_args(args).request(
+            "records.download-attachment",
+            path_params={
+                **path,
+                "record_id": args.record_id,
+                "attachment_id": args.attachment_id,
+            },
+            accept="application/octet-stream",
+        )
+        try:
+            Path(args.output).write_bytes(data)
+        except OSError as exc:
+            raise CliError(f"Cannot write attachment: {exc}") from exc
+        return 0
     if hasattr(args, "record_id"):
         path["record_id"] = args.record_id
     if action == "list":
@@ -537,6 +665,7 @@ def add_object_fields(parser: argparse.ArgumentParser, *, include_key: bool) ->
     if include_key:
         parser.add_argument("--key")
     parser.add_argument("--description")
+    parser.add_argument("--app-id", help="Owning app ID (appId).")
     add_json_args(parser)
 
 
@@ -560,6 +689,55 @@ def build_parser() -> argparse.ArgumentParser:
     docs_show.add_argument("endpoint", choices=sorted(ENDPOINT_BY_KEY))
     docs.set_defaults(handler=handle_docs)
 
+    apps = groups.add_parser("apps", help="Manage app metadata.")
+    app_actions = apps.add_subparsers(dest="apps_action", required=True)
+    app_actions.add_parser("list")
+    app_get = app_actions.add_parser("get")
+    app_get.add_argument("app_id")
+    app_create = app_actions.add_parser("create")
+    app_create.add_argument("--label")
+    app_create.add_argument("--key")
+    app_create.add_argument("--icon")
+    app_create.add_argument("--color")
+    add_json_args(app_create)
+    app_update = app_actions.add_parser("update")
+    app_update.add_argument("app_id")
+    app_update.add_argument("--label")
+    app_update.add_argument("--icon")
+    app_update.add_argument("--color")
+    add_json_args(app_update)
+    app_enabled = app_actions.add_parser("set-enabled")
+    app_enabled.add_argument("app_id")
+    app_enabled.add_argument(
+        "--enabled",
+        action=argparse.BooleanOptionalAction,
+        required=True,
+    )
+    add_yes(app_enabled)
+    app_delete = app_actions.add_parser("delete")
+    app_delete.add_argument("app_id")
+    add_yes(app_delete)
+    apps.set_defaults(handler=handle_apps)
+
+    app_groups = groups.add_parser("groups", help="Manage app object groups.")
+    group_actions = app_groups.add_subparsers(dest="groups_action", required=True)
+    group_create = group_actions.add_parser("create")
+    group_create.add_argument("app_id")
+    group_create.add_argument("--name")
+    group_create.add_argument("--icon")
+    add_json_args(group_create)
+    group_update = group_actions.add_parser("update")
+    group_update.add_argument("app_id")
+    group_update.add_argument("group_id")
+    group_update.add_argument("--name")
+    group_update.add_argument("--icon")
+    add_json_args(group_update)
+    group_delete = group_actions.add_parser("delete")
+    group_delete.add_argument("app_id")
+    group_delete.add_argument("group_id")
+    add_yes(group_delete)
+    app_groups.set_defaults(handler=handle_groups)
+
     objects = groups.add_parser("objects", help="Manage object metadata.")
     object_actions = objects.add_subparsers(dest="objects_action", required=True)
     object_list = object_actions.add_parser("list")
@@ -571,6 +749,14 @@ def build_parser() -> argparse.ArgumentParser:
     object_update = object_actions.add_parser("update")
     object_update.add_argument("object_id")
     add_object_fields(object_update, include_key=False)
+    object_set_group = object_actions.add_parser("set-group")
+    object_set_group.add_argument("object_id")
+    object_set_group.add_argument("--group-id", help="Target group ID. Omit with --ungrouped.")
+    object_set_group.add_argument(
+        "--ungrouped",
+        action="store_true",
+        help="Remove the object from its current group.",
+    )
     for action in ("delete", "restore"):
         item = object_actions.add_parser(action)
         item.add_argument("object_id")
@@ -693,6 +879,15 @@ def build_parser() -> argparse.ArgumentParser:
     record_get = record_actions.add_parser("get")
     record_get.add_argument("object_id")
     record_get.add_argument("record_id")
+    record_upload = record_actions.add_parser("upload-attachment")
+    record_upload.add_argument("object_id")
+    record_upload.add_argument("field_id")
+    record_upload.add_argument("file")
+    record_download = record_actions.add_parser("download-attachment")
+    record_download.add_argument("object_id")
+    record_download.add_argument("record_id")
+    record_download.add_argument("attachment_id")
+    record_download.add_argument("--output", required=True)
     record_create = record_actions.add_parser("create")
     record_create.add_argument("object_id")
     add_json_args(record_create)

{flowbase_cli-0.1.4 → flowbase_cli-0.1.5}/src/flowbase_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowbase-cli
-Version: 0.1.4
+Version: 0.1.5
 Summary: Command line client for the FlowBase OpenAPI
 Author: DeepFlowAI
 License: Apache-2.0

{flowbase_cli-0.1.4 → flowbase_cli-0.1.5}/tests/test_cli.py

@@ -227,6 +227,103 @@ class FlowBaseCliTest(unittest.TestCase):
         self.assertEqual(code, 1)
         self.assertIn("description", stderr.getvalue())
 
+    def test_object_create_sends_app_id(self):
+        with patch(
+            "flowbase_cli.main.OpenApiClient.request",
+            return_value=b'{"objectId":"obj_1","draftRevision":2}',
+        ) as request:
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "objects",
+                "create",
+                "--label",
+                "Customer",
+                "--key",
+                "customer",
+                "--description",
+                "Customer records",
+                "--app-id",
+                "app_1",
+            ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.args[0], "objects.create")
+        self.assertEqual(
+            request.call_args.kwargs["body"],
+            {
+                "label": "Customer",
+                "key": "customer",
+                "description": "Customer records",
+                "appId": "app_1",
+            },
+        )
+
+    def test_group_create_and_object_set_group(self):
+        with patch(
+            "flowbase_cli.main.OpenApiClient.request",
+            return_value=b'{"groupId":"grp_1","draftRevision":3}',
+        ) as request:
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "groups",
+                "create",
+                "app_1",
+                "--name",
+                "Sales",
+                "--icon",
+                "IconFolder",
+            ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.args[0], "apps.groups.create")
+        self.assertEqual(request.call_args.kwargs["path_params"], {"app_id": "app_1"})
+        self.assertEqual(
+            request.call_args.kwargs["body"],
+            {"name": "Sales", "icon": "IconFolder"},
+        )
+
+        with patch(
+            "flowbase_cli.main.OpenApiClient.request",
+            return_value=b'{"ok":true,"draftRevision":4}',
+        ) as request:
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "objects",
+                "set-group",
+                "obj_1",
+                "--group-id",
+                "grp_1",
+            ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.args[0], "objects.set-group")
+        self.assertEqual(
+            request.call_args.kwargs["body"],
+            {"groupId": "grp_1"},
+        )
+
+        with patch(
+            "flowbase_cli.main.OpenApiClient.request",
+            return_value=b'{"ok":true,"draftRevision":5}',
+        ) as request:
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "objects",
+                "set-group",
+                "obj_1",
+                "--ungrouped",
+            ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.kwargs["body"], {"groupId": None})
+
+    def test_group_delete_requires_yes(self):
+        stderr = io.StringIO()
+        with patch("sys.stderr", stderr), patch("sys.stdin.isatty", return_value=False):
+            code = main(["--api-key", "fbk_test", "groups", "delete", "app_1", "grp_1"])
+        self.assertEqual(code, 1)
+        self.assertIn("without --yes", stderr.getvalue())
+
     def test_noninteractive_delete_requires_yes(self):
         stderr = io.StringIO()
         with patch("sys.stderr", stderr), patch("sys.stdin.isatty", return_value=False):
@@ -234,6 +331,44 @@ class FlowBaseCliTest(unittest.TestCase):
         self.assertEqual(code, 1)
         self.assertIn("without --yes", stderr.getvalue())
 
+    def test_record_attachment_upload_sends_multipart_body(self):
+        with TemporaryDirectory() as directory:
+            path = Path(directory) / "note.txt"
+            path.write_text("hello", encoding="utf-8")
+            with patch(
+                "flowbase_cli.main.OpenApiClient.request",
+                return_value=b'{"id":"att_1"}',
+            ) as request:
+                code = main([
+                    "--api-key", "fbk_test", "records", "upload-attachment",
+                    "obj_1", "fld_1", str(path),
+                ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.args[0], "records.upload-attachment")
+        self.assertEqual(
+            request.call_args.kwargs["path_params"],
+            {"object_id": "obj_1", "field_id": "fld_1"},
+        )
+        self.assertTrue(request.call_args.kwargs["content_type"].startswith("multipart/form-data; boundary="))
+        self.assertIn(b'name="upload"', request.call_args.kwargs["raw_body"])
+        self.assertIn(b"hello", request.call_args.kwargs["raw_body"])
+
+    def test_record_attachment_download_writes_exact_bytes(self):
+        with TemporaryDirectory() as directory:
+            output = Path(directory) / "download.pdf"
+            with patch(
+                "flowbase_cli.main.OpenApiClient.request",
+                return_value=b"%PDF-1.7",
+            ) as request:
+                code = main([
+                    "--api-key", "fbk_test", "records", "download-attachment",
+                    "obj_1", "rec_1", "att_1", "--output", str(output),
+                ])
+            self.assertEqual(output.read_bytes(), b"%PDF-1.7")
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.args[0], "records.download-attachment")
+        self.assertEqual(request.call_args.kwargs["accept"], "application/octet-stream")
+
     def test_noninteractive_commit_requires_yes(self):
         stderr = io.StringIO()
         with patch("sys.stderr", stderr), patch("sys.stdin.isatty", return_value=False):