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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowbase-cli
-Version: 0.1.7
+Version: 0.1.8
 Summary: Command line client for the FlowBase OpenAPI
 Author: DeepFlowAI
 License: Apache-2.0
@@ -114,6 +114,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 id-prefixes        # resource ID prefix meanings
 flowbase docs catalogs icons              # icon guidance + examples
 ```
@@ -140,7 +141,7 @@ flowbase fields create obj_xxx --json '{"label":"Name","key":"name","description
 flowbase records create obj_xxx --json '{"values":{"name":"Acme Corp"}}'
 ```
 
-Record `values` keys are **field keys** (`name`), not internal IDs (`fld_...`). IDs are `obj_`/`fld_`/`dsh_`/`wfl_`/`pag_`-prefixed; see `docs catalogs id-prefixes`.
+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`.
 
 ### 6.2 Edit and publish configuration on a test environment
 
@@ -177,9 +178,15 @@ flowbase workflows create obj_xxx --json '{"label":"Set owner","enabled":true,"t
 flowbase workflows update obj_xxx wfl_xxx --json-file workflow.json
 flowbase workflows executions obj_xxx wfl_xxx --result failure
 
-flowbase docs example pages.create --output page.json   # authoritative layout template
+flowbase docs catalogs page-components                  # field + relatedList 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).
+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
 ```
 
 ### 6.5 Records and attachments

flowbase_cli-0.1.7/PKG-INFO → flowbase_cli-0.1.8/README.md

@@ -1,12 +1,3 @@
-Metadata-Version: 2.4
-Name: flowbase-cli
-Version: 0.1.7
-Summary: Command line client for the FlowBase OpenAPI
-Author: DeepFlowAI
-License: Apache-2.0
-Requires-Python: >=3.11
-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.
@@ -114,6 +105,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 id-prefixes        # resource ID prefix meanings
 flowbase docs catalogs icons              # icon guidance + examples
 ```
@@ -140,7 +132,7 @@ flowbase fields create obj_xxx --json '{"label":"Name","key":"name","description
 flowbase records create obj_xxx --json '{"values":{"name":"Acme Corp"}}'
 ```
 
-Record `values` keys are **field keys** (`name`), not internal IDs (`fld_...`). IDs are `obj_`/`fld_`/`dsh_`/`wfl_`/`pag_`-prefixed; see `docs catalogs id-prefixes`.
+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`.
 
 ### 6.2 Edit and publish configuration on a test environment
 
@@ -177,9 +169,15 @@ flowbase workflows create obj_xxx --json '{"label":"Set owner","enabled":true,"t
 flowbase workflows update obj_xxx wfl_xxx --json-file workflow.json
 flowbase workflows executions obj_xxx wfl_xxx --result failure
 
-flowbase docs example pages.create --output page.json   # authoritative layout template
+flowbase docs catalogs page-components                  # field + relatedList 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).
+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
 ```
 
 ### 6.5 Records and attachments

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

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

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

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

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

@@ -233,9 +233,16 @@ ENDPOINTS = (
              )),
     Endpoint("pages.update", "flowbase_pages_update", "PUT", "/pages/{page_id}", "metadata:write", "Update a custom Page draft.", "flowbase pages update pag_xxx --json-file page.json",
              request_body=(
-                 '{"baseRevision":4,"page":{"id":"pag_xxx","key":"customer_create","label":"Create customer",'
-                 '"description":"","objectId":"obj_xxx","type":"create",'
-                 '"regions":[{"id":"reg_xxx","label":"Main","hideLabel":true,"columnRatios":[1],"columns":[[]]}],"rules":[]}}'
+                 '{"baseRevision":4,"page":{"id":"pag_xxx","key":"customer_detail","label":"Customer detail",'
+                 '"description":"","objectId":"obj_customer","type":"detail",'
+                 '"regions":[{"id":"reg_xxx","label":"Related","hideLabel":false,"columnRatios":[1],'
+                 '"columns":[[{"kind":"relatedList","label":"Tickets","hideLabel":false,'
+                 '"objectId":"obj_ticket","relationFieldId":"fld_customer",'
+                 '"filters":[{"fieldId":"fld_status","operator":"neq","value":"done"}],'
+                 '"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":[]}}'
              )),
     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}'),
