flowbase-cli 0.1.12__tar.gz → 0.1.13__tar.gz

{flowbase_cli-0.1.12 → flowbase_cli-0.1.13}/PKG-INFO

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

{flowbase_cli-0.1.12 → flowbase_cli-0.1.13}/pyproject.toml

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

{flowbase_cli-0.1.12 → flowbase_cli-0.1.13}/src/flowbase_cli/__init__.py

@@ -1,3 +1,3 @@
 """FlowBase OpenAPI CLI."""
 
-__version__ = "0.1.12"
+__version__ = "0.1.13"

{flowbase_cli-0.1.12 → flowbase_cli-0.1.13}/src/flowbase_cli/endpoints.py

@@ -324,19 +324,19 @@ ENDPOINTS = (
              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("print-templates.list", "flowbase_print_templates_list", "GET", "/objects/{object_id}/print-templates", "metadata:read", "List object print templates.", "flowbase print-templates list obj_xxx"),
-    Endpoint("print-templates.get", "flowbase_print_templates_get", "GET", "/objects/{object_id}/print-templates/{template_id}", "metadata:read", "Get a print template with HTML and data code.", "flowbase print-templates get obj_xxx ptp_xxx"),
-    Endpoint("print-templates.create", "flowbase_print_templates_create", "POST", "/objects/{object_id}/print-templates", "metadata:write", "Create a print template draft.", "flowbase print-templates create obj_xxx --json-file template.json",
+    Endpoint("print-templates.list", "flowbase_print_templates_list", "GET", "/objects/{object_id}/print-templates", "metadata:read", "List object print templates. draftRevision is on the envelope.", "flowbase print-templates list obj_xxx"),
+    Endpoint("print-templates.get", "flowbase_print_templates_get", "GET", "/objects/{object_id}/print-templates/{template_id}", "metadata:read", "Get a print template with HTML and data code. Returns source, not rendered HTML.", "flowbase print-templates get obj_xxx ptp_xxx"),
+    Endpoint("print-templates.create", "flowbase_print_templates_create", "POST", "/objects/{object_id}/print-templates", "metadata:write", "Create a print template draft. Read docs catalogs print-templates first.", "flowbase print-templates create obj_xxx --json-file template.json",
              request_body=(
                  '{"baseRevision":3,"name":"Sales order","key":"sales_order","description":"",'
                  '"paper":{"size":"A4","width":null,"height":null,"orientation":"portrait",'
                  '"margins":{"top":15,"right":15,"bottom":15,"left":15}},'
                  '"header":{"left":"","center":"","right":""},'
-                 '"footer":{"left":"","center":"Page {page} / {pages}","right":""},'
-                 '"html":"<h1>{{ record.summary }}</h1>\\n<p>{{ data.total | money(\\"CNY\\") }}</p>",'
-                 '"code":"import flowbase\\n\\ndef run():\\n    return {\\"total\\": 0}"}'
+                 '"footer":{"left":"","center":"第 {page} 页 / 共 {pages} 页","right":""},'
+                 '"html":"<h1>{{ record.summary }}</h1>\\n<p>{{ record.name }}</p>\\n<p>{{ data.total | money(\\"CNY\\") }}</p>",'
+                 '"code":"import flowbase\\n\\ndef run():\\n    amount = flowbase.record.values.get(\\"amount\\") or 0\\n    return {\\"total\\": amount}"}'
              )),
-    Endpoint("print-templates.update", "flowbase_print_templates_update", "PUT", "/objects/{object_id}/print-templates/{template_id}", "metadata:write", "Update a print template; omitted fields keep their value.", "flowbase print-templates update obj_xxx ptp_xxx --json-file template.json",
+    Endpoint("print-templates.update", "flowbase_print_templates_update", "PUT", "/objects/{object_id}/print-templates/{template_id}", "metadata:write", "Partial update. Send changed fields plus baseRevision and baseUpdatedAt. Do not resend id, key, enabled, updatedAt, or draftRevision.", "flowbase print-templates update obj_xxx ptp_xxx --json-file template.json",
              request_body=(
                  '{"baseRevision":4,"baseUpdatedAt":"2026-10-13T08:00:00+00:00",'
                  '"html":"<h1>{{ record.summary }}</h1>"}'
@@ -810,19 +810,23 @@ AUTHORING = {
         "views.create": ["baseRevision", "name", "defaultFieldIds"],
         "pages.create": ["baseRevision", "page"],
         "records.create": ["values"],
+        "print-templates.create": ["name", "html"],
     },
     "draftRevision": {
         "notReturnedBy": ["objects.get", "objects.list", "apps.get", "apps.list"],
         "returnedBy": [
             "views.list", "pages.list", "pages.get",
+            "print-templates.list", "print-templates.get",
             "every metadata write response (draftRevision)",
         ],
-        "note": "Capture draftRevision from the last write or from views.list/pages.list before views/pages writes.",
+        "note": "Capture draftRevision from the last write or from views.list/pages.list/print-templates.list before writes.",
     },
     "readThenWrite": (
         "For update of views/pages/dashboards/fields with constraints: get the snapshot, "
         "edit it, set baseRevision from draftRevision. fields.update.constraints is a full replace; "
-        "sending {} wipes options."
+        "sending {} wipes options. print-templates.update is partial: send only changed fields, "
+        "baseRevision, and baseUpdatedAt copied from updatedAt. Resending id, key, enabled, "
+        "updatedAt, or draftRevision is rejected."
     ),
     "recordsNeedReleasedMetadata": (
         "On production, records.create/list/get use the released runtime, not the current draft. "
@@ -928,6 +932,18 @@ AUTHORING = {
             "wrong": "dashboard date_range filter with no default",
             "right": "Unset date_range defaults to last_30_days at runtime; set default.preset or omit the filter.",
         },
+        {
+            "wrong": "print HTML {name} or {{ name }} or {{ record.客户名称 }}",
+            "right": "Use {{ record.<field key> }} with the key from objects get. See docs catalogs print-templates.",
+        },
+        {
+            "wrong": "print footer {{ page }} / {{ pages }}",
+            "right": "Page numbers are the literal tokens {page} and {pages}, only in header and footer.",
+        },
+        {
+            "wrong": "print-templates.update with the whole get document",
+            "right": "Partial update. Omit id, key, enabled, updatedAt, and draftRevision. Copy updatedAt to baseUpdatedAt.",
+        },
     ],
 }
 
@@ -1269,6 +1285,7 @@ RESOURCE_ID_PREFIXES = {
     "reg_": "page region", "cmp_": "page component",
     "dsh_": "dashboard", "dcm_": "dashboard component", "rol_": "role",
     "rec_": "record", "att_": "attachment", "emp_": "employee", "dep_": "department",
+    "ptp_": "print template",
 }
 
 WORKFLOW_BRANCHES = {
@@ -1323,11 +1340,51 @@ DASHBOARD_RUNTIME = {
     "example": "import flowbase\n\ndef run():\n    return {\"type\": \"metric\", \"value\": 1}\n",
 }
 
+PRINT_TEMPLATES = {
+    "command": "flowbase docs catalogs print-templates",
+    "readFirst": "objects get supplies field keys. print-templates list supplies draftRevision. print-templates get supplies html, code, header, footer, and updatedAt.",
+    "placeholders": {
+        "html": "Jinja2: {{ }} output, {% for %} loops, {% if %} conditions. An unknown name renders blank and still saves.",
+        "record": "{{ record.<fieldKey> }} is display text. {{ record.values.<fieldKey> }} is the raw value. {{ record.summary }} is the record summary. Built-in id, summary, and values win over a field with the same key.",
+        "keys": "fieldKey is the field key from objects get, never the label and never a fld_ id. Replace name and amount in the create example with keys from that object.",
+        "data": "data is only the dict returned by run(). With no code, data is {}. {{ data.total }} stays blank unless run() returns total.",
+        "other": "employee.name, employee.email, now (ISO string; format with the date filter), template.name, template.key.",
+        "pageTokens": "{page} and {pages} are not Jinja. They work only in header and footer, as literal single-brace text. {{ page }} is erased before page numbers are applied. In the HTML body, {page} stays as the text {page}.",
+    },
+    "filters": {
+        "money": "{{ record.values.amount | money(\"CNY\") }} thousands, 2 decimals, currency symbol. Use the raw value.",
+        "money_upper": "{{ data.total | money_upper }} RMB amount in Chinese capitals.",
+        "date": "{{ record.values.signed_on | date(\"YYYY-MM-DD HH:mm\") }} or {{ now | date(\"YYYY-MM-DD\") }}.",
+        "rich": "{{ record.values.remark | rich }} sanitized HTML for a rich-text field.",
+        "image": "{{ record.values.photo | image(width=\"40mm\") }} inlines a visible image attachment.",
+        "qrcode": "{{ record.values.order_no | qrcode(size=\"25mm\") }}",
+        "barcode": "{{ record.values.order_no | barcode(\"code128\", height=\"12mm\") }} code128 or ean13.",
+        "nl2br": "{{ record.notes | nl2br }} turns newlines into <br>.",
+        "removed": "safe, urlize, and xmlattr are unavailable. Output is HTML-escaped unless a filter above returns HTML.",
+    },
+    "code": {
+        "shape": "Optional. import flowbase only. Define run() with no arguments and return a JSON object, max 2 MB.",
+        "record": "flowbase.record.values[key] is raw; flowbase.record.display[key] is display text; flowbase.record.summary is the summary.",
+        "related": "flowbase.records.related(relation, fields=None, order_by=None, limit=200, record=None). relation is a lookup field key, forward or reverse. Return line.display dicts so the template can use {{ line.<fieldKey> }}.",
+        "get": "flowbase.records.get(object, record_id, fields=None) returns the same shape or None. object is an object key.",
+        "query": "flowbase.query.records.count/group_by/timeseries/list match dashboard-runtime but have no inherit_filters argument. scope is own or omitted.",
+        "approvals": "flowbase.approvals.history(record=None) returns up to 50 instances.",
+        "example": "import flowbase\n\ndef run():\n    record = flowbase.record\n    lines = flowbase.records.related(\"lines\", fields=[\"product\", \"amount\"])\n    return {\n        \"total\": record.values.get(\"amount\") or 0,\n        \"lines\": [line.display for line in lines],\n    }\n",
+    },
+    "write": {
+        "create": "Requires name and html. Other settings have defaults. New templates are enabled. key cannot be changed later. enabled is not a create/update field; use set-enabled.",
+        "update": "Partial. Omitted fields stay. Copy updatedAt to baseUpdatedAt and draftRevision to baseRevision. Do not send id, key, enabled, updatedAt, or draftRevision.",
+        "limits": "At most 20 templates per object. HTML 200 KB, code 100 KB, each header/footer slot 200 characters. A non-empty header needs top margin >= 10; a non-empty footer needs bottom margin >= 10.",
+    },
+    "verify": "The management CLI cannot render a template. get returns the source. A saved {{ }} that names the wrong key prints blank. There is no print-templates run command.",
+}
+
 CATALOGS = {
     "workflow-branches": WORKFLOW_BRANCHES,
     "approval-rules": APPROVAL_RULES,
     "page-buttons": PAGE_BUTTONS,
     "dashboard-runtime": DASHBOARD_RUNTIME,
+    "print-templates": PRINT_TEMPLATES,
     "field-types": FIELD_TYPES,
     "view-filters": VIEW_FILTERS,
     "record-values": RECORD_VALUES,

{flowbase_cli-0.1.12 → flowbase_cli-0.1.13}/src/flowbase_cli/guide.py

@@ -8,7 +8,7 @@ GUIDE = {
         "flowbase apps list；flowbase objects list：发现已有应用和对象，优先复用，不猜测 ID。",
         "flowbase objects get <object_id>：读取字段 key、类型、约束和真实选项 ID；关联字段继续读取目标对象。",
         "flowbase docs catalogs authoring；flowbase docs list；flowbase docs show <endpoint_key>：查请求和更新方式。",
-        "配置页面前读取 pages options、page-components、page-rules、page-buttons；配置流程前读取 workflow-nodes、workflow-branches 或 approval-rules。",
+        "配置页面前读取 pages options、page-components、page-rules、page-buttons；配置流程前读取 workflow-nodes、workflow-branches 或 approval-rules；配置打印模板前读取 print-templates。",
         "先 get 再修改，保留未修改的配置。按目录转换更新 envelope；从最近读取或写入返回值获取 draftRevision，作为 baseRevision。",
         "写后回读验证。records create 返回 recordId，再 records get；values 使用字段 key，选择和关联使用真实 ID。",
         "遍历列表的所有分页。records list --view-id <view_id> 验证特定视图，records get 获取完整记录。",
@@ -29,7 +29,7 @@ GUIDE = {
     ],
     "limits": [
         "docs/guide 离线可读；业务调用需要权限和已启用环境。",
-        "页面规则求值不是浏览器渲染；仪表盘输出验证不是图表视觉验证。",
+        "页面规则求值不是浏览器渲染；仪表盘输出验证不是图表视觉验证。打印模板 get 返回源码，管理 CLI 不能生成打印内容；写错的 {{ }} 会保存成功并打印成空白。",
         "组织候选只读；不能通过管理 CLI 替员工做审批决定。",
         "删除对象/字段/页面是逻辑删除；没有物理 purge，审计与回收站会保留。",
     ],

{flowbase_cli-0.1.12 → flowbase_cli-0.1.13}/src/flowbase_cli.egg-info/PKG-INFO

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

{flowbase_cli-0.1.12 → flowbase_cli-0.1.13}/tests/test_autonomy.py

@@ -23,10 +23,25 @@ class AutonomyTest(unittest.TestCase):
             self.assertIn('低代码平台', guide['product'])
             self.assertTrue(any('objects get' in item for item in guide['workflow']))
             self.assertEqual(code, 0)
+            self.assertTrue(any('print-templates' in item for item in guide['workflow']))
             code, out, _ = self.invoke(['docs', 'catalogs'])
-            self.assertTrue({'page-buttons', 'workflow-branches', 'approval-rules', 'dashboard-runtime'}.issubset(json.loads(out)))
+            self.assertTrue({'page-buttons', 'workflow-branches', 'approval-rules', 'dashboard-runtime', 'print-templates'}.issubset(json.loads(out)))
             request.assert_not_called()
 
+    def test_print_template_catalog_separates_field_and_page_placeholders(self):
+        code, out, err = self.invoke(['docs', 'catalogs', 'print-templates'])
+        self.assertEqual(code, 0, err)
+        catalog = json.loads(out)
+        placeholders = catalog['placeholders']
+        self.assertIn('{{ record.<fieldKey> }}', placeholders['record'])
+        self.assertIn('objects get', placeholders['keys'])
+        self.assertIn('{page}', placeholders['pageTokens'])
+        self.assertIn('{{ page }}', placeholders['pageTokens'])
+        self.assertIn('header and footer', placeholders['pageTokens'])
+        self.assertIn('no inherit_filters', catalog['code']['query'])
+        self.assertIn('baseUpdatedAt', catalog['write']['update'])
+        self.assertIn('cannot render', catalog['verify'])
+
     def test_write_disconnect_is_not_retried_or_reported_as_definite_failure(self):
         for error in (RemoteDisconnected('connection closed'), TimeoutError('timed out'), URLError('fbk_secret rejected')):
             with self.subTest(error=error), patch('flowbase_cli.main.urlopen', side_effect=error) as request:

{flowbase_cli-0.1.12 → flowbase_cli-0.1.13}/tests/test_cli.py

@@ -334,6 +334,7 @@ class FlowBaseCliTest(unittest.TestCase):
         prefixes = json.loads(stdout.getvalue())
         self.assertEqual(prefixes["reg_"], "page region")
         self.assertEqual(prefixes["cmp_"], "page component")
+        self.assertEqual(prefixes["ptp_"], "print template")
 
     def test_docs_list_marks_body_and_confirmation(self):
         stdout = io.StringIO()