zinkee 0.1.22 → 0.1.24

package/src/utils/examples.ts

@@ -3515,6 +3515,47 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
       "steps": ["one", "two"]
     }
   }
+}`,
+    },
+    {
+      description:
+        "Add a send-message action. --to maps to fieldMapping.recipients and --message maps to fieldMapping.body. Values are wrapped in {rawValue, source} like every other automation field mapping; use --map / --map-json for extra keys.",
+      command:
+        `zinkee --json automations actions add automation-1 --type send_message --name "Notify customer" --to customer@example.com --subject "Your order status has changed" --message "Hello, your order is now processed."`,
+      raw: `{
+  "type": "send_message",
+  "name": "Notify customer",
+  "config": {
+    "fieldMapping": {
+      "recipients": {
+        "rawValue": "customer@example.com",
+        "source": null
+      },
+      "subject": {
+        "rawValue": "Your order status has changed",
+        "source": null
+      },
+      "body": {
+        "rawValue": "Hello, your order is now processed.",
+        "source": null
+      }
+    }
+  }
+}`,
+    },
+    {
+      description:
+        "Add a generate-document action. The renderer reads the template, writes the file, and stores its id in the target FileField of the target schema.",
+      command:
+        'zinkee --json automations actions add automation-1 --type generate_document --name "Generate invoice PDF" --document-template 6c08673e-f8a6-44d2-8c91-d09eca911f8f --target-schema 68d2c7be-4392-42de-b5ae-625ad79cfc3c --target-file-field c8edbde8-a361-4e9f-a39a-2e88971f21a7',
+      raw: `{
+  "type": "generate_document",
+  "name": "Generate invoice PDF",
+  "config": {
+    "documentTemplateId": "6c08673e-f8a6-44d2-8c91-d09eca911f8f",
+    "targetSchemaId": "68d2c7be-4392-42de-b5ae-625ad79cfc3c",
+    "targetFileFieldId": "c8edbde8-a361-4e9f-a39a-2e88971f21a7"
+  }
 }`,
     },
   ]),
@@ -3569,6 +3610,32 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
     "authMode": "STORED",
     "connectionId": "connection-1"
   }
+}`,
+    },
+    {
+      description:
+        "Replace a send-message action. --to maps to fieldMapping.recipients and --message maps to fieldMapping.body; values are wrapped in {rawValue, source}.",
+      command:
+        `zinkee --json automations actions update automation-1 action-1 --type send_message --name "Notify customer" --to customer@example.com --subject "Your order status has changed" --message "Hello, your order is now processed."`,
+      raw: `{
+  "type": "send_message",
+  "name": "Notify customer",
+  "config": {
+    "fieldMapping": {
+      "recipients": {
+        "rawValue": "customer@example.com",
+        "source": null
+      },
+      "subject": {
+        "rawValue": "Your order status has changed",
+        "source": null
+      },
+      "body": {
+        "rawValue": "Hello, your order is now processed.",
+        "source": null
+      }
+    }
+  }
 }`,
     },
   ]),
