zinkee 0.1.37 → 0.1.39

package/src/utils/examples.ts

@@ -1458,6 +1458,50 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
       response: `{
   "displayId": "0f6f062f-1478-4df2-96a1-c495d037d260",
   "widgetId": "11111111-1111-4111-a111-111111111111"
+}`,
+    },
+    {
+      description:
+        "Create a TABLE widget with locked fields: contact-name locked permanently (no conditions) and status locked while invoice-number is empty, with before/after lock messages.",
+      command:
+        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --type table --name Invoices --origin-resource 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --layout '{"x":0,"y":0,"w":12,"h":8}' --field contact-name --field invoice-number --field status --field amount --lock-field contact-name --lock-condition "status:invoice-number:is_empty" --lock-message-before "status:Status locks until the invoice number is set." --lock-message-after "status:Status is locked because the invoice number is missing."`,
+      raw: `{
+  "type": "TABLE_OR_SUBTABLE",
+  "source": {
+    "originResourceId": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
+    "isOriginSubSchema": false
+  },
+  "placement": {
+    "layout": { "x": 0, "y": 0, "w": 12, "h": 8 }
+  },
+  "presentation": { "name": "Invoices" },
+  "view": {
+    "fields": ["contact-name", "invoice-number", "status", "amount"]
+  },
+  "behavior": {
+    "lockedFields": [
+      {
+        "field": { "fieldId": "contact-name" },
+        "conditions": []
+      },
+      {
+        "field": { "fieldId": "status" },
+        "conditions": [
+          {
+            "origin": { "fieldId": "invoice-number" },
+            "comparisonOperator": "IS_EMPTY",
+            "values": []
+          }
+        ],
+        "messageBeforeLock": "Status locks until the invoice number is set.",
+        "messageAfterLock": "Status is locked because the invoice number is missing."
+      }
+    ]
+  }
+}`,
+      response: `{
+  "displayId": "0f6f062f-1478-4df2-96a1-c495d037d260",
+  "widgetId": "11111111-1111-4111-a111-111111111111"
 }`,
     },
     {
@@ -1858,6 +1902,46 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
     "hideDeleteButton": true,
     "hideFilterButton": true
   }
+}`,
+    },
+    {
+      description:
+        "Configure locked fields (replaces the stored configuration): contact-name locked permanently, status locked while invoice-number is empty. Empty conditions = always locked; conditions combine with AND. Enforcement happens in display widgets only, never in the database view.",
+      command:
+        `zinkee --json displays widgets update 0f6f062f-1478-4df2-96a1-c495d037d260 11111111-1111-4111-a111-111111111111 --lock-field contact-name --lock-condition "status:invoice-number:is_empty" --lock-message-before "status:Status locks until the invoice number is set." --lock-message-after "status:Status is locked because the invoice number is missing."`,
+      raw: `{
+  "behavior": {
+    "lockedFields": [
+      {
+        "field": { "fieldId": "contact-name" },
+        "conditions": []
+      },
+      {
+        "field": { "fieldId": "status" },
+        "conditions": [
+          {
+            "origin": { "fieldId": "invoice-number" },
+            "comparisonOperator": "IS_EMPTY",
+            "values": []
+          }
+        ],
+        "messageBeforeLock": "Status locks until the invoice number is set.",
+        "messageAfterLock": "Status is locked because the invoice number is missing."
+      }
+    ]
+  }
+}`,
+      response: `{
+  "displayId": "0f6f062f-1478-4df2-96a1-c495d037d260",
+  "widgetId": "11111111-1111-4111-a111-111111111111"
+}`,
+    },
+    {
+      description: "Clear the locked-fields configuration.",
+      command:
+        'zinkee --json displays widgets update 0f6f062f-1478-4df2-96a1-c495d037d260 11111111-1111-4111-a111-111111111111 --clear-locked-fields',
+      raw: `{
+  "behavior": { "lockedFields": [] }
 }`,
     },
     {
@@ -1967,42 +2051,92 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   ]),
   "displays cross-widget-filter set": buildCommandExamples([
     {
-      description: "Link one source widget/field to several target widgets through the same field.",
+      description:
+        "Single configuration with flags: link one source widget/field to several targets. The whole array is replaced.",
       command:
         'zinkee --json displays cross-widget-filter set 0f6f062f-1478-4df2-96a1-c495d037d260 --source-widget 11111111-1111-4111-a111-111111111111 --source-field c60b8526-5835-4c9f-aecd-9a16c7704a34 --target 22222222-2222-4222-a222-222222222222:c60b8526-5835-4c9f-aecd-9a16c7704a34 --target 33333333-3333-4333-a333-333333333333:c60b8526-5835-4c9f-aecd-9a16c7704a34',
-      raw: `{
-  "source": {
-    "widgetId": "11111111-1111-4111-a111-111111111111",
-    "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
-  },
-  "targets": [
-    {
-      "widgetId": "22222222-2222-4222-a222-222222222222",
+      raw: `[
+  {
+    "source": {
+      "widgetId": "11111111-1111-4111-a111-111111111111",
       "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
     },
+    "targets": [
+      {
+        "widgetId": "22222222-2222-4222-a222-222222222222",
+        "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
+      },
+      {
+        "widgetId": "33333333-3333-4333-a333-333333333333",
+        "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
+      }
+    ]
+  }
+]`,
+    },
     {
-      "widgetId": "33333333-3333-4333-a333-333333333333",
+      description:
+        "Several independent configurations with --raw (each source filters its own targets). A widget cannot be a target of two configurations.",
+      command:
+        "zinkee --json displays cross-widget-filter set 0f6f062f-1478-4df2-96a1-c495d037d260 --raw '[{\"source\":{\"widgetId\":\"11111111-1111-4111-a111-111111111111\",\"fieldId\":\"c60b8526-5835-4c9f-aecd-9a16c7704a34\"},\"targets\":[{\"widgetId\":\"22222222-2222-4222-a222-222222222222\",\"fieldId\":\"c60b8526-5835-4c9f-aecd-9a16c7704a34\"}]},{\"source\":{\"widgetId\":\"44444444-4444-4444-a444-444444444444\",\"fieldId\":\"a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890\"},\"targets\":[{\"widgetId\":\"55555555-5555-4555-a555-555555555555\",\"fieldId\":\"a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890\"}]}]'",
+      raw: `[
+  {
+    "source": {
+      "widgetId": "11111111-1111-4111-a111-111111111111",
       "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
-    }
-  ]
-}`,
+    },
+    "targets": [
+      {
+        "widgetId": "22222222-2222-4222-a222-222222222222",
+        "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
+      }
+    ]
+  },
+  {
+    "source": {
+      "widgetId": "44444444-4444-4444-a444-444444444444",
+      "fieldId": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890"
+    },
+    "targets": [
+      {
+        "widgetId": "55555555-5555-4555-a555-555555555555",
+        "fieldId": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890"
+      }
+    ]
+  }
+]`,
     },
     {
-      description: "Filter one target widget by the status field of the source.",
+      description:
+        "Hierarchy chain with --raw-file: a target of one configuration is the source of the next (click Parent → filters Child, click Child → filters Grandchild).",
       command:
-        'zinkee --json displays cross-widget-filter set 0f6f062f-1478-4df2-96a1-c495d037d260 --source-widget 11111111-1111-4111-a111-111111111111 --source-field a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890 --target 66666666-6666-4666-a666-666666666666:a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890',
-      raw: `{
-  "source": {
-    "widgetId": "11111111-1111-4111-a111-111111111111",
-    "fieldId": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890"
+        "zinkee --json displays cross-widget-filter set 0f6f062f-1478-4df2-96a1-c495d037d260 --raw-file cross-widget-filter.json",
+      raw: `[
+  {
+    "source": {
+      "widgetId": "11111111-1111-4111-a111-111111111111",
+      "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
+    },
+    "targets": [
+      {
+        "widgetId": "22222222-2222-4222-a222-222222222222",
+        "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
+      }
+    ]
   },
-  "targets": [
-    {
-      "widgetId": "66666666-6666-4666-a666-666666666666",
+  {
+    "source": {
+      "widgetId": "22222222-2222-4222-a222-222222222222",
       "fieldId": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890"
-    }
-  ]
-}`,
+    },
+    "targets": [
+      {
+        "widgetId": "33333333-3333-4333-a333-333333333333",
+        "fieldId": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890"
+      }
+    ]
+  }
+]`,
     },
   ]),
   "schemas list": buildCommandExamples([
@@ -2900,18 +3034,20 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
       }
     }
   ],
-  "crossWidgetFilter": {
-    "source": {
-      "widgetId": "11111111-1111-4111-a111-111111111111",
-      "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
-    },
-    "targets": [
-      {
-        "widgetId": "22222222-2222-4222-a222-222222222222",
+  "crossWidgetFilter": [
+    {
+      "sourceWidget": {
+        "widgetId": "11111111-1111-4111-a111-111111111111",
         "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
-      }
-    ]
-  },
+      },
+      "targetWidgets": [
+        {
+          "widgetId": "22222222-2222-4222-a222-222222222222",
+          "fieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
+        }
+      ]
+    }
+  ],
   "navigationTargets": [
     {
       "id": "nav-target-customer",