zinkee 0.1.22 → 0.1.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zinkee",
-  "version": "0.1.22",
+  "version": "0.1.24",
   "description": "CLI for Zinkee API v2",
   "type": "module",
   "bin": {

package/src/api/document-templates.ts

@@ -0,0 +1,110 @@
+import { ApiClient } from "../client.js";
+import type { NormalizedUuidOrSlug } from "../parsers/selectors.js";
+
+export interface ApiDocumentTemplateAsset {
+  [key: string]: unknown;
+  id?: string;
+  name?: string;
+  link?: string;
+}
+
+export interface ApiDocumentTemplate {
+  [key: string]: unknown;
+  id?: string;
+  name?: string;
+  assets?: ApiDocumentTemplateAsset[];
+  createdAt?: string;
+  updatedAt?: string;
+  createdBy?: string;
+  updatedBy?: string;
+}
+
+export interface CreateDocumentTemplateInput {
+  [key: string]: unknown;
+  name: string;
+  assets?: ApiDocumentTemplateAsset[];
+}
+
+export interface UpdateDocumentTemplateInput {
+  [key: string]: unknown;
+  name?: string;
+}
+
+function jsonOptions(body: unknown, method: string): RequestInit {
+  return {
+    method,
+    headers: {
+      "content-type": "application/json",
+    },
+    body: JSON.stringify(body),
+  };
+}
+
+function selectorValue(selector: NormalizedUuidOrSlug): string {
+  return encodeURIComponent(selector.value);
+}
+
+function segment(value: string): string {
+  return encodeURIComponent(value);
+}
+
+export class DocumentTemplatesApi {
+  constructor(private readonly client: ApiClient) {}
+
+  listTemplates(): Promise<ApiDocumentTemplate[]> {
+    return this.client.getJson<ApiDocumentTemplate[]>("/api/v2/document-templates");
+  }
+
+  createTemplate(input: CreateDocumentTemplateInput): Promise<ApiDocumentTemplate> {
+    return this.client.requestJson<ApiDocumentTemplate>(
+      "/api/v2/document-templates",
+      jsonOptions(input, "POST"),
+    );
+  }
+
+  updateTemplate(
+    template: NormalizedUuidOrSlug,
+    input: UpdateDocumentTemplateInput,
+  ): Promise<ApiDocumentTemplate> {
+    return this.client.requestJson<ApiDocumentTemplate>(
+      `/api/v2/document-templates/${selectorValue(template)}`,
+      jsonOptions(input, "PATCH"),
+    );
+  }
+
+  deleteTemplate(template: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/document-templates/${selectorValue(template)}`,
+      { method: "DELETE" },
+    );
+  }
+
+  addAsset(
+    template: NormalizedUuidOrSlug,
+    input: FormData,
+  ): Promise<ApiDocumentTemplate> {
+    return this.client.requestJson<ApiDocumentTemplate>(
+      `/api/v2/document-templates/${selectorValue(template)}/assets`,
+      { method: "POST", body: input },
+    );
+  }
+
+  deleteAsset(
+    template: NormalizedUuidOrSlug,
+    assetId: string,
+  ): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/document-templates/${selectorValue(template)}/assets/${segment(assetId)}`,
+      { method: "DELETE" },
+    );
+  }
+
+  downloadAsset(
+    template: NormalizedUuidOrSlug,
+    assetId: string,
+  ): Promise<ArrayBuffer> {
+    return this.client.requestBinary(
+      `/api/v2/document-templates/${selectorValue(template)}/assets/${segment(assetId)}/download`,
+    );
+  }
+}

package/src/command-registry.ts

@@ -441,6 +441,62 @@ export const commandRegistry = {
     supportsRaw: false,
     output: writeOutput,
   },
+  "document-templates list": {
+    command: "document-templates list",
+    accessLevel: "read",
+    supportsExample: true,
+    supportsRaw: false,
+    output: readOutput,
+  },
+  "document-templates get": {
+    command: "document-templates get",
+    accessLevel: "read",
+    supportsExample: true,
+    supportsRaw: false,
+    output: readOutput,
+  },
+  "document-templates create": {
+    command: "document-templates create",
+    accessLevel: "write",
+    supportsExample: true,
+    supportsRaw: true,
+    output: writeOutput,
+  },
+  "document-templates update": {
+    command: "document-templates update",
+    accessLevel: "write",
+    supportsExample: true,
+    supportsRaw: false,
+    output: writeOutput,
+  },
+  "document-templates delete": {
+    command: "document-templates delete",
+    accessLevel: "destructive",
+    supportsExample: true,
+    supportsRaw: false,
+    output: writeOutput,
+  },
+  "document-templates assets add": {
+    command: "document-templates assets add",
+    accessLevel: "write",
+    supportsExample: true,
+    supportsRaw: false,
+    output: writeOutput,
+  },
+  "document-templates assets delete": {
+    command: "document-templates assets delete",
+    accessLevel: "destructive",
+    supportsExample: true,
+    supportsRaw: false,
+    output: writeOutput,
+  },
+  "document-templates assets download": {
+    command: "document-templates assets download",
+    accessLevel: "read",
+    supportsExample: true,
+    supportsRaw: false,
+    output: "binary",
+  },
   "files upload": {
     command: "files upload",
     accessLevel: "write",

package/src/commands/automations.test.ts

@@ -449,6 +449,136 @@ describe("automations commands", () => {
     });
   });
 
