zinkee 0.1.25 → 0.1.26

package/src/utils/examples.ts

@@ -1283,7 +1283,7 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
       description:
         "Create a TABLE widget (CLI normalises --type table to TABLE_OR_SUBTABLE).",
       command:
-        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --type table --name Customers --origin-resource 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --layout '{"x":0,"y":0,"w":12,"h":8}' --field id --field contact-name --field status --sort '{"fieldId":"id","direction":"DESC"}'`,
+        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --type table --name Customers --origin-resource 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --layout '{"x":0,"y":0,"w":12,"h":8}' --field contact-name --field status --field amount --sort '{"fieldId":"contact-name","direction":"ASC"}'`,
       raw: `{
   "type": "TABLE_OR_SUBTABLE",
   "source": {
@@ -1298,11 +1298,11 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   },
   "query": {
     "sorts": [
-      { "fieldId": "id", "direction": "DESC" }
+      { "fieldId": "contact-name", "direction": "ASC" }
     ]
   },
   "view": {
-    "fields": ["id", "contact-name", "status"]
+    "fields": ["contact-name", "status", "amount"]
   }
 }`,
       response: `{
@@ -1387,7 +1387,7 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
     {
       description: "Create a bars CHART widget with a monthly time-serie x-axis and two y-axis series.",
       command:
-        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --type CHART --name "Revenue by month" --origin-resource 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --layout '{"x":0,"y":0,"w":8,"h":6}' --chart-type bars --x-axis-field due-date --x-axis-date-format MONTH_YEAR --x-axis-time-series --y-axis-serie '{"typeCalc":"SUM","fieldCalc":"amount","color":"#4B9CD3","axisType":"PRIMARY"}' --y-axis-serie '{"typeCalc":"COUNT","fieldCalc":"id","color":"#E57373","axisType":"SECONDARY"}' --legend '{"position":"bottom"}'`,
+        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --type CHART --name "Revenue by month" --origin-resource 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --layout '{"x":0,"y":0,"w":8,"h":6}' --chart-type bars --x-axis-field due-date --x-axis-date-format MONTH_YEAR --x-axis-time-series --y-axis-serie '{"typeCalc":"SUM","fieldCalc":"amount","color":"#4B9CD3","axisType":"PRIMARY"}' --y-axis-serie '{"typeCalc":"COUNT","fieldCalc":"contact-name","color":"#E57373","axisType":"SECONDARY"}' --legend '{"position":"bottom"}'`,
       raw: `{
   "type": "CHART",
   "source": {
@@ -1412,7 +1412,7 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
       },
       {
         "typeCalc": "COUNT",
-        "fieldCalc": "id",
+        "fieldCalc": "contact-name",
         "color": "#E57373",
         "axisType": "SECONDARY"
       }
@@ -1484,9 +1484,10 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
 }`,
     },
     {
-      description: "Create a TIMELINE widget.",
+      description:
+        "Create a TIMELINE widget via flags. The typed view state lives in view.viewAdditionalProperties.viewState; field references there must be UUIDs (slugs are only resolved in --field). cardConfig uses category1/category2/category4 (no category3). Use --view-state for UI scalars (granularity, sidebarWidth, show* ...).",
       command:
-        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --type TIMELINE --name "Customer schedule" --origin-resource 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --layout '{"x":0,"y":0,"w":12,"h":6}' --field contact-name --field due-date`,
+        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --type TIMELINE --name "Customer schedule" --origin-resource 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --layout '{"x":0,"y":0,"w":12,"h":6}' --field c60b8526-5835-4c9f-aecd-9a16c7704a34 --field a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890 --field c52efe3f-2825-4c60-a7e3-34dd4c1ce043 --field d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90 --start-date-field d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90 --end-date-field e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9012 --label-field c60b8526-5835-4c9f-aecd-9a16c7704a34 --group-field a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890 --subgroup-field c60b8526-5835-4c9f-aecd-9a16c7704a34 --progress-field c52efe3f-2825-4c60-a7e3-34dd4c1ce043 --card-title-field c60b8526-5835-4c9f-aecd-9a16c7704a34 --card-category1-field a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890 --card-category2-field d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90 --card-category4-field c52efe3f-2825-4c60-a7e3-34dd4c1ce043 --card-description-field c60b8526-5835-4c9f-aecd-9a16c7704a34 --view-state '{"granularity":"month","sidebarWidth":300,"showUngroupedEvents":true,"showUnsubgroupedEvents":true}'`,
       raw: `{
   "type": "TIMELINE",
   "source": {
@@ -1498,15 +1499,43 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   },
   "presentation": { "name": "Customer schedule" },
   "view": {
-    "fields": ["contact-name", "due-date"]
+    "fields": [
+      "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+      "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
+      "c52efe3f-2825-4c60-a7e3-34dd4c1ce043",
+      "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90"
+    ],
+    "viewAdditionalProperties": {
+      "viewState": {
+        "granularity": "month",
+        "sidebarWidth": 300,
+        "showUngroupedEvents": true,
+        "showUnsubgroupedEvents": true,
+        "fieldMapping": {
+          "startDateField": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+          "endDateField": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9012",
+          "labelField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+          "groupField": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
+          "subgroupField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+          "progressField": "c52efe3f-2825-4c60-a7e3-34dd4c1ce043",
+          "cardConfig": {
+            "titleField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+            "category1Field": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
+            "category2Field": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+            "category4Field": "c52efe3f-2825-4c60-a7e3-34dd4c1ce043",
+            "descriptionField": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
+          }
+        }
+      }
+    }
   }
 }`,
     },
     {
       description:
-        "Create a KANBAN widget with a status filter and groupsExpanded config (rich query/view requires --raw).",
+        "Create a KANBAN widget via flags. The typed view state lives in view.viewAdditionalProperties.viewState; field references there must be UUIDs (slugs are only resolved in --field). cardConfig uses category1/category2/category3 (no category4). --aggregation-method/--aggregation-field set the card aggregation; use --view-state for UI scalars.",
       command:
-        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --raw '{"type":"KANBAN","source":{"originResourceId":"2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e","isOriginSubSchema":false},"placement":{"layout":{"x":0,"y":0,"w":12,"h":8}},"presentation":{"name":"Status board"},"query":{"filters":[{"origin":{"schemaId":"contacts","fieldId":"status"},"comparisonOperator":"ANY_OF","values":["1","2","3"]}]},"view":{"fields":["contact-name","status","amount"],"groupsExpanded":{"1":true,"2":true,"3":false}}}'`,
+        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --type KANBAN --name "Status board" --origin-resource 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --layout '{"x":0,"y":0,"w":12,"h":8}' --field c60b8526-5835-4c9f-aecd-9a16c7704a34 --field a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890 --field c52efe3f-2825-4c60-a7e3-34dd4c1ce043 --field d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90 --column-field a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890 --swimlane-field c60b8526-5835-4c9f-aecd-9a16c7704a34 --card-title-field c60b8526-5835-4c9f-aecd-9a16c7704a34 --card-category1-field a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890 --card-category2-field d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90 --card-category3-field c52efe3f-2825-4c60-a7e3-34dd4c1ce043 --card-description-field c60b8526-5835-4c9f-aecd-9a16c7704a34 --aggregation-method sum --aggregation-field c52efe3f-2825-4c60-a7e3-34dd4c1ce043 --view-state '{"hideEmptyColumns":false,"showNoValueColumn":true,"showNoValueSwimlane":true}'`,
       raw: `{
   "type": "KANBAN",
   "source": {
@@ -1517,28 +1546,43 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
     "layout": { "x": 0, "y": 0, "w": 12, "h": 8 }
   },
   "presentation": { "name": "Status board" },
-  "query": {
-    "filters": [
-      {
-        "origin": {
-          "schemaId": "contacts",
-          "fieldId": "status"
-        },
-        "comparisonOperator": "ANY_OF",
-        "values": ["1", "2", "3"]
-      }
-    ]
-  },
   "view": {
-    "fields": ["contact-name", "status", "amount"],
-    "groupsExpanded": { "1": true, "2": true, "3": false }
+    "fields": [
+      "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+      "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
+      "c52efe3f-2825-4c60-a7e3-34dd4c1ce043",
+      "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90"
+    ],
+    "viewAdditionalProperties": {
+      "viewState": {
+        "hideEmptyColumns": false,
+        "showNoValueColumn": true,
+        "showNoValueSwimlane": true,
+        "fieldMapping": {
+          "columnField": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
+          "swimlaneField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+          "cardConfig": {
+            "titleField": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+            "category1Field": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
+            "category2Field": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
+            "category3Field": "c52efe3f-2825-4c60-a7e3-34dd4c1ce043",
+            "descriptionField": "c60b8526-5835-4c9f-aecd-9a16c7704a34"
+          },
+          "aggregationConfig": {
+            "method": "sum",
+            "fieldId": "c52efe3f-2825-4c60-a7e3-34dd4c1ce043"
+          }
+        }
+      }
+    }
   }
 }`,
     },
     {
-      description: "Create a HIERARCHY widget rooted on a parent field.",
+      description:
+        "Create a HIERARCHY widget via flags. Declare columns once (--hierarchy-label, repeatable --hierarchy-info <id:name>, --hierarchy-number <id:name:aggregation>), map the root level (the view's own table) with --hierarchy-root-* and add each child level as a JSON object with --hierarchy-child. label is required per level; info/number mappings are optional. Column ids (e.g. col_1779975207355_zfndknslw) are unique opaque identifiers you choose — not the column name — and are reused as columnId in every mapping. All field references must be UUIDs.",
       command:
-        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --raw '{"type":"HIERARCHY","source":{"originResourceId":"2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e","isOriginSubSchema":false},"placement":{"layout":{"x":0,"y":0,"w":12,"h":6}},"presentation":{"name":"Org tree"},"view":{"fields":["contact-name","status"],"hierarchyConfig":{"parentFieldId":"contact-name"}}}'`,
+        `zinkee --json displays widgets create 0f6f062f-1478-4df2-96a1-c495d037d260 --type HIERARCHY --name "Org tree" --origin-resource 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --layout '{"x":0,"y":0,"w":12,"h":6}' --field c60b8526-5835-4c9f-aecd-9a16c7704a34 --field a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890 --field c52efe3f-2825-4c60-a7e3-34dd4c1ce043 --hierarchy-label "Name" --hierarchy-info "col_1779975207355_zfndknslw:Status" --hierarchy-info "col_1779975243018_qm4t7xb2pa:Description" --hierarchy-number "col_1779975261490_h8kd3nv9ws:Total amount:SUM" --hierarchy-root-name "Customers" --hierarchy-root-label-field c60b8526-5835-4c9f-aecd-9a16c7704a34 --hierarchy-root-info "col_1779975207355_zfndknslw:a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890" --hierarchy-root-number "col_1779975261490_h8kd3nv9ws:c52efe3f-2825-4c60-a7e3-34dd4c1ce043" --hierarchy-child '{"name":"Projects","schemaId":"3ec9cdef-7e0a-4cdd-8019-8fb9281f5d6f","childFieldId":"80deefae-af3d-4000-b322-bfe1594f8073","labelFieldId":"50dbef0b-7e0a-4fdd-8019-8fb9281f5d70","infoMappings":[{"columnId":"col_1779975243018_qm4t7xb2pa","fieldId":"60dcef0c-8f1b-4eee-9120-9fc0392f6e71"}],"numberMappings":[{"columnId":"col_1779975261490_h8kd3nv9ws","fieldId":"70ddef0d-9f2c-4fff-a221-afd0493f7f72"}]}'`,
       raw: `{
   "type": "HIERARCHY",
   "source": {
@@ -1550,9 +1594,46 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   },
   "presentation": { "name": "Org tree" },
   "view": {
-    "fields": ["contact-name", "status"],
+    "fields": [
+      "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+      "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890",
+      "c52efe3f-2825-4c60-a7e3-34dd4c1ce043"
+    ],
     "hierarchyConfig": {
-      "parentFieldId": "contact-name"
+      "columns": {
+        "label": "Name",
+        "infos": [
+          { "id": "col_1779975207355_zfndknslw", "name": "Status" },
+          { "id": "col_1779975243018_qm4t7xb2pa", "name": "Description" }
+        ],
+        "numbers": [
+          { "id": "col_1779975261490_h8kd3nv9ws", "name": "Total amount", "aggregation": "SUM" }
+        ]
+      },
+      "rootLevel": {
+        "name": "Customers",
+        "labelFieldId": "c60b8526-5835-4c9f-aecd-9a16c7704a34",
+        "infoMappings": [
+          { "columnId": "col_1779975207355_zfndknslw", "fieldId": "a8f1d7e3-2b5c-4d9e-8a1b-3c4d5e6f7890" }
+        ],
+        "numberMappings": [
+          { "columnId": "col_1779975261490_h8kd3nv9ws", "fieldId": "c52efe3f-2825-4c60-a7e3-34dd4c1ce043" }
+        ]
+      },
+      "childLevels": [
+        {
+          "name": "Projects",
+          "schemaId": "3ec9cdef-7e0a-4cdd-8019-8fb9281f5d6f",
+          "childFieldId": "80deefae-af3d-4000-b322-bfe1594f8073",
+          "labelFieldId": "50dbef0b-7e0a-4fdd-8019-8fb9281f5d70",
+          "infoMappings": [
+            { "columnId": "col_1779975243018_qm4t7xb2pa", "fieldId": "60dcef0c-8f1b-4eee-9120-9fc0392f6e71" }
+          ],
+          "numberMappings": [
+            { "columnId": "col_1779975261490_h8kd3nv9ws", "fieldId": "70ddef0d-9f2c-4fff-a221-afd0493f7f72" }
+          ]
+        }
+      ]
     }
   }
 }`,