@@ -3739,6 +3806,191 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
 }`,
     },
   ]),
+  "document-templates list": buildCommandExamples([
+    {
+      description:
+        "List every document template in the workspace. Each asset's link is a relative path to the asset download endpoint, ready to call without composition.",
+      command: "zinkee --json document-templates list",
+      response: `[
+  {
+    "id": "7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e",
+    "name": "Quarterly report",
+    "assets": [
+      {
+        "id": "9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f",
+        "name": "Requirements.docx",
+        "link": "/api/v2/document-templates/7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e/assets/9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f/download"
+      }
+    ],
+    "createdAt": "2026-01-15T10:00:00Z",
+    "updatedAt": "2026-01-20T14:30:00Z",
+    "createdBy": "creator@example.com",
+    "updatedBy": "updater@example.com"
+  }
+]`,
+    },
+  ]),
+  "document-templates get": buildCommandExamples([
+    {
+      description:
+        "Look up one template by UUID. The CLI filters the list endpoint locally (the backend does not expose a get-one route).",
+      command:
+        "zinkee --json document-templates get 7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e",
+      response: `{
+  "id": "7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e",
+  "name": "Quarterly report",
+  "assets": [
+    {
+      "id": "9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f",
+      "name": "Requirements.docx",
+      "link": "/api/v2/document-templates/7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e/assets/9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f/download"
+    }
+  ],
+  "createdAt": "2026-01-15T10:00:00Z",
+  "updatedAt": "2026-01-20T14:30:00Z",
+  "createdBy": "creator@example.com",
+  "updatedBy": "creator@example.com"
+}`,
+    },
+    {
+      description:
+        "Look up by exact template name. Names are unique within the workspace; ambiguity is reported as an error.",
+      command: 'zinkee --json document-templates get "Quarterly report"',
+    },
+  ]),
+  "document-templates create": buildCommandExamples([
+    {
+      description:
+        "Typical create: empty template by name. Assets are uploaded afterwards via document-templates assets add.",
+      command: 'zinkee --json document-templates create --name "Quarterly report"',
+      raw: `{
+  "name": "Quarterly report",
+  "assets": []
+}`,
+      response: `{
+  "id": "7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e",
+  "name": "Quarterly report",
+  "assets": [],
+  "createdAt": "2026-01-15T10:00:00Z",
+  "updatedAt": "2026-01-15T10:00:00Z",
+  "createdBy": "creator@example.com",
+  "updatedBy": "creator@example.com"
+}`,
+    },
+    {
+      description:
+        "Create with pre-existing asset records via --raw. Used for import/migration flows where the assets already exist elsewhere; the typical UX is to create empty and upload via assets add.",
+      command:
+        `zinkee --json document-templates create --raw '{"name":"Annual report","assets":[{"id":"9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f","name":"Cover.docx","link":"/existing/cover.docx"},{"id":"3f2e1d0c-9b8a-7654-3210-fedcba987654","name":"Appendix.docx","link":"/existing/appendix.docx"}]}'`,
+      raw: `{
+  "name": "Annual report",
+  "assets": [
+    {
+      "id": "9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f",
+      "name": "Cover.docx",
+      "link": "/existing/cover.docx"
+    },
+    {
+      "id": "3f2e1d0c-9b8a-7654-3210-fedcba987654",
+      "name": "Appendix.docx",
+      "link": "/existing/appendix.docx"
+    }
+  ]
+}`,
+    },
+  ]),
+  "document-templates update": buildCommandExamples([
+    {
+      description:
+        "Rename a template. The template argument accepts a UUID or an exact current name. Only the name is updatable through this endpoint; assets are managed via the assets subcommands.",
+      command:
+        'zinkee --json document-templates update "Quarterly report" --name "Annual report"',
+      raw: `{
+  "name": "Annual report"
+}`,
+      response: `{
+  "id": "7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e",
+  "name": "Annual report",
+  "assets": [
+    {
+      "id": "9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f",
+      "name": "Requirements.docx",
+      "link": "/api/v2/document-templates/7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e/assets/9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f/download"
+    }
+  ],
+  "createdAt": "2026-01-15T10:00:00Z",
+  "updatedAt": "2026-01-22T09:15:00Z",
+  "createdBy": "creator@example.com",
+  "updatedBy": "updater@example.com"
+}`,
+    },
+  ]),
+  "document-templates delete": buildCommandExamples([
+    {
+      description:
+        "Delete a template and remove its asset files from storage. Record fields that reference previously generated documents are not modified.",
+      command:
+        "zinkee --json document-templates delete 7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e",
+      response: `{
+  "id": "7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e",
+  "deleted": true
+}`,
+    },
+  ]),
+  "document-templates assets add": buildCommandExamples([
+    {
+      description:
+        "Upload a local file as an asset of a template. The CLI sends a multipart form with a part named \"file\"; the asset display name defaults to the uploaded filename.",
+      command:
+        'zinkee --json document-templates assets add "Quarterly report" ./contract.docx',
+      response: `{
+  "id": "7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e",
+  "name": "Quarterly report",
+  "assets": [
+    {
+      "id": "9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f",
+      "name": "contract.docx",
+      "link": "/api/v2/document-templates/7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e/assets/9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f/download"
+    }
+  ],
+  "createdAt": "2026-01-15T10:00:00Z",
+  "updatedAt": "2026-01-22T09:15:00Z",
+  "createdBy": "creator@example.com",
+  "updatedBy": "updater@example.com"
+}`,
+    },
+    {
+      description:
+        "Override the asset display name with --name (otherwise the uploaded filename is used).",
+      command:
+        'zinkee --json document-templates assets add "Quarterly report" ./contract.docx --name "Customer Contract"',
+    },
+  ]),
+  "document-templates assets delete": buildCommandExamples([
+    {
+      description: "Delete one asset from a template and remove its file from storage.",
+      command:
+        "zinkee --json document-templates assets delete 7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e 9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f",
+      response: `{
+  "id": "9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f",
+  "deleted": true
+}`,
+    },
+  ]),
+  "document-templates assets download": buildCommandExamples([
+    {
+      description:
+        "Download asset bytes to disk. The CLI streams the raw bytes to --output; in --json mode --output is required and the JSON envelope only carries metadata.",
+      command:
+        "zinkee --json document-templates assets download 7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e 9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f --output ./contract.docx",
+    },
+    {
+      description:
+        "Stream asset bytes to stdout (omit --json and --output). Useful for piping into other tools.",
+      command:
+        "zinkee document-templates assets download 7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e 9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f > contract.docx",
+    },
+  ]),
 };
 
 function fallbackExamples(commandName: string): readonly CommandExample[] {