flowbase-cli 0.1.8__tar.gz → 0.1.9__tar.gz

{flowbase_cli-0.1.8 → flowbase_cli-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowbase-cli
-Version: 0.1.8
+Version: 0.1.9
 Summary: Command line client for the FlowBase OpenAPI
 Author: DeepFlowAI
 License: Apache-2.0
@@ -9,7 +9,7 @@ Description-Content-Type: text/markdown
 
 # FlowBase CLI
 
-`flowbase` is the official command line client for the FlowBase OpenAPI. It manages apps, objects, fields, views, custom pages, workflows, dashboards, business records, roles, and configuration versions across the three FlowBase environments.
+`flowbase` is the official command line client for the FlowBase OpenAPI. It manages apps, objects, fields, views, custom pages, workflows, approval flows, dashboards, business records, roles, and configuration versions across the three FlowBase environments.
 
 ## 1. Install and connect
 
@@ -47,7 +47,7 @@ Most commands run on every Host; `roles` is production-only and `changes commit/
 
 ### 3.1 Metadata vs records
 
-- **Metadata** (`metadata` scope): apps, objects, fields, views, pages, workflows, dashboards, roles, versions.
+- **Metadata** (`metadata` scope): apps, objects, fields, views, pages, workflows, approvals, dashboards, roles, versions.
 - **Business records** (`records` scope): rows inside an object.
 
 Metadata changes are **drafts** against the current environment's configuration repository. They do not affect the running front-end until they are committed and released.
@@ -77,9 +77,11 @@ flowbase
 │                   add-dashboards | remove-dashboard | set-dashboard-group | reorder-members
 ├── groups          create | reorder | update | delete    App groups (under an app)
 ├── objects         list | get | create | update | delete | restore
+│                   cli-edit-policy get | update
 ├── fields          create | update | delete | restore    Fields under an object
 ├── views           list | create | update | reorder | set-enabled | delete
 ├── workflows       list | get | create | update | reorder | set-enabled | delete | executions
+├── approvals       list | get | create | update | reorder | set-enabled | delete
 ├── pages           list | options | get | create | update | set-default | delete | restore
 ├── dashboards      list | get | create | update | copy | delete
 ├── changes         commit | release | direct-release
@@ -114,7 +116,7 @@ flowbase docs catalogs field-types        # field type names + allowed constrain
 flowbase docs catalogs workflow-nodes     # node types with in/out edge rules
 flowbase docs catalogs permissions        # function permission points + data scopes
 flowbase docs catalogs dashboard-filters  # filter types + date-range presets
-flowbase docs catalogs page-components    # page region component kinds (field / relatedList)
+flowbase docs catalogs page-components    # page region component kinds (field / relatedList / approval)
 flowbase docs catalogs id-prefixes        # resource ID prefix meanings
 flowbase docs catalogs icons              # icon guidance + examples
 ```
@@ -139,6 +141,8 @@ Do not compose update bodies from scratch when an existing resource exists — `
 flowbase objects create --label Customer --key customer --description "Customer records"
 flowbase fields create obj_xxx --json '{"label":"Name","key":"name","description":"Customer name","type":"text.singleLine","permission":"required"}'
 flowbase records create obj_xxx --json '{"values":{"name":"Acme Corp"}}'
+flowbase objects cli-edit-policy get obj_xxx
+flowbase objects cli-edit-policy update obj_xxx --json '{"baseRevision":4,"policies":{"fld_xxx":"user_approval"}}' --yes
 ```
 
 Record `values` keys are **field keys** (`name`), not internal IDs (`fld_...`). IDs are `obj_`/`fld_`/`dsh_`/`wfl_`/`pag_`/`reg_`/`cmp_`-prefixed; see `docs catalogs id-prefixes`.
@@ -168,22 +172,29 @@ flowbase changes direct-release --message "Fix customer field" --yes
 
 `direct-release` always runs a server-side preflight, prints the current version, diff summary, checks and risk, and binds a one-time confirmation token. `--yes` accepts that reviewed result; it never skips validation.
 
-### 6.4 Workflows and pages
+### 6.4 Workflows, approvals, and pages
 
 A workflow graph must satisfy structural rules: exactly one `trigger` node, at least one `end` node, a DAG, and valid per-type edges. See `docs catalogs workflow-nodes` before composing `nodes`/`edges`.
 
+Approval flow graphs are separate metadata: exactly one `trigger`, at least one `approval` node, both `approvedEnd` and `rejectedEnd`, and dual outcome edges from each approval node. Employee task decisions are not available via API key / CLI. See `docs catalogs approval-nodes`.
+
 ```bash
 flowbase docs catalogs workflow-nodes
 flowbase workflows create obj_xxx --json '{"label":"Set owner","enabled":true,"trigger":{"event":"create","match":"all","conditions":[]},"nodes":[],"edges":[]}'
 flowbase workflows update obj_xxx wfl_xxx --json-file workflow.json
 flowbase workflows executions obj_xxx wfl_xxx --result failure
 
-flowbase docs catalogs page-components                  # field + relatedList keys
+flowbase docs catalogs approval-nodes
+flowbase docs example approvals.create --output approval.json
+flowbase approvals create obj_xxx --json-file approval.json
+flowbase approvals set-enabled obj_xxx apr_xxx --base-revision 4 --enabled --yes
+
+flowbase docs catalogs page-components                  # field + relatedList + approval keys
 flowbase docs example pages.create --output page.json   # create-page layout template
 flowbase pages create --json-file page.json
 flowbase pages set-default pag_xxx --base-revision 4 --yes
 
-# Detail pages may embed relatedList components (reverse lookup lists).
+# Detail pages may embed relatedList and at most one approval component.
 flowbase pages get pag_xxx > page.json                  # prefer get → edit → update
 # or: flowbase docs example pages.update --output page.json
 flowbase pages update pag_xxx --json-file page.json

{flowbase_cli-0.1.8 → flowbase_cli-0.1.9}/README.md

@@ -1,6 +1,6 @@
 # FlowBase CLI
 
-`flowbase` is the official command line client for the FlowBase OpenAPI. It manages apps, objects, fields, views, custom pages, workflows, dashboards, business records, roles, and configuration versions across the three FlowBase environments.
+`flowbase` is the official command line client for the FlowBase OpenAPI. It manages apps, objects, fields, views, custom pages, workflows, approval flows, dashboards, business records, roles, and configuration versions across the three FlowBase environments.
 
 ## 1. Install and connect
 
@@ -38,7 +38,7 @@ Most commands run on every Host; `roles` is production-only and `changes commit/
 
 ### 3.1 Metadata vs records
 
-- **Metadata** (`metadata` scope): apps, objects, fields, views, pages, workflows, dashboards, roles, versions.
+- **Metadata** (`metadata` scope): apps, objects, fields, views, pages, workflows, approvals, dashboards, roles, versions.
 - **Business records** (`records` scope): rows inside an object.
 
 Metadata changes are **drafts** against the current environment's configuration repository. They do not affect the running front-end until they are committed and released.
@@ -68,9 +68,11 @@ flowbase
 │                   add-dashboards | remove-dashboard | set-dashboard-group | reorder-members
 ├── groups          create | reorder | update | delete    App groups (under an app)
 ├── objects         list | get | create | update | delete | restore
+│                   cli-edit-policy get | update
 ├── fields          create | update | delete | restore    Fields under an object
 ├── views           list | create | update | reorder | set-enabled | delete
 ├── workflows       list | get | create | update | reorder | set-enabled | delete | executions
+├── approvals       list | get | create | update | reorder | set-enabled | delete
 ├── pages           list | options | get | create | update | set-default | delete | restore
 ├── dashboards      list | get | create | update | copy | delete
 ├── changes         commit | release | direct-release
@@ -105,7 +107,7 @@ flowbase docs catalogs field-types        # field type names + allowed constrain
 flowbase docs catalogs workflow-nodes     # node types with in/out edge rules
 flowbase docs catalogs permissions        # function permission points + data scopes
 flowbase docs catalogs dashboard-filters  # filter types + date-range presets
-flowbase docs catalogs page-components    # page region component kinds (field / relatedList)
+flowbase docs catalogs page-components    # page region component kinds (field / relatedList / approval)
 flowbase docs catalogs id-prefixes        # resource ID prefix meanings
 flowbase docs catalogs icons              # icon guidance + examples
 ```
@@ -130,6 +132,8 @@ Do not compose update bodies from scratch when an existing resource exists — `
 flowbase objects create --label Customer --key customer --description "Customer records"
 flowbase fields create obj_xxx --json '{"label":"Name","key":"name","description":"Customer name","type":"text.singleLine","permission":"required"}'
 flowbase records create obj_xxx --json '{"values":{"name":"Acme Corp"}}'
+flowbase objects cli-edit-policy get obj_xxx
+flowbase objects cli-edit-policy update obj_xxx --json '{"baseRevision":4,"policies":{"fld_xxx":"user_approval"}}' --yes
 ```
 
 Record `values` keys are **field keys** (`name`), not internal IDs (`fld_...`). IDs are `obj_`/`fld_`/`dsh_`/`wfl_`/`pag_`/`reg_`/`cmp_`-prefixed; see `docs catalogs id-prefixes`.
@@ -159,22 +163,29 @@ flowbase changes direct-release --message "Fix customer field" --yes
 
 `direct-release` always runs a server-side preflight, prints the current version, diff summary, checks and risk, and binds a one-time confirmation token. `--yes` accepts that reviewed result; it never skips validation.
 
-### 6.4 Workflows and pages
+### 6.4 Workflows, approvals, and pages
 
 A workflow graph must satisfy structural rules: exactly one `trigger` node, at least one `end` node, a DAG, and valid per-type edges. See `docs catalogs workflow-nodes` before composing `nodes`/`edges`.
 
+Approval flow graphs are separate metadata: exactly one `trigger`, at least one `approval` node, both `approvedEnd` and `rejectedEnd`, and dual outcome edges from each approval node. Employee task decisions are not available via API key / CLI. See `docs catalogs approval-nodes`.
+
 ```bash
 flowbase docs catalogs workflow-nodes
 flowbase workflows create obj_xxx --json '{"label":"Set owner","enabled":true,"trigger":{"event":"create","match":"all","conditions":[]},"nodes":[],"edges":[]}'
 flowbase workflows update obj_xxx wfl_xxx --json-file workflow.json
 flowbase workflows executions obj_xxx wfl_xxx --result failure
 
-flowbase docs catalogs page-components                  # field + relatedList keys
+flowbase docs catalogs approval-nodes
+flowbase docs example approvals.create --output approval.json
+flowbase approvals create obj_xxx --json-file approval.json
+flowbase approvals set-enabled obj_xxx apr_xxx --base-revision 4 --enabled --yes
+
+flowbase docs catalogs page-components                  # field + relatedList + approval keys
 flowbase docs example pages.create --output page.json   # create-page layout template
 flowbase pages create --json-file page.json
 flowbase pages set-default pag_xxx --base-revision 4 --yes
 
-# Detail pages may embed relatedList components (reverse lookup lists).
+# Detail pages may embed relatedList and at most one approval component.
 flowbase pages get pag_xxx > page.json                  # prefer get → edit → update
 # or: flowbase docs example pages.update --output page.json
 flowbase pages update pag_xxx --json-file page.json

{flowbase_cli-0.1.8 → flowbase_cli-0.1.9}/pyproject.toml

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

{flowbase_cli-0.1.8 → flowbase_cli-0.1.9}/src/flowbase_cli/__init__.py

@@ -1,3 +1,3 @@
 """FlowBase OpenAPI CLI."""
 
-__version__ = "0.1.8"
+__version__ = "0.1.9"

{flowbase_cli-0.1.8 → flowbase_cli-0.1.9}/src/flowbase_cli/endpoints.py

@@ -173,6 +173,29 @@ ENDPOINTS = (
              request_body='{"label":"Customer","description":"Customer records","icon":"IconDatabase"}'),
     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(
+        "objects.cli-edit-policy.get",
+        "flowbase_objects_cli_edit_policy_get",
+        "GET",
+        "/objects/{object_id}/cli-edit-policy",
+        "metadata:read",
+        "Get object CLI field edit policies.",
+        "flowbase objects cli-edit-policy get obj_xxx",
+    ),
+    Endpoint(
+        "objects.cli-edit-policy.update",
+        "flowbase_objects_cli_edit_policy_update",
+        "PUT",
+        "/objects/{object_id}/cli-edit-policy",
+        "metadata:write",
+        "Update object CLI field edit policies as a complete draft snapshot.",
+        "flowbase objects cli-edit-policy update obj_xxx --json-file cli-policy.json --yes",
+        requires_confirmation=True,
+        request_body=(
+            '{"baseRevision":4,"policies":{'
+            '"fld_confirm":"user_approval","fld_direct":"direct"}}'
+        ),
+    ),
     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",
              request_body=(
                  '{"label":"Stage","key":"stage","description":"Pipeline stage","type":"select.single","typeVersion":"v1",'
@@ -222,6 +245,48 @@ ENDPOINTS = (
     Endpoint("workflows.delete", "flowbase_workflows_delete", "POST", "/objects/{object_id}/workflows/{workflow_id}/delete", "metadata:write", "Logically delete a workflow.", "flowbase workflows delete obj_xxx wfl_xxx --base-revision 4 --yes", True,
              request_body='{"baseRevision":4}'),
     Endpoint("workflows.executions", "flowbase_workflows_executions", "GET", "/objects/{object_id}/workflows/{workflow_id}/executions", "metadata:read", "List workflow execution records.", "flowbase workflows executions obj_xxx wfl_xxx --result failure"),
+    Endpoint("approvals.list", "flowbase_approvals_list", "GET", "/objects/{object_id}/approvals", "metadata:read", "List object approval flows.", "flowbase approvals list obj_xxx"),
+    Endpoint("approvals.get", "flowbase_approvals_get", "GET", "/objects/{object_id}/approvals/{approval_id}", "metadata:read", "Get an approval flow graph.", "flowbase approvals get obj_xxx apr_xxx"),
+    Endpoint("approvals.create", "flowbase_approvals_create", "POST", "/objects/{object_id}/approvals", "metadata:write", "Create an approval flow draft.", "flowbase approvals create obj_xxx --json-file approval.json",
+             request_body=(
+                 '{"baseRevision":3,"label":"Contract approval","enabled":true,'
+                 '"trigger":{"manual":true,"create":false,"update":false,"match":"all","conditions":[]},'
+                 '"displayFieldIds":["fld_xxx"],"lockRecord":true,"allowWithdraw":true,'
+                 '"nodes":['
+                 '{"id":"apn_trigger","type":"trigger"},'
+                 '{"id":"apn_review","type":"approval","label":"Manager review",'
+                 '"approverRules":[{"type":"employees","employeeIds":["emp_xxx"]}],'
+                 '"mode":"all","selfPolicy":"skip","unavailablePolicy":"autoReject"},'
+                 '{"id":"apn_approved","type":"approvedEnd"},'
+                 '{"id":"apn_rejected","type":"rejectedEnd"}],'
+                 '"edges":['
+                 '{"id":"ape_1","source":"apn_trigger","target":"apn_review"},'
+                 '{"id":"ape_2","source":"apn_review","target":"apn_approved","outcome":"approved"},'
+                 '{"id":"ape_3","source":"apn_review","target":"apn_rejected","outcome":"rejected"}]}'
+             )),
+    Endpoint("approvals.update", "flowbase_approvals_update", "PUT", "/objects/{object_id}/approvals/{approval_id}", "metadata:write", "Update an approval flow graph.", "flowbase approvals update obj_xxx apr_xxx --json-file approval.json",
+             request_body=(
+                 '{"baseRevision":4,"label":"Contract approval","enabled":true,'
+                 '"trigger":{"manual":true,"create":false,"update":false,"match":"all","conditions":[]},'
+                 '"displayFieldIds":["fld_xxx"],"lockRecord":true,"allowWithdraw":true,'
+                 '"nodes":['
+                 '{"id":"apn_trigger","type":"trigger"},'
+                 '{"id":"apn_review","type":"approval","label":"Manager review",'
+                 '"approverRules":[{"type":"employees","employeeIds":["emp_xxx"]}],'
+                 '"mode":"all","selfPolicy":"skip","unavailablePolicy":"autoReject"},'
+                 '{"id":"apn_approved","type":"approvedEnd"},'
+                 '{"id":"apn_rejected","type":"rejectedEnd"}],'
+                 '"edges":['
+                 '{"id":"ape_1","source":"apn_trigger","target":"apn_review"},'
+                 '{"id":"ape_2","source":"apn_review","target":"apn_approved","outcome":"approved"},'
+                 '{"id":"ape_3","source":"apn_review","target":"apn_rejected","outcome":"rejected"}]}'
+             )),
+    Endpoint("approvals.reorder", "flowbase_approvals_reorder", "PUT", "/objects/{object_id}/approvals/order", "metadata:write", "Reorder object approval flows.", "flowbase approvals reorder obj_xxx --json '{\"baseRevision\":4,\"approvalIds\":[\"apr_a\",\"apr_b\"]}'",
+             request_body='{"baseRevision":4,"approvalIds":["apr_a","apr_b"]}'),
+    Endpoint("approvals.set-enabled", "flowbase_approvals_set_enabled", "POST", "/objects/{object_id}/approvals/{approval_id}/enabled", "metadata:write", "Enable or disable an approval flow.", "flowbase approvals set-enabled obj_xxx apr_xxx --base-revision 4 --enabled --yes", True,
+             request_body='{"baseRevision":4,"enabled":true}'),
+    Endpoint("approvals.delete", "flowbase_approvals_delete", "POST", "/objects/{object_id}/approvals/{approval_id}/delete", "metadata:write", "Logically delete an approval flow.", "flowbase approvals delete obj_xxx apr_xxx --base-revision 4 --yes", True,
+             request_body='{"baseRevision":4}'),
     Endpoint("pages.list", "flowbase_pages_list", "GET", "/pages", "metadata:read", "List custom Page metadata.", "flowbase pages list --object-id obj_xxx"),
     Endpoint("pages.options", "flowbase_pages_options", "GET", "/pages/options", "metadata:read", "Get custom Page design options.", "flowbase pages options"),
     Endpoint("pages.get", "flowbase_pages_get", "GET", "/pages/{page_id}", "metadata:read", "Get a custom Page.", "flowbase pages get pag_xxx"),
@@ -242,7 +307,8 @@ ENDPOINTS = (
                  '"columnFieldIds":["fld_title","fld_status","fld_created_at"],'
                  '"sort":{"fieldId":"fld_created_at","direction":"desc"},"limit":5,"showViewAll":true,'
                  '"createAction":{"enabled":true,"label":"New ticket"},'
-                 '"carryIns":[{"fieldId":"fld_customer","source":"currentRecord"}]}]]}],"rules":[]}}'
+                 '"carryIns":[{"fieldId":"fld_customer","source":"currentRecord"}]},'
+                 '{"kind":"approval","label":"Approval","hideLabel":false}]]}],"rules":[]}}'
              )),
     Endpoint("pages.set-default", "flowbase_pages_set_default", "POST", "/pages/{page_id}/set-default", "metadata:write", "Set a default custom Page.", "flowbase pages set-default pag_xxx --base-revision 4 --yes", True,
              request_body='{"baseRevision":4}'),
@@ -391,7 +457,7 @@ ENDPOINTS = (
 ENDPOINT_BY_KEY = {endpoint.key: endpoint for endpoint in ENDPOINTS}
 
 # Closed-domain catalogs for offline authoring of complex request bodies.
-# Keep in sync with server registries (field types, workflow node kinds,
+# Keep in sync with server registries (field types, workflow/approval node kinds,
 # permission points, dashboard filter presets, page component kinds).
 # Icons intentionally reference the server file because the full Tabler set is large.
 FIELD_TYPES = (
@@ -413,6 +479,13 @@ FIELD_TYPES = (
     {"type": "url", "constraints": ["maxLength", "placeholder"], "writable": True},
     {"type": "attachment", "constraints": ["maxFileCount", "maxFileSize", "maxTotalSize", "allowedExtensions"], "writable": True},
     {"type": "text.rich", "constraints": ["maxLength", "placeholder"], "writable": True},
+    {"type": "autonumber", "constraints": ["prefix", "start", "minDigits"], "writable": False},
+    {"type": "number.currency", "constraints": ["currency", "minimum", "maximum", "scale", "currencyDisplay", "useThousands"], "writable": True},
+    {"type": "number.percent", "constraints": ["minimum", "maximum", "scale"], "writable": True},
+    {"type": "duration", "constraints": ["precision", "minimum", "maximum", "displayFormat"], "writable": True},
+    {"type": "rating", "constraints": ["maxRating", "color"], "writable": True},
+    {"type": "lookup.record.multiple", "constraints": ["targetObjectId", "displayFieldId", "maxSelections"], "writable": True},
+    {"type": "lookup.department", "constraints": [], "writable": True},
 )
 
 WORKFLOW_NODE_TYPES = (
@@ -426,6 +499,22 @@ WORKFLOW_NODE_TYPES = (
      "note": "terminal node"},
 )
 
+APPROVAL_NODE_TYPES = (
+    {"type": "trigger", "cardinality": "exactly 1", "in": 0, "out": 1,
+     "note": "entry node; initiation modes live on the flow trigger, not the node"},
+    {"type": "approval", "cardinality": ">= 1", "in": 1, "out": 2,
+     "note": "requires approved + rejected outcome edges; approverRules / mode / "
+             "selfPolicy / unavailablePolicy"},
+    {"type": "branch", "cardinality": ">= 0", "in": 1, "out": "1 per branch (+ defaultBranchId)",
+     "note": "same condition protocol as workflows; each branchId needs an edge"},
+    {"type": "updateRecord", "cardinality": ">= 0", "in": 1, "out": 1,
+     "note": "assignments update the locked record as system actor"},
+    {"type": "approvedEnd", "cardinality": ">= 1", "in": "any", "out": 0,
+     "note": "terminal approved outcome"},
+    {"type": "rejectedEnd", "cardinality": ">= 1", "in": "any", "out": 0,
+     "note": "terminal rejected outcome"},
+)
+
 FUNCTION_PERMISSIONS = (
     "workspace.access", "app.manage", "object.manage", "dashboard.manage",
     "version.manage", "org.manage", "system.manage",
@@ -439,13 +528,14 @@ DASHBOARD_DATE_RANGE_PRESETS = (
     "this_week", "this_month", "this_quarter", "this_year",
 )
 
-# Page region column components (1.8 relatedList + field components).
-# Field components omit `kind` (legacy snapshot shape); related lists set kind.
+# Page region column components (field + relatedList + approval).
+# Field components omit `kind` (legacy snapshot shape); relatedList/approval set kind.
 PAGE_COMPONENTS = {
     "note": (
-        "Region columns hold field components and/or relatedList components. "
-        "relatedList is allowed only on detail pages. Prefer pages.get → edit → "
-        "pages.update; use pages.options to resolve candidate objects/fields."
+        "Region columns hold field, relatedList, and/or approval components. "
+        "relatedList and approval are allowed only on detail pages; each detail "
+        "page may include at most one approval component. Prefer pages.get → "
+        "edit → pages.update; use pages.options to resolve candidate objects/fields."
     ),
     "kinds": (
         {
@@ -489,12 +579,24 @@ PAGE_COMPONENTS = {
                         "implicit relationFieldId eq currentRecord condition.",
             },
         },
+        {
+            "kind": "approval",
+            "name": "record approval",
+            "pageTypes": ("detail",),
+            "maxPerPage": 1,
+            "requiredKeys": ("kind", "label", "hideLabel"),
+            "optionalKeys": ("id",),
+            "note": (
+                "Reference-free presentation slot for submit / status / history. "
+                "Runtime data comes from employee APIs, not OpenAPI/CLI."
+            ),
+        },
     ),
 }
 
 RESOURCE_ID_PREFIXES = {
     "app_": "app", "grp_": "app group", "obj_": "object", "fld_": "field",
-    "viw_": "view", "wfl_": "workflow", "pag_": "custom page",
+    "viw_": "view", "wfl_": "workflow", "apr_": "approval flow", "pag_": "custom page",
     "reg_": "page region", "cmp_": "page component",
     "dsh_": "dashboard", "dcm_": "dashboard component", "rol_": "role",
     "rec_": "record", "att_": "attachment", "emp_": "employee", "dep_": "department",
@@ -503,6 +605,7 @@ RESOURCE_ID_PREFIXES = {
 CATALOGS = {
     "field-types": FIELD_TYPES,
     "workflow-nodes": WORKFLOW_NODE_TYPES,
+    "approval-nodes": APPROVAL_NODE_TYPES,
     "permissions": {"function": FUNCTION_PERMISSIONS, "dataScopes": DATA_SCOPES},
     "dashboard-filters": {
         "types": DASHBOARD_FILTER_TYPES,

{flowbase_cli-0.1.8 → flowbase_cli-0.1.9}/src/flowbase_cli/main.py

@@ -523,6 +523,22 @@ def handle_objects(args: argparse.Namespace) -> int:
         return run_request(args, "objects.list", query={"status": args.status})
     if action == "get":
         return run_request(args, "objects.get", path_params={"object_id": args.object_id}, query={"status": args.status})
+    if action == "cli-edit-policy":
+        path = {"object_id": args.object_id}
+        if args.objects_cli_edit_policy_action == "get":
+            return run_request(
+                args, "objects.cli-edit-policy.get", path_params=path
+            )
+        body = load_json_payload(args.json, args.json_file)
+        require_fields(body, "baseRevision", "policies")
+        if not isinstance(body["policies"], dict):
+            raise CliError("Request field 'policies' must be an object.")
+        return run_request(
+            args,
+            "objects.cli-edit-policy.update",
+            path_params=path,
+            body=body,
+        )
     if action == "create":
         body = _payload_from_args(
             args,
@@ -638,6 +654,34 @@ def handle_workflows(args: argparse.Namespace) -> int:
     )
 
 
+def handle_approvals(args: argparse.Namespace) -> int:
+    action = args.approvals_action
+    path = {"object_id": args.object_id}
+    if hasattr(args, "approval_id"):
+        path["approval_id"] = args.approval_id
+    if action in ("list", "get"):
+        return run_request(args, f"approvals.{action}", path_params=path)
+    if action in ("create", "update"):
+        body = load_json_payload(args.json, args.json_file)
+        require_fields(body, "label", "trigger", "displayFieldIds", "nodes", "edges")
+        return run_request(args, f"approvals.{action}", path_params=path, body=body)
+    if action == "reorder":
+        body = load_json_payload(args.json, args.json_file)
+        require_fields(body, "baseRevision", "approvalIds")
+        if not isinstance(body["approvalIds"], list):
+            raise CliError("Request field 'approvalIds' must be an array.")
+        return run_request(args, "approvals.reorder", path_params=path, body=body)
+    if action == "set-enabled":
+        return run_request(
+            args, "approvals.set-enabled", path_params=path,
+            body={"baseRevision": args.base_revision, "enabled": args.enabled},
+        )
+    return run_request(
+        args, "approvals.delete", path_params=path,
+        body={"baseRevision": args.base_revision},
+    )
+
+
 def handle_pages(args: argparse.Namespace) -> int:
     action = args.pages_action
     if action == "list":
@@ -906,7 +950,7 @@ def build_parser() -> argparse.ArgumentParser:
     docs_actions.add_parser("operations")
     docs_catalogs = docs_actions.add_parser(
         "catalogs",
-        help="List closed-domain catalogs, or dump one (field-types, workflow-nodes, permissions, dashboard-filters, page-components, id-prefixes, icons).",
+        help="List closed-domain catalogs, or dump one (field-types, workflow-nodes, approval-nodes, permissions, dashboard-filters, page-components, id-prefixes, icons).",
     )
     docs_catalogs.add_argument("name", nargs="?", default=None)
     docs_show = docs_actions.add_parser("show")
@@ -1054,6 +1098,21 @@ def build_parser() -> argparse.ArgumentParser:
         item = object_actions.add_parser(action)
         item.add_argument("object_id")
         add_yes(item)
+    object_cli_policy = object_actions.add_parser(
+        "cli-edit-policy", help="Read or update user CLI field edit policies."
+    )
+    object_cli_policy_actions = object_cli_policy.add_subparsers(
+        dest="objects_cli_edit_policy_action", required=True
+    )
+    object_cli_policy_get = object_cli_policy_actions.add_parser("get")
+    object_cli_policy_get.add_argument("object_id")
+    object_cli_policy_update = object_cli_policy_actions.add_parser("update")
+    object_cli_policy_update.add_argument("object_id")
+    add_json_args(
+        object_cli_policy_update,
+        endpoint_key="objects.cli-edit-policy.update",
+    )
+    add_yes(object_cli_policy_update)
     objects.set_defaults(handler=handle_objects)
 
     fields = groups.add_parser("fields", help="Manage field metadata.")
@@ -1137,6 +1196,36 @@ def build_parser() -> argparse.ArgumentParser:
     workflow_executions.add_argument("--result", choices=("success", "failure"))
     workflows.set_defaults(handler=handle_workflows)
 
+    approvals = groups.add_parser("approvals", help="Manage object approval flow metadata.")
+    approval_actions = approvals.add_subparsers(dest="approvals_action", required=True)
+    approval_list = approval_actions.add_parser("list")
+    approval_list.add_argument("object_id")
+    approval_get = approval_actions.add_parser("get")
+    approval_get.add_argument("object_id")
+    approval_get.add_argument("approval_id")
+    for action in ("create", "reorder"):
+        item = approval_actions.add_parser(action)
+        item.add_argument("object_id")
+        add_json_args(item, endpoint_key=f"approvals.{action}")
+    approval_update = approval_actions.add_parser("update")
+    approval_update.add_argument("object_id")
+    approval_update.add_argument("approval_id")
+    add_json_args(approval_update, endpoint_key="approvals.update")
+    approval_enabled = approval_actions.add_parser("set-enabled")
+    approval_enabled.add_argument("object_id")
+    approval_enabled.add_argument("approval_id")
+    approval_enabled.add_argument("--base-revision", required=True, type=int)
+    approval_enabled.add_argument(
+        "--enabled", action=argparse.BooleanOptionalAction, required=True,
+    )
+    add_yes(approval_enabled)
+    approval_delete = approval_actions.add_parser("delete")
+    approval_delete.add_argument("object_id")
+    approval_delete.add_argument("approval_id")
+    approval_delete.add_argument("--base-revision", required=True, type=int)
+    add_yes(approval_delete)
+    approvals.set_defaults(handler=handle_approvals)
+
     pages = groups.add_parser("pages", help="Manage custom Page metadata.")
     page_actions = pages.add_subparsers(dest="pages_action", required=True)
     page_list = page_actions.add_parser("list")

{flowbase_cli-0.1.8 → flowbase_cli-0.1.9}/src/flowbase_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowbase-cli
-Version: 0.1.8
+Version: 0.1.9
 Summary: Command line client for the FlowBase OpenAPI
 Author: DeepFlowAI
 License: Apache-2.0
@@ -9,7 +9,7 @@ Description-Content-Type: text/markdown
 
 # FlowBase CLI
 
-`flowbase` is the official command line client for the FlowBase OpenAPI. It manages apps, objects, fields, views, custom pages, workflows, dashboards, business records, roles, and configuration versions across the three FlowBase environments.
+`flowbase` is the official command line client for the FlowBase OpenAPI. It manages apps, objects, fields, views, custom pages, workflows, approval flows, dashboards, business records, roles, and configuration versions across the three FlowBase environments.
 
 ## 1. Install and connect
 
@@ -47,7 +47,7 @@ Most commands run on every Host; `roles` is production-only and `changes commit/
 
 ### 3.1 Metadata vs records
 
-- **Metadata** (`metadata` scope): apps, objects, fields, views, pages, workflows, dashboards, roles, versions.
+- **Metadata** (`metadata` scope): apps, objects, fields, views, pages, workflows, approvals, dashboards, roles, versions.
 - **Business records** (`records` scope): rows inside an object.
 
 Metadata changes are **drafts** against the current environment's configuration repository. They do not affect the running front-end until they are committed and released.
@@ -77,9 +77,11 @@ flowbase
 │                   add-dashboards | remove-dashboard | set-dashboard-group | reorder-members
 ├── groups          create | reorder | update | delete    App groups (under an app)
 ├── objects         list | get | create | update | delete | restore
+│                   cli-edit-policy get | update
 ├── fields          create | update | delete | restore    Fields under an object
 ├── views           list | create | update | reorder | set-enabled | delete
 ├── workflows       list | get | create | update | reorder | set-enabled | delete | executions
+├── approvals       list | get | create | update | reorder | set-enabled | delete
 ├── pages           list | options | get | create | update | set-default | delete | restore
 ├── dashboards      list | get | create | update | copy | delete
 ├── changes         commit | release | direct-release
@@ -114,7 +116,7 @@ flowbase docs catalogs field-types        # field type names + allowed constrain
 flowbase docs catalogs workflow-nodes     # node types with in/out edge rules
 flowbase docs catalogs permissions        # function permission points + data scopes
 flowbase docs catalogs dashboard-filters  # filter types + date-range presets
-flowbase docs catalogs page-components    # page region component kinds (field / relatedList)
+flowbase docs catalogs page-components    # page region component kinds (field / relatedList / approval)
 flowbase docs catalogs id-prefixes        # resource ID prefix meanings
 flowbase docs catalogs icons              # icon guidance + examples
 ```
@@ -139,6 +141,8 @@ Do not compose update bodies from scratch when an existing resource exists — `
 flowbase objects create --label Customer --key customer --description "Customer records"
 flowbase fields create obj_xxx --json '{"label":"Name","key":"name","description":"Customer name","type":"text.singleLine","permission":"required"}'
 flowbase records create obj_xxx --json '{"values":{"name":"Acme Corp"}}'
+flowbase objects cli-edit-policy get obj_xxx
+flowbase objects cli-edit-policy update obj_xxx --json '{"baseRevision":4,"policies":{"fld_xxx":"user_approval"}}' --yes
 ```
 
 Record `values` keys are **field keys** (`name`), not internal IDs (`fld_...`). IDs are `obj_`/`fld_`/`dsh_`/`wfl_`/`pag_`/`reg_`/`cmp_`-prefixed; see `docs catalogs id-prefixes`.
@@ -168,22 +172,29 @@ flowbase changes direct-release --message "Fix customer field" --yes
 
 `direct-release` always runs a server-side preflight, prints the current version, diff summary, checks and risk, and binds a one-time confirmation token. `--yes` accepts that reviewed result; it never skips validation.
 
-### 6.4 Workflows and pages
+### 6.4 Workflows, approvals, and pages
 
 A workflow graph must satisfy structural rules: exactly one `trigger` node, at least one `end` node, a DAG, and valid per-type edges. See `docs catalogs workflow-nodes` before composing `nodes`/`edges`.
 
+Approval flow graphs are separate metadata: exactly one `trigger`, at least one `approval` node, both `approvedEnd` and `rejectedEnd`, and dual outcome edges from each approval node. Employee task decisions are not available via API key / CLI. See `docs catalogs approval-nodes`.
+
 ```bash
 flowbase docs catalogs workflow-nodes
 flowbase workflows create obj_xxx --json '{"label":"Set owner","enabled":true,"trigger":{"event":"create","match":"all","conditions":[]},"nodes":[],"edges":[]}'
 flowbase workflows update obj_xxx wfl_xxx --json-file workflow.json
 flowbase workflows executions obj_xxx wfl_xxx --result failure
 
-flowbase docs catalogs page-components                  # field + relatedList keys
+flowbase docs catalogs approval-nodes
+flowbase docs example approvals.create --output approval.json
+flowbase approvals create obj_xxx --json-file approval.json
+flowbase approvals set-enabled obj_xxx apr_xxx --base-revision 4 --enabled --yes
+
+flowbase docs catalogs page-components                  # field + relatedList + approval keys
 flowbase docs example pages.create --output page.json   # create-page layout template
 flowbase pages create --json-file page.json
 flowbase pages set-default pag_xxx --base-revision 4 --yes
 
-# Detail pages may embed relatedList components (reverse lookup lists).
+# Detail pages may embed relatedList and at most one approval component.
 flowbase pages get pag_xxx > page.json                  # prefer get → edit → update
 # or: flowbase docs example pages.update --output page.json
 flowbase pages update pag_xxx --json-file page.json

{flowbase_cli-0.1.8 → flowbase_cli-0.1.9}/tests/test_cli.py

@@ -90,6 +90,8 @@ class FlowBaseCliTest(unittest.TestCase):
         self.assertTrue(any(item["key"] == "pages.create" for item in payload))
         self.assertTrue(any(item["key"] == "views.create" for item in payload))
         self.assertTrue(any(item["key"] == "roles.create" for item in payload))
+        self.assertTrue(any(item["key"] == "objects.cli-edit-policy.get" for item in payload))
+        self.assertTrue(any(item["key"] == "objects.cli-edit-policy.update" for item in payload))
         role_create = next(item for item in payload if item["key"] == "roles.create")
         self.assertEqual(role_create["environments"], ["production"])
 
@@ -117,10 +119,14 @@ class FlowBaseCliTest(unittest.TestCase):
         payload = json.loads(stdout.getvalue())
         body = json.loads(payload["requestBody"])
         self.assertEqual(body["page"]["type"], "detail")
-        component = body["page"]["regions"][0]["columns"][0][0]
-        self.assertEqual(component["kind"], "relatedList")
-        self.assertIn("relationFieldId", component)
-        self.assertIn("carryIns", component)
+        components = body["page"]["regions"][0]["columns"][0]
+        self.assertEqual(components[0]["kind"], "relatedList")
+        self.assertIn("relationFieldId", components[0])
+        self.assertIn("carryIns", components[0])
+        self.assertEqual(
+            components[1],
+            {"kind": "approval", "label": "Approval", "hideLabel": False},
+        )
 
     def test_docs_catalogs_lists_and_dumps_domains(self):
         stdout = io.StringIO()
@@ -130,6 +136,7 @@ class FlowBaseCliTest(unittest.TestCase):
         names = json.loads(stdout.getvalue())
         self.assertIn("field-types", names)
         self.assertIn("workflow-nodes", names)
+        self.assertIn("approval-nodes", names)
         self.assertIn("permissions", names)
         self.assertIn("page-components", names)
 
@@ -139,8 +146,15 @@ class FlowBaseCliTest(unittest.TestCase):
         self.assertEqual(code, 0)
         field_types = json.loads(stdout.getvalue())
         type_names = {item["type"] for item in field_types}
+        self.assertEqual(len(field_types), 25)
         self.assertIn("select.single", type_names)
         self.assertIn("lookup.employee", type_names)
+        self.assertTrue({
+            "autonumber", "number.currency", "number.percent", "duration",
+            "rating", "lookup.record.multiple", "lookup.department",
+        }.issubset(type_names))
+        autonumber = next(item for item in field_types if item["type"] == "autonumber")
+        self.assertFalse(autonumber["writable"])
 
         stdout = io.StringIO()
         with patch("sys.stdout", stdout):
@@ -149,6 +163,17 @@ class FlowBaseCliTest(unittest.TestCase):
         nodes = json.loads(stdout.getvalue())
         self.assertIn("trigger", {item["type"] for item in nodes})
 
+        stdout = io.StringIO()
+        with patch("sys.stdout", stdout):
+            code = main(["docs", "catalogs", "approval-nodes"])
+        self.assertEqual(code, 0)
+        approval_nodes = json.loads(stdout.getvalue())
+        self.assertTrue(
+            {"trigger", "approval", "approvedEnd", "rejectedEnd"}.issubset(
+                {item["type"] for item in approval_nodes}
+            )
+        )
+
         stdout = io.StringIO()
         with patch("sys.stdout", stdout):
             code = main(["docs", "catalogs", "page-components"])
@@ -157,6 +182,12 @@ class FlowBaseCliTest(unittest.TestCase):
         kinds = {item.get("kind") for item in page_components["kinds"]}
         self.assertIn(None, kinds)
         self.assertIn("relatedList", kinds)
+        self.assertIn("approval", kinds)
+        approval = next(
+            item for item in page_components["kinds"] if item.get("kind") == "approval"
+        )
+        self.assertEqual(approval["maxPerPage"], 1)
+        self.assertEqual(set(approval["requiredKeys"]), {"kind", "label", "hideLabel"})
 
         stdout = io.StringIO()
         with patch("sys.stdout", stdout):
@@ -234,6 +265,92 @@ class FlowBaseCliTest(unittest.TestCase):
         )
         self.assertEqual(request.call_args.kwargs["body"], body)
 
+    def test_approval_create_sends_graph_snapshot(self):
+        body = {
+            "baseRevision": 3,
+            "label": "Contract approval",
+            "trigger": {
+                "manual": True,
+                "create": False,
+                "update": False,
+                "match": "all",
+                "conditions": [],
+            },
+            "displayFieldIds": ["fld_1"],
+            "lockRecord": True,
+            "allowWithdraw": True,
+            "nodes": [{"id": "apn_trigger", "type": "trigger"}],
+            "edges": [],
+        }
+        stdout = io.StringIO()
+        with (
+            patch(
+                "flowbase_cli.main.OpenApiClient.request",
+                return_value=b'{"approvalId":"apr_1","draftRevision":4}',
+            ) as request,
+            patch("sys.stdout", stdout),
+        ):
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "approvals",
+                "create",
+                "obj_1",
+                "--json",
+                json.dumps(body),
+            ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.args[0], "approvals.create")
+        self.assertEqual(
+            request.call_args.kwargs["path_params"],
+            {"object_id": "obj_1"},
+        )
+        self.assertEqual(request.call_args.kwargs["body"], body)
+
+    def test_approval_set_enabled_sends_revision_and_requires_yes(self):
+        stderr = io.StringIO()
+        with patch("sys.stderr", stderr), patch("sys.stdin.isatty", return_value=False):
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "approvals",
+                "set-enabled",
+                "obj_1",
+                "apr_1",
+                "--base-revision",
+                "4",
+                "--no-enabled",
+            ])
+        self.assertEqual(code, 1)
+        self.assertIn("without --yes", stderr.getvalue())
+
+        with patch(
+            "flowbase_cli.main.OpenApiClient.request",
+            return_value=b'{"ok":true,"draftRevision":5}',
+        ) as request:
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "approvals",
+                "set-enabled",
+                "obj_1",
+                "apr_1",
+                "--base-revision",
+                "4",
+                "--no-enabled",
+                "--yes",
+            ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.args[0], "approvals.set-enabled")
+        self.assertEqual(
+            request.call_args.kwargs["path_params"],
+            {"object_id": "obj_1", "approval_id": "apr_1"},
+        )
+        self.assertEqual(
+            request.call_args.kwargs["body"],
+            {"baseRevision": 4, "enabled": False},
+        )
+
     def test_view_set_enabled_sends_revision_and_requires_yes(self):
         stderr = io.StringIO()
         with patch("sys.stderr", stderr), patch("sys.stdin.isatty", return_value=False):
@@ -368,6 +485,83 @@ class FlowBaseCliTest(unittest.TestCase):
             },
         )
 
+    def test_object_cli_edit_policy_get_and_update(self):
+        with patch(
+            "flowbase_cli.main.OpenApiClient.request",
+            return_value=b'{"objectId":"obj_1","draftRevision":4,"policies":{}}',
+        ) as request:
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "objects",
+                "cli-edit-policy",
+                "get",
+                "obj_1",
+            ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.args[0], "objects.cli-edit-policy.get")
+        self.assertEqual(
+            request.call_args.kwargs["path_params"], {"object_id": "obj_1"}
+        )
+
+        body = {
+            "baseRevision": 4,
+            "policies": {"fld_1": "user_approval", "fld_2": "direct"},
+        }
+        with patch(
+            "flowbase_cli.main.OpenApiClient.request",
+            return_value=b'{"ok":true,"draftRevision":5}',
+        ) as request:
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "objects",
+                "cli-edit-policy",
+                "update",
+                "obj_1",
+                "--json",
+                json.dumps(body),
+                "--yes",
+            ])
+        self.assertEqual(code, 0)
+        self.assertEqual(request.call_args.args[0], "objects.cli-edit-policy.update")
+        self.assertEqual(request.call_args.kwargs["body"], body)
+
+    def test_object_cli_edit_policy_update_requires_complete_body_and_yes(self):
+        stderr = io.StringIO()
+        with patch("sys.stderr", stderr):
+            code = main([
+                "objects",
+                "cli-edit-policy",
+                "update",
+                "obj_1",
+                "--json",
+                '{"baseRevision":4}',
+                "--yes",
+            ])
+        self.assertEqual(code, 1)
+        self.assertIn("policies", stderr.getvalue())
+
+        stderr = io.StringIO()
+        with (
+            patch("sys.stderr", stderr),
+            patch("sys.stdin.isatty", return_value=False),
+            patch("flowbase_cli.main.OpenApiClient.request") as request,
+        ):
+            code = main([
+                "--api-key",
+                "fbk_test",
+                "objects",
+                "cli-edit-policy",
+                "update",
+                "obj_1",
+                "--json",
+                '{"baseRevision":4,"policies":{}}',
+            ])
+        self.assertEqual(code, 1)
+        self.assertIn("without --yes", stderr.getvalue())
+        request.assert_not_called()
+
     def test_group_create_and_app_set_group(self):
         with patch(
             "flowbase_cli.main.OpenApiClient.request",