zinkee 0.1.24 → 0.1.25

package/src/utils/examples.ts

@@ -818,12 +818,12 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   ]),
   "navigation resources move": buildCommandExamples([
     {
-      description: "Move a schema into a navigation folder.",
+      description:
+        "Move a schema into a navigation folder. Only schemas can be moved; the navigation menu holds databases.",
       command:
-        'zinkee --json navigation resources move 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --type SCHEMA --to Sales',
+        'zinkee --json navigation resources move 2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e --to Sales',
       raw: `{
   "resourceId": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
-  "resourceType": "SCHEMA",
   "targetFolderId": "84a0fca4-37ef-4c83-a8ed-9ef67ad9324a"
 }`,
       response: `{
@@ -832,43 +832,12 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
 }`,
     },
     {
-      description: "Move a workflow.",
-      command:
-        'zinkee --json navigation resources move 3f8a2c1b-9d4e-4a5b-8c6d-7e8f90123456 --type WORKFLOW --to Operations',
-      raw: `{
-  "resourceId": "3f8a2c1b-9d4e-4a5b-8c6d-7e8f90123456",
-  "resourceType": "WORKFLOW",
-  "targetFolderId": "b8c9d0e1-f2a3-4b5c-6d7e-8f9012345678"
-}`,
-    },
-    {
-      description: "Move a display.",
+      description: "Move a schema back to the root folder (root is always UUID 00000000-0000-0000-0000-000000000000).",
       command:
-        'zinkee --json navigation resources move 0f6f062f-1478-4df2-96a1-c495d037d260 --type DISPLAY --to Operations',
-      raw: `{
-  "resourceId": "0f6f062f-1478-4df2-96a1-c495d037d260",
-  "resourceType": "DISPLAY",
-  "targetFolderId": "b8c9d0e1-f2a3-4b5c-6d7e-8f9012345678"
-}`,
-    },
-    {
-      description: "Move a resource back to the root folder (root is always UUID 00000000-0000-0000-0000-000000000000).",
-      command:
-        'zinkee --json navigation resources move 5223cbc8-8c6c-4694-93bc-dd176364df9b --type SCHEMA --to 00000000-0000-0000-0000-000000000000',
+        'zinkee --json navigation resources move 5223cbc8-8c6c-4694-93bc-dd176364df9b --to 00000000-0000-0000-0000-000000000000',
       raw: `{
   "resourceId": "5223cbc8-8c6c-4694-93bc-dd176364df9b",
-  "resourceType": "SCHEMA",
   "targetFolderId": "00000000-0000-0000-0000-000000000000"
-}`,
-    },
-    {
-      description: "Move a schedule resource.",
-      command:
-        'zinkee --json navigation resources move a1b2c3d4-e5f6-7890-1234-567890abcdef --type SCHEDULE --to Operations',
-      raw: `{
-  "resourceId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
-  "resourceType": "SCHEDULE",
-  "targetFolderId": "b8c9d0e1-f2a3-4b5c-6d7e-8f9012345678"
 }`,
     },
   ]),