+  it("builds send_message actions with wrapped fieldMapping (recipients/subject/body)", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(jsonResponse({ id: "action-1" }));
+    const program = buildAutomationsProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "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.",
+    ]);
+
+    expect(JSON.parse(String(fetchMock.mock.calls[0]?.[1]?.body))).toEqual({
+      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,
+          },
+        },
+      },
+    });
+  });
+
+  it("wraps send_message --map values in {rawValue, source} like other field mappings", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(jsonResponse({ id: "action-1" }));
+    const program = buildAutomationsProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "automations",
+      "actions",
+      "add",
+      "automation-1",
+      "--type",
+      "send_message",
+      "--name",
+      "Notify customer",
+      "--to",
+      "customer@example.com",
+      "--map-json",
+      'metadata={"orderId":"ORD-1"}',
+    ]);
+
+    expect(JSON.parse(String(fetchMock.mock.calls[0]?.[1]?.body))).toEqual({
+      type: "send_message",
+      name: "Notify customer",
+      config: {
+        fieldMapping: {
+          recipients: {
+            rawValue: "customer@example.com",
+            source: null,
+          },
+          metadata: {
+            rawValue: { orderId: "ORD-1" },
+            source: null,
+          },
+        },
+      },
+    });
+  });
+
+  it("builds generate_document actions with template, schema, and file-field ids", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(jsonResponse({ id: "action-1" }));
+    const program = buildAutomationsProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "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",
+    ]);
+
+    expect(JSON.parse(String(fetchMock.mock.calls[0]?.[1]?.body))).toEqual({
+      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",
+      },
+    });
+  });
+
   it("rejects source-based trigger conditions", async () => {
     const configPath = createApiConfig();
     const output = createStdoutBuffer();

package/src/commands/automations.ts

@@ -107,6 +107,11 @@ interface ActionMutationCommandOptions {
   plugin?: string;
   arg?: string[];
   argJson?: string[];
+  to?: string;
+  subject?: string;
+  message?: string;
+  documentTemplate?: string;
+  targetFileField?: string;
   raw?: string;
   rawFile?: string;
 }
@@ -1016,6 +1021,18 @@ function buildActionInput(
     config.targetSchemaId = options.targetSchema;
   }
 
+  if (options.to !== undefined) {
+    mappings.recipients = options.to;
+  }
+
+  if (options.subject !== undefined) {
+    mappings.subject = options.subject;
+  }
+
+  if (options.message !== undefined) {
+    mappings.body = options.message;
+  }
+
   if (!isEmptyObject(mappings)) {
     config.fieldMapping = mappings;
   }
@@ -1073,6 +1090,14 @@ function buildActionInput(
     config.pluginArgs = args;
   }
 
+  if (options.documentTemplate !== undefined) {
+    config.documentTemplateId = options.documentTemplate;
+  }
+
+  if (options.targetFileField !== undefined) {
+    config.targetFileFieldId = options.targetFileField;
+  }
+
   if (!isEmptyObject(config)) {
     if (isJsonObject(config.fieldMapping)) {
       config.fieldMapping = normalizeAutomationFieldMapping(
@@ -1319,9 +1344,26 @@ function addTriggerPayloadOptions(command: Command): Command {
     .option("--raw-file <path>", "path to raw trigger JSON payload");
 }
 
+const ACTION_TYPES_HELP = `
+Action types and their flags:
+  create_record      --target-schema, --map, --map-json
+  update_record      --target-schema, --use-trigger-record, --map,
+                     --condition, --condition-json
+  search_records     --target-schema, --condition, --condition-json
+  send_message       --to, --subject, --message
+                     (--map / --map-json also accepted for extra keys)
+  http_request       --method, --url, --header, --body, --content-type,
+                     --timeout-ms, --var, --auth-mode, --connection
+  execute_plugin     --plugin, --arg, --arg-json
+  generate_document  --document-template, --target-schema, --target-file-field
+`;
+
 function addActionPayloadOptions(command: Command): Command {
   return command
-    .option("--type <type>", "action type")
+    .option(
+      "--type <type>",
+      "action type (create_record|update_record|search_records|send_message|http_request|execute_plugin|generate_document)",
+    )
     .option("--name <name>", "action name")
     .option("--target-schema <uuid>", "target schema id")
     .option("--map <field=value>", "field mapping", collectValues, [])
@@ -1346,8 +1388,14 @@ function addActionPayloadOptions(command: Command): Command {
     .option("--plugin <id>", "plugin id for execute_plugin")
     .option("--arg <key=value>", "plugin argument", collectValues, [])
     .option("--arg-json <key=json>", "plugin argument as JSON", collectValues, [])
+    .option("--to <recipient>", "send_message recipient (maps to fieldMapping.recipients)")
+    .option("--subject <text>", "send_message subject")
+    .option("--message <text>", "send_message body text (maps to fieldMapping.body)")
+    .option("--document-template <uuid>", "generate_document template id")
+    .option("--target-file-field <uuid>", "generate_document target FileField id")
     .option("--raw <json>", "raw action JSON payload")
-    .option("--raw-file <path>", "path to raw action JSON payload");
+    .option("--raw-file <path>", "path to raw action JSON payload")
+    .addHelpText("after", ACTION_TYPES_HELP);
 }
 
 export function registerAutomationsCommands(