flowbase-cli 0.1.1__tar.gz → 0.1.2__tar.gz

{flowbase_cli-0.1.1 → flowbase_cli-0.1.2}/PKG-INFO

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

{flowbase_cli-0.1.1 → flowbase_cli-0.1.2}/pyproject.toml

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

{flowbase_cli-0.1.1 → flowbase_cli-0.1.2}/src/flowbase_cli/__init__.py

@@ -1,3 +1,3 @@
 """FlowBase OpenAPI CLI."""
 
-__version__ = "0.1.1"
+__version__ = "0.1.2"

{flowbase_cli-0.1.1 → flowbase_cli-0.1.2}/src/flowbase_cli/endpoints.py

@@ -14,6 +14,9 @@ class Endpoint:
     summary: str
     example: str
     requires_confirmation: bool = False
+    environments: tuple[str, ...] = ("production", "test-a", "test-b")
+    preflight_operation_id: str | None = None
+    audit_event: str | None = None
 
 
 ENDPOINTS = (
@@ -27,8 +30,31 @@ ENDPOINTS = (
     Endpoint("fields.update", "flowbase_fields_update", "PUT", "/objects/{object_id}/fields/{field_id}", "metadata:write", "Update a field draft.", "flowbase fields update obj_xxx fld_xxx --label Name --description 'Customer name'"),
     Endpoint("fields.delete", "flowbase_fields_delete", "DELETE", "/objects/{object_id}/fields/{field_id}", "metadata:write", "Logically delete a field.", "flowbase fields delete obj_xxx fld_xxx --yes", True),
     Endpoint("fields.restore", "flowbase_fields_restore", "POST", "/objects/{object_id}/fields/{field_id}/restore", "metadata:write", "Restore a field.", "flowbase fields restore obj_xxx fld_xxx --yes", True),
-    Endpoint("changes.commit", "flowbase_changes_commit", "POST", "/changes/commit", "metadata:write", "Commit current test-environment drafts.", "flowbase changes commit --message 'Add customer field' --yes", True),
-    Endpoint("changes.release", "flowbase_changes_release", "POST", "/changes/release", "metadata:write", "Release the current test-environment version.", "flowbase changes release --message 'Release customer field' --yes", True),
+    Endpoint("changes.commit", "flowbase_changes_commit", "POST", "/changes/commit", "metadata:write", "Commit current test-environment drafts.", "flowbase changes commit --message 'Add customer field' --yes", True, environments=("test-a", "test-b"), audit_event="version.commit"),
+    Endpoint("changes.release", "flowbase_changes_release", "POST", "/changes/release", "metadata:write", "Release the current test-environment version.", "flowbase changes release --message 'Release customer field' --yes", True, environments=("test-a", "test-b"), audit_event="version.release"),
+    Endpoint(
+        "changes.direct-release-preflight",
+        "flowbase_changes_direct_release_preflight",
+        "POST",
+        "/changes/direct-release/preflight",
+        "metadata:write",
+        "Preflight a production direct release.",
+        "flowbase changes direct-release --message 'Fix production field' --yes",
+        environments=("production",),
+    ),
+    Endpoint(
+        "changes.direct-release",
+        "flowbase_changes_direct_release",
+        "POST",
+        "/changes/direct-release",
+        "metadata:write",
+        "Directly release production drafts.",
+        "flowbase changes direct-release --message 'Fix production field' --yes",
+        requires_confirmation=True,
+        environments=("production",),
+        preflight_operation_id="flowbase_changes_direct_release_preflight",
+        audit_event="version.forward-fix",
+    ),
     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.create", "flowbase_records_create", "POST", "/objects/{object_id}/records", "records:write", "Create a record.", "flowbase records create obj_xxx --json-file record.json"),
@@ -37,3 +63,12 @@ ENDPOINTS = (
 )
 
 ENDPOINT_BY_KEY = {endpoint.key: endpoint for endpoint in ENDPOINTS}
+
+PENDING_MANAGEMENT_OPERATIONS = (
+    {"key": "environments.enable", "status": "pending", "reason": "Requires an independent capability and confirmation contract."},
+    {"key": "environments.restart", "status": "pending", "reason": "Requires destructive data-reset confirmation."},
+    {"key": "changes.clear-drafts", "status": "pending", "reason": "Requires an independent capability and confirmation contract."},
+    {"key": "api-keys.manage", "status": "pending", "reason": "API keys cannot delegate or expand their own authority."},
+    {"key": "git-credentials.manage", "status": "pending", "reason": "Requires a dedicated credential-management capability."},
+    {"key": "metadata.purge", "status": "pending", "reason": "Physical purge is not delivered."},
+)

{flowbase_cli-0.1.1 → flowbase_cli-0.1.2}/src/flowbase_cli/main.py

@@ -12,7 +12,12 @@ from urllib.error import HTTPError, URLError
 from urllib.parse import quote, urlencode
 from urllib.request import Request, urlopen
 
-from flowbase_cli.endpoints import ENDPOINTS, ENDPOINT_BY_KEY, Endpoint
+from flowbase_cli.endpoints import (
+    ENDPOINTS,
+    ENDPOINT_BY_KEY,
+    PENDING_MANAGEMENT_OPERATIONS,
+    Endpoint,
+)
 
 DEFAULT_HOST = "http://flowbase.localhost:5001"
 API_PREFIX = "/api/openapi/v1"
@@ -202,9 +207,42 @@ def run_request(
 
 
 def handle_docs(args: argparse.Namespace) -> int:
+    if args.docs_action == "operations":
+        delivered = [
+            {
+                "key": endpoint.key,
+                "status": "delivered",
+                "operationId": endpoint.operation_id,
+                "method": endpoint.method,
+                "path": endpoint.path,
+                "scope": endpoint.scope,
+                "environments": list(endpoint.environments),
+                "requiresPreflight": endpoint.preflight_operation_id is not None,
+                "requiresConfirmation": endpoint.requires_confirmation,
+                "auditEvent": endpoint.audit_event,
+            }
+            for endpoint in ENDPOINTS
+            if endpoint.scope.startswith("metadata:")
+        ]
+        print(
+            json.dumps(
+                delivered + list(PENDING_MANAGEMENT_OPERATIONS),
+                ensure_ascii=False,
+                indent=2 if args.pretty else None,
+            )
+        )
+        return 0
     if args.docs_action == "list":
         payload = [
-            {"key": e.key, "operationId": e.operation_id, "method": e.method, "path": e.path, "scope": e.scope, "summary": e.summary}
+            {
+                "key": e.key,
+                "operationId": e.operation_id,
+                "method": e.method,
+                "path": e.path,
+                "scope": e.scope,
+                "environments": list(e.environments),
+                "summary": e.summary,
+            }
             for e in ENDPOINTS
         ]
         print(json.dumps(payload, ensure_ascii=False, indent=2 if args.pretty else None))
@@ -218,6 +256,9 @@ def handle_docs(args: argparse.Namespace) -> int:
         "scope": endpoint.scope,
         "summary": endpoint.summary,
         "requiresConfirmation": endpoint.requires_confirmation,
+        "environments": list(endpoint.environments),
+        "preflightOperationId": endpoint.preflight_operation_id,
+        "auditEvent": endpoint.audit_event,
         "example": endpoint.example,
     }
     print(json.dumps(payload, ensure_ascii=False, indent=2 if args.pretty else None))
@@ -269,9 +310,48 @@ def handle_fields(args: argparse.Namespace) -> int:
 
 
 def handle_changes(args: argparse.Namespace) -> int:
+    if args.changes_action == "direct-release":
+        client = client_from_args(args)
+        body = {"message": args.message}
+        preflight_data = client.request(
+            "changes.direct-release-preflight",
+            body=body,
+        )
+        try:
+            preflight = json.loads(preflight_data)
+        except json.JSONDecodeError as exc:
+            raise CliError("Direct-release preflight returned invalid JSON.") from exc
+        token = preflight.get("confirmationToken")
+        if not isinstance(token, str):
+            raise CliError("Direct-release preflight did not return a confirmation token.")
+        _print_direct_release_preflight(preflight)
+        endpoint = get_endpoint("changes.direct-release")
+        confirm_change(endpoint, args.yes)
+        data = client.request(
+            "changes.direct-release",
+            body={"message": args.message, "confirmationToken": token},
+        )
+        print_output(data, pretty=args.pretty, raw=args.raw)
+        return 0
     return run_request(args, f"changes.{args.changes_action}", body={"message": args.message})
 
 
+def _print_direct_release_preflight(preflight: dict[str, Any]) -> None:
+    print("Production direct-release preflight:", file=sys.stderr)
+    print(f"  Current main: {preflight.get('mainCommit', 'unknown')}", file=sys.stderr)
+    print(f"  Draft revision: {preflight.get('draftRevision', 'unknown')}", file=sys.stderr)
+    print(
+        f"  Changes: {preflight.get('semanticCount', 0)} semantic, "
+        f"{preflight.get('fileCount', 0)} files",
+        file=sys.stderr,
+    )
+    for check in preflight.get("checks", []):
+        if isinstance(check, dict):
+            mark = "OK" if check.get("ok") else "FAIL"
+            print(f"  [{mark}] {check.get('label', '')}", file=sys.stderr)
+    print(f"  RISK: {preflight.get('risk', 'This bypasses test environments.')}", file=sys.stderr)
+
+
 def handle_records(args: argparse.Namespace) -> int:
     action = args.records_action
     path = {"object_id": args.object_id}
@@ -317,6 +397,7 @@ def build_parser() -> argparse.ArgumentParser:
     docs = groups.add_parser("docs", help="Inspect the offline endpoint catalog.")
     docs_actions = docs.add_subparsers(dest="docs_action", required=True)
     docs_actions.add_parser("list")
+    docs_actions.add_parser("operations")
     docs_show = docs_actions.add_parser("show")
     docs_show.add_argument("endpoint", choices=sorted(ENDPOINT_BY_KEY))
     docs.set_defaults(handler=handle_docs)
@@ -354,9 +435,9 @@ def build_parser() -> argparse.ArgumentParser:
         add_yes(item)
     fields.set_defaults(handler=handle_fields)
 
-    changes = groups.add_parser("changes", help="Commit or release eligible test-environment metadata versions.")
+    changes = groups.add_parser("changes", help="Commit or release metadata versions.")
     change_actions = changes.add_subparsers(dest="changes_action", required=True)
-    for action in ("commit", "release"):
+    for action in ("commit", "release", "direct-release"):
         item = change_actions.add_parser(action)
         item.add_argument("--message", required=True)
         add_yes(item)

{flowbase_cli-0.1.1 → flowbase_cli-0.1.2}/src/flowbase_cli.egg-info/PKG-INFO

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

{flowbase_cli-0.1.1 → flowbase_cli-0.1.2}/tests/test_cli.py

@@ -75,6 +75,15 @@ class FlowBaseCliTest(unittest.TestCase):
         self.assertTrue(any(item["key"] == "records.create" for item in payload))
         self.assertTrue(any(item["key"] == "changes.release" for item in payload))
 
+    def test_management_operation_catalog_identifies_pending_gaps(self):
+        stdout = io.StringIO()
+        with patch("sys.stdout", stdout):
+            code = main(["docs", "operations"])
+        self.assertEqual(code, 0)
+        payload = json.loads(stdout.getvalue())
+        self.assertTrue(any(item["key"] == "changes.direct-release" and item["status"] == "delivered" for item in payload))
+        self.assertTrue(any(item["key"] == "changes.clear-drafts" and item["status"] == "pending" for item in payload))
+
     def test_object_create_requires_business_description(self):
         stderr = io.StringIO()
         with patch("sys.stderr", stderr):
@@ -96,6 +105,52 @@ class FlowBaseCliTest(unittest.TestCase):
         self.assertEqual(code, 1)
         self.assertIn("without --yes", stderr.getvalue())
 
+    def test_direct_release_always_preflights_before_execution(self):
+        preflight = {
+            "confirmationToken": "fbc_secret",
+            "mainCommit": "abc1234",
+            "draftRevision": 4,
+            "semanticCount": 2,
+            "fileCount": 1,
+            "checks": [{"label": "Configuration valid", "ok": True}],
+            "risk": "Bypasses test environments.",
+        }
+        stdout = io.StringIO()
+        stderr = io.StringIO()
+        with (
+            patch(
+                "flowbase_cli.main.OpenApiClient.request",
+                side_effect=[
+                    json.dumps(preflight).encode(),
+                    b'{"mainCommit":"def5678"}',
+                ],
+            ) as request,
+            patch("sys.stdout", stdout),
+            patch("sys.stderr", stderr),
+        ):
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "changes",
+                "direct-release",
+                "--message",
+                "Production fix",
+                "--yes",
+            ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_count, 2)
+        self.assertEqual(
+            request.call_args_list[0].args[0],
+            "changes.direct-release-preflight",
+        )
+        self.assertEqual(
+            request.call_args_list[1].kwargs["body"]["confirmationToken"],
+            "fbc_secret",
+        )
+        self.assertNotIn("fbc_secret", stdout.getvalue())
+        self.assertNotIn("fbc_secret", stderr.getvalue())
+        self.assertIn("Bypasses test environments", stderr.getvalue())
+
 
 if __name__ == "__main__":
     unittest.main()