@@ -2421,7 +2390,7 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
     "resources": [
       {
         "id": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
-        "name": "Contacts",
+        "name": "Customer records",
         "type": "SCHEMA",
         "isInSpace": false,
         "additionalProperties": {}
@@ -2445,19 +2414,10 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
     "resources": [
       {
         "id": "3f8a2c1b-9d4e-4a5b-8c6d-7e8f90123456",
-        "name": "Quote approval",
-        "type": "WORKFLOW",
+        "name": "Shipments",
+        "type": "SCHEMA",
         "isInSpace": false,
         "additionalProperties": {}
-      },
-      {
-        "id": "0f6f062f-1478-4df2-96a1-c495d037d260",
-        "name": "Executive Revenue",
-        "type": "DISPLAY",
-        "isInSpace": true,
-        "additionalProperties": {
-          "pinned": true
-        }
       }
     ],
     "additionalProperties": {
@@ -2504,8 +2464,13 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
     "name": "Shared Dashboards",
     "order": 1,
     "isRoot": false,
-    "resourceCount": 1,
+    "resourceCount": 2,
     "resources": [
+      {
+        "id": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
+        "name": "Customer records",
+        "type": "SCHEMA"
+      },
       {
         "id": "0f6f062f-1478-4df2-96a1-c495d037d260",
         "name": "Executive Revenue",
@@ -2727,6 +2692,85 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
       command: "zinkee --json displays delete 0f6f062f-1478-4df2-96a1-c495d037d260",
     },
   ]),
+  "displays folders list": buildCommandExamples([
+    {
+      description: "List flat display folders (non-root folders plus the root bucket).",
+      command: "zinkee --json displays folders list",
+      response: `[
+  {
+    "id": "e7a1c3d2-5f4b-4a6c-9d8e-1f2a3b4c5d6e",
+    "name": "Executive Dashboards",
+    "isRoot": false,
+    "displayCount": 2
+  },
+  {
+    "id": "8b22282b-3db3-4dd7-87f7-b29365dcf3f6",
+    "name": null,
+    "isRoot": true,
+    "displayCount": 4
+  }
+]`,
+    },
+  ]),
+  "displays folders create": buildCommandExamples([
+    {
+      description: "Create one flat display folder.",
+      command: 'zinkee --json displays folders create --name "Executive Dashboards"',
+      raw: `{
+  "name": "Executive Dashboards"
+}`,
+      response: `{
+  "id": "e7a1c3d2-5f4b-4a6c-9d8e-1f2a3b4c5d6e",
+  "name": "Executive Dashboards",
+  "isRoot": false,
+  "displayCount": 0
+}`,
+    },
+  ]),
+  "displays folders update": buildCommandExamples([
+    {
+      description: "Rename a display folder. The folder argument accepts a UUID or an exact name.",
+      command:
+        'zinkee --json displays folders update "Executive Dashboards" --name "Executive Dashboards (2026)"',
+      raw: `{
+  "name": "Executive Dashboards (2026)"
+}`,
+      response: `{
+  "id": "e7a1c3d2-5f4b-4a6c-9d8e-1f2a3b4c5d6e",
+  "name": "Executive Dashboards (2026)",
+  "isRoot": false,
+  "displayCount": 2
+}`,
+    },
+  ]),
+  "displays folders delete": buildCommandExamples([
+    {
+      description: "Delete a non-root display folder. Its displays move back to the root folder.",
+      command: 'zinkee --json displays folders delete "Executive Dashboards"',
+      response: `{
+  "id": "e7a1c3d2-5f4b-4a6c-9d8e-1f2a3b4c5d6e",
+  "name": "Executive Dashboards",
+  "isRoot": false,
+  "displayCount": 2
+}`,
+    },
+  ]),
+  "displays folders move": buildCommandExamples([
+    {
+      description: "Move one display into a target folder by exact folder name.",
+      command:
+        'zinkee --json displays folders move 0f6f062f-1478-4df2-96a1-c495d037d260 --to "Executive Dashboards"',
+      raw: `{
+  "displayId": "0f6f062f-1478-4df2-96a1-c495d037d260",
+  "targetFolderId": "e7a1c3d2-5f4b-4a6c-9d8e-1f2a3b4c5d6e"
+}`,
+      response: `{
+  "id": "e7a1c3d2-5f4b-4a6c-9d8e-1f2a3b4c5d6e",
+  "name": "Executive Dashboards",
+  "isRoot": false
+}`,
+    },
+  ]),
   "displays layout get": buildCommandExamples([
     {
       description: "Get the layout block of a display (template + tabs/freeformLayouts/slots).",
@@ -3797,7 +3841,8 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
       description: "Move one automation into a target folder by exact folder name.",
       command: 'zinkee --json automations folders move automation-1 --to "Codex Frontend Demo"',
       raw: `{
-  "automationId": "automation-1"
+  "automationId": "automation-1",
+  "targetFolderId": "cdfc14e3-3169-4ffb-8d9b-b11858a9240f"
 }`,
       response: `{
   "id": "cdfc14e3-3169-4ffb-8d9b-b11858a9240f",