@@ -385,8 +392,8 @@ 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,
-# permission points, dashboard filter presets). Icons intentionally reference
-# the server file because the full Tabler set is large.
+# permission points, dashboard filter presets, page component kinds).
+# Icons intentionally reference the server file because the full Tabler set is large.
 FIELD_TYPES = (
     {"type": "text.singleLine", "constraints": ["maxLength"], "writable": True},
     {"type": "text.multiLine", "constraints": ["maxLength"], "writable": True},
@@ -432,9 +439,63 @@ 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_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."
+    ),
+    "kinds": (
+        {
+            "kind": None,
+            "name": "field",
+            "note": "Omit kind. Places fields of sourceObjectId on a grid.",
+            "requiredKeys": (
+                "label", "hideLabel", "sourceObjectId", "grid",
+                "alignment", "labelPosition", "labelWidth", "fields",
+            ),
+        },
+        {
+            "kind": "relatedList",
+            "name": "related record list",
+            "pageTypes": ("detail",),
+            "requiredKeys": (
+                "kind", "label", "hideLabel", "objectId", "relationFieldId",
+                "columnFieldIds", "sort", "limit", "showViewAll", "createAction",
+            ),
+            "optionalKeys": ("id", "filters", "carryIns"),
+            "limit": (5, 10, 20),
+            "sortDirections": ("asc", "desc"),
+            "carryInSources": (
+                {
+                    "source": "currentRecord",
+                    "note": "Value is the current record id; target field must be "
+                            "lookup.record pointing at the page object. When create "
+                            "is enabled, relationFieldId must appear exactly once "
+                            "with this source.",
+                },
+                {
+                    "source": "currentRecordField",
+                    "requires": "sourceFieldId",
+                    "note": "Copy an active field from the current record; source "
+                            "and target field types must match.",
+                },
+            ),
+            "filters": {
+                "shape": {"fieldId": "fld_...", "operator": "...", "value": "..."},
+                "note": "Same filter protocol as object views; AND-merged with the "
+                        "implicit relationFieldId eq currentRecord condition.",
+            },
+        },
+    ),
+}
+
 RESOURCE_ID_PREFIXES = {
     "app_": "app", "grp_": "app group", "obj_": "object", "fld_": "field",
     "viw_": "view", "wfl_": "workflow", "pag_": "custom page",
+    "reg_": "page region", "cmp_": "page component",
     "dsh_": "dashboard", "dcm_": "dashboard component", "rol_": "role",
     "rec_": "record", "att_": "attachment", "emp_": "employee", "dep_": "department",
 }
@@ -447,6 +508,7 @@ CATALOGS = {
         "types": DASHBOARD_FILTER_TYPES,
         "dateRangePresets": DASHBOARD_DATE_RANGE_PRESETS,
     },
+    "page-components": PAGE_COMPONENTS,
     "id-prefixes": RESOURCE_ID_PREFIXES,
     "icons": {
         "note": "6146 Tabler icon names are supported; any Icon* name from the "

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

@@ -906,7 +906,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, id-prefixes, icons).",
+        help="List closed-domain catalogs, or dump one (field-types, workflow-nodes, permissions, dashboard-filters, page-components, id-prefixes, icons).",
     )
     docs_catalogs.add_argument("name", nargs="?", default=None)
     docs_show = docs_actions.add_parser("show")

flowbase_cli-0.1.7/README.md → flowbase_cli-0.1.8/src/flowbase_cli.egg-info/PKG-INFO

@@ -1,3 +1,12 @@
+Metadata-Version: 2.4
+Name: flowbase-cli
+Version: 0.1.8
+Summary: Command line client for the FlowBase OpenAPI
+Author: DeepFlowAI
+License: Apache-2.0
+Requires-Python: >=3.11
+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.
@@ -105,6 +114,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 id-prefixes        # resource ID prefix meanings
 flowbase docs catalogs icons              # icon guidance + examples
 ```
@@ -131,7 +141,7 @@ flowbase fields create obj_xxx --json '{"label":"Name","key":"name","description
 flowbase records create obj_xxx --json '{"values":{"name":"Acme Corp"}}'
 ```
 
-Record `values` keys are **field keys** (`name`), not internal IDs (`fld_...`). IDs are `obj_`/`fld_`/`dsh_`/`wfl_`/`pag_`-prefixed; see `docs catalogs id-prefixes`.
+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`.
 
 ### 6.2 Edit and publish configuration on a test environment
 
@@ -168,9 +178,15 @@ flowbase workflows create obj_xxx --json '{"label":"Set owner","enabled":true,"t
 flowbase workflows update obj_xxx wfl_xxx --json-file workflow.json
 flowbase workflows executions obj_xxx wfl_xxx --result failure
 
-flowbase docs example pages.create --output page.json   # authoritative layout template
+flowbase docs catalogs page-components                  # field + relatedList 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).
+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
 ```
 
 ### 6.5 Records and attachments

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

@@ -110,6 +110,18 @@ class FlowBaseCliTest(unittest.TestCase):
         payload = json.loads(stdout.getvalue())
         self.assertIn("regions", payload["requestBody"])
 
+        stdout = io.StringIO()
+        with patch("sys.stdout", stdout):
+            code = main(["docs", "show", "pages.update"])
+        self.assertEqual(code, 0)
+        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)
+
     def test_docs_catalogs_lists_and_dumps_domains(self):
         stdout = io.StringIO()
         with patch("sys.stdout", stdout):
@@ -119,6 +131,7 @@ class FlowBaseCliTest(unittest.TestCase):
         self.assertIn("field-types", names)
         self.assertIn("workflow-nodes", names)
         self.assertIn("permissions", names)
+        self.assertIn("page-components", names)
 
         stdout = io.StringIO()
         with patch("sys.stdout", stdout):
@@ -136,6 +149,23 @@ 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", "page-components"])
+        self.assertEqual(code, 0)
+        page_components = json.loads(stdout.getvalue())
+        kinds = {item.get("kind") for item in page_components["kinds"]}
+        self.assertIn(None, kinds)
+        self.assertIn("relatedList", kinds)
+
+        stdout = io.StringIO()
+        with patch("sys.stdout", stdout):
+            code = main(["docs", "catalogs", "id-prefixes"])
+        self.assertEqual(code, 0)
+        prefixes = json.loads(stdout.getvalue())
+        self.assertEqual(prefixes["reg_"], "page region")
+        self.assertEqual(prefixes["cmp_"], "page component")
+
     def test_docs_list_marks_body_and_confirmation(self):
         stdout = io.StringIO()
         with patch("sys.stdout", stdout):