@@ -1562,13 +1643,13 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
     {
       description: "Move placement, update view columns, rename the widget and lock it.",
       command:
-        `zinkee --json displays widgets update 0f6f062f-1478-4df2-96a1-c495d037d260 11111111-1111-4111-a111-111111111111 --layout '{"x":1,"y":2,"w":8,"h":4}' --field id --field contact-name --field status --name "Revenue Updated" --widget-read-only`,
+        `zinkee --json displays widgets update 0f6f062f-1478-4df2-96a1-c495d037d260 11111111-1111-4111-a111-111111111111 --layout '{"x":1,"y":2,"w":8,"h":4}' --field contact-name --field status --field amount --name "Revenue Updated" --widget-read-only`,
       raw: `{
   "placement": {
     "layout": { "x": 1, "y": 2, "w": 8, "h": 4 }
   },
   "view": {
-    "fields": ["id", "contact-name", "status"]
+    "fields": ["contact-name", "status", "amount"]
   },
   "presentation": { "name": "Revenue Updated" },
   "behavior": { "readOnly": true }
@@ -2644,7 +2725,7 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
         "hideDeleteButton": false
       },
       "view": {
-        "fields": ["id", "contact-name", "status", "amount"],
+        "fields": ["contact-name", "status", "amount"],
         "columnSize": { "contact-name": 240 }
       }
     }
@@ -2868,7 +2949,7 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
     "hideDeleteButton": false
   },
   "view": {
-    "fields": ["id", "contact-name", "status", "amount"],
+    "fields": ["contact-name", "status", "amount"],
     "columnSize": { "contact-name": 240 }
   }
 }`,