zinkee 0.1.44 → 0.1.45

package/src/commands/document-templates.test.ts

@@ -1,569 +0,0 @@
-import { mkdtempSync, readFileSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-
-import { Command } from "commander";
-import { afterEach, describe, expect, it, vi } from "vitest";
-
-import { registerDocumentTemplatesCommands } from "./document-templates.js";
-
-const TEMPLATE_ID = "7c4a8d3f-1b2e-4a5c-9d6e-1f2a3b4c5d6e";
-const ASSET_ID = "9e8d7c6b-5a4f-3e2d-1c0b-9a8b7c6d5e4f";
-
-function createTempConfig(contents: string): string {
-  const dir = mkdtempSync(join(tmpdir(), "zinkee-document-templates-"));
-  const filePath = join(dir, "config.toml");
-  writeFileSync(filePath, contents, "utf8");
-  return filePath;
-}
-
-function createApiConfig(): string {
-  return createTempConfig(`
-default_profile = "prod"
-
-[profiles.prod]
-api_key = "document-templates-token-1234"
-base_url = "https://api.zinkee.test"
-`);
-}
-
-function createStdoutBuffer() {
-  const chunks: Buffer[] = [];
-
-  return {
-    stdout: {
-      write(chunk: string | Uint8Array) {
-        chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
-        return true;
-      },
-    },
-    readText() {
-      return Buffer.concat(chunks).toString("utf8");
-    },
-    readBytes() {
-      return Buffer.concat(chunks);
-    },
-  };
-}
-
-function jsonResponse(body: unknown, status: number = 200): Response {
-  return new Response(JSON.stringify(body), {
-    status,
-    headers: { "content-type": "application/json" },
-  });
-}
-
-function binaryResponse(bytes: number[], status: number = 200): Response {
-  return new Response(new Uint8Array(bytes), {
-    status,
-    headers: { "content-type": "application/octet-stream" },
-  });
-}
-
-function createFetchMock() {
-  const fetchMock = vi.fn<typeof fetch>();
-  vi.stubGlobal("fetch", fetchMock);
-  return fetchMock;
-}
-
-function createProgram(): Command {
-  return new Command()
-    .enablePositionalOptions()
-    .option("--profile <name>", "select a profile from config")
-    .option("--base-url <url>", "override the configured base URL")
-    .option("--api-key <token>", "override the configured API key")
-    .option("--read-only", "run in read-only mode")
-    .option("--json", "emit JSON output");
-}
-
-function templateFixture(overrides: Record<string, unknown> = {}): Record<string, unknown> {
-  return {
-    id: TEMPLATE_ID,
-    name: "Quarterly report",
-    assets: [
-      {
-        id: ASSET_ID,
-        name: "Requirements.docx",
-        link: `/api/v2/document-templates/${TEMPLATE_ID}/assets/${ASSET_ID}/download`,
-      },
-    ],
-    createdAt: "2026-01-15T10:00:00Z",
-    updatedAt: "2026-01-20T14:30:00Z",
-    createdBy: "creator@example.com",
-    updatedBy: "updater@example.com",
-    ...overrides,
-  };
-}
-
-afterEach(() => {
-  vi.unstubAllGlobals();
-  vi.restoreAllMocks();
-});
-
-describe("document-templates commands", () => {
-  it("registers the document-templates command group", () => {
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program);
-
-    expect(program.commands.some((command) => command.name() === "document-templates")).toBe(true);
-  });
-
-  it("lists document templates as JSON", async () => {
-    const configPath = createApiConfig();
-    const output = createStdoutBuffer();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(jsonResponse([templateFixture()]));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath, stdout: output.stdout });
-
-    await program.parseAsync(["node", "zinkee", "--json", "document-templates", "list"]);
-
-    expect(fetchMock.mock.calls[0]?.[0]).toBe("https://api.zinkee.test/api/v2/document-templates");
-    expect(JSON.parse(output.readText())).toEqual({
-      data: [templateFixture()],
-      meta: { command: "document-templates list", configPath },
-    });
-  });
-
-  it("gets a template by UUID by filtering the list response", async () => {
-    const configPath = createApiConfig();
-    const output = createStdoutBuffer();
-    const fetchMock = createFetchMock();
-    const target = templateFixture();
-    const other = templateFixture({ id: "11111111-1111-4111-a111-111111111111", name: "Another" });
-    fetchMock.mockResolvedValueOnce(jsonResponse([other, target]));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath, stdout: output.stdout });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "--json",
-      "document-templates",
-      "get",
-      TEMPLATE_ID,
-    ]);
-
-    expect(JSON.parse(output.readText()).data).toEqual(target);
-  });
-
-  it("gets a template by exact name", async () => {
-    const configPath = createApiConfig();
-    const output = createStdoutBuffer();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(jsonResponse([templateFixture()]));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath, stdout: output.stdout });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "--json",
-      "document-templates",
-      "get",
-      "Quarterly report",
-    ]);
-
-    expect(JSON.parse(output.readText()).data.id).toBe(TEMPLATE_ID);
-  });
-
-  it("fails when the template name is ambiguous", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(
-      jsonResponse([
-        templateFixture({ id: "aaaaaaaa-1111-4111-a111-111111111111" }),
-        templateFixture({ id: "bbbbbbbb-2222-4222-a222-222222222222" }),
-      ]),
-    );
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    await expect(
-      program.parseAsync([
-        "node",
-        "zinkee",
-        "document-templates",
-        "get",
-        "Quarterly report",
-      ]),
-    ).rejects.toThrowError('Document template "Quarterly report" is ambiguous. Found 2 matches.');
-  });
-
-  it("creates a template with an empty assets array by default", async () => {
-    const configPath = createApiConfig();
-    const output = createStdoutBuffer();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(jsonResponse(templateFixture({ assets: [] })));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath, stdout: output.stdout });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "--json",
-      "document-templates",
-      "create",
-      "--name",
-      "Quarterly report",
-    ]);
-
-    const [url, init] = fetchMock.mock.calls[0] ?? [];
-    expect(url).toBe("https://api.zinkee.test/api/v2/document-templates");
-    expect(init?.method).toBe("POST");
-    expect(JSON.parse(String(init?.body))).toEqual({
-      name: "Quarterly report",
-      assets: [],
-    });
-  });
-
-  it("creates a template with pre-existing assets via --raw", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(jsonResponse(templateFixture()));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    const rawPayload = {
-      name: "Annual report",
-      assets: [{ id: ASSET_ID, name: "Cover.docx", link: "/existing/cover.docx" }],
-    };
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "--json",
-      "document-templates",
-      "create",
-      "--raw",
-      JSON.stringify(rawPayload),
-    ]);
-
-    expect(JSON.parse(String(fetchMock.mock.calls[0]?.[1]?.body))).toEqual(rawPayload);
-  });
-
-  it("rejects create without --name", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    await expect(
-      program.parseAsync(["node", "zinkee", "document-templates", "create"]),
-    ).rejects.toThrowError('Provide template name via "--name".');
-
-    expect(fetchMock).not.toHaveBeenCalled();
-  });
-
-  it("resolves a template by name and patches the name", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    fetchMock
-      .mockResolvedValueOnce(jsonResponse([templateFixture()]))
-      .mockResolvedValueOnce(jsonResponse(templateFixture({ name: "Annual report" })));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "--json",
-      "document-templates",
-      "update",
-      "Quarterly report",
-      "--name",
-      "Annual report",
-    ]);
-
-    expect(fetchMock.mock.calls[1]?.[0]).toBe(
-      `https://api.zinkee.test/api/v2/document-templates/${TEMPLATE_ID}`,
-    );
-    expect(fetchMock.mock.calls[1]?.[1]?.method).toBe("PATCH");
-    expect(JSON.parse(String(fetchMock.mock.calls[1]?.[1]?.body))).toEqual({
-      name: "Annual report",
-    });
-  });
-
-  it("rejects update with no fields", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    await expect(
-      program.parseAsync([
-        "node",
-        "zinkee",
-        "document-templates",
-        "update",
-        TEMPLATE_ID,
-      ]),
-    ).rejects.toThrowError('Provide template updates via "--name".');
-
-    expect(fetchMock).not.toHaveBeenCalled();
-  });
-
-  it("deletes a template by UUID", async () => {
-    const configPath = createApiConfig();
-    const output = createStdoutBuffer();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(jsonResponse({ id: TEMPLATE_ID, deleted: true }));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath, stdout: output.stdout });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "--json",
-      "document-templates",
-      "delete",
-      TEMPLATE_ID,
-    ]);
-
-    expect(fetchMock.mock.calls[0]?.[0]).toBe(
-      `https://api.zinkee.test/api/v2/document-templates/${TEMPLATE_ID}`,
-    );
-    expect(fetchMock.mock.calls[0]?.[1]?.method).toBe("DELETE");
-    expect(JSON.parse(output.readText()).data).toEqual({ id: TEMPLATE_ID, deleted: true });
-  });
-
-  it("adds an asset through multipart with --name override", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(jsonResponse(templateFixture()));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    const tempDir = mkdtempSync(join(tmpdir(), "zinkee-document-templates-upload-"));
-    const localPath = join(tempDir, "contract.docx");
-    writeFileSync(localPath, "binary-bytes", "utf8");
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "--json",
-      "document-templates",
-      "assets",
-      "add",
-      TEMPLATE_ID,
-      localPath,
-      "--name",
-      "Customer Contract",
-    ]);
-
-    const [url, init] = fetchMock.mock.calls[0] ?? [];
-    expect(url).toBe(
-      `https://api.zinkee.test/api/v2/document-templates/${TEMPLATE_ID}/assets`,
-    );
-    expect(init?.method).toBe("POST");
-
-    const body = init?.body as FormData;
-    const filePart = body.get("file");
-    expect(filePart).toBeInstanceOf(File);
-    if (!(filePart instanceof File)) {
-      throw new Error("Expected the asset upload to send a File.");
-    }
-    expect(filePart.name).toBe("contract.docx");
-    expect(Buffer.from(await filePart.arrayBuffer()).toString("utf8")).toBe("binary-bytes");
-    expect(body.get("name")).toBe("Customer Contract");
-  });
-
-  it("does not append --name when not provided", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(jsonResponse(templateFixture()));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    const tempDir = mkdtempSync(join(tmpdir(), "zinkee-document-templates-upload-"));
-    const localPath = join(tempDir, "contract.docx");
-    writeFileSync(localPath, "binary-bytes", "utf8");
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "document-templates",
-      "assets",
-      "add",
-      TEMPLATE_ID,
-      localPath,
-    ]);
-
-    const body = fetchMock.mock.calls[0]?.[1]?.body as FormData;
-    expect(body.get("name")).toBeNull();
-  });
-
-  it("deletes one asset", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(jsonResponse({ id: ASSET_ID, deleted: true }));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "document-templates",
-      "assets",
-      "delete",
-      TEMPLATE_ID,
-      ASSET_ID,
-    ]);
-
-    expect(fetchMock.mock.calls[0]?.[0]).toBe(
-      `https://api.zinkee.test/api/v2/document-templates/${TEMPLATE_ID}/assets/${ASSET_ID}`,
-    );
-    expect(fetchMock.mock.calls[0]?.[1]?.method).toBe("DELETE");
-  });
-
-  it("downloads asset bytes to stdout when no --output is provided", async () => {
-    const configPath = createApiConfig();
-    const output = createStdoutBuffer();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(binaryResponse([104, 101, 108, 108, 111]));
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath, stdout: output.stdout });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "document-templates",
-      "assets",
-      "download",
-      TEMPLATE_ID,
-      ASSET_ID,
-    ]);
-
-    expect(fetchMock.mock.calls[0]?.[0]).toBe(
-      `https://api.zinkee.test/api/v2/document-templates/${TEMPLATE_ID}/assets/${ASSET_ID}/download`,
-    );
-    expect(output.readBytes().equals(Buffer.from("hello"))).toBe(true);
-  });
-
-  it("downloads asset bytes to disk and emits a JSON envelope", async () => {
-    const configPath = createApiConfig();
-    const output = createStdoutBuffer();
-    const fetchMock = createFetchMock();
-    fetchMock.mockResolvedValueOnce(binaryResponse([1, 2, 3]));
-    const tempDir = mkdtempSync(join(tmpdir(), "zinkee-document-templates-download-"));
-    const outputPath = join(tempDir, "downloaded.bin");
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath, stdout: output.stdout });
-
-    await program.parseAsync([
-      "node",
-      "zinkee",
-      "--json",
-      "document-templates",
-      "assets",
-      "download",
-      TEMPLATE_ID,
-      ASSET_ID,
-      "--output",
-      outputPath,
-    ]);
-
-    expect(readFileSync(outputPath)).toEqual(Buffer.from([1, 2, 3]));
-    expect(JSON.parse(output.readText())).toEqual({
-      data: {
-        template: TEMPLATE_ID,
-        asset: ASSET_ID,
-        output: outputPath,
-        bytes: 3,
-      },
-      meta: { command: "document-templates assets download", configPath },
-    });
-  });
-
-  it("requires --output when downloading with --json", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    await expect(
-      program.parseAsync([
-        "node",
-        "zinkee",
-        "--json",
-        "document-templates",
-        "assets",
-        "download",
-        TEMPLATE_ID,
-        ASSET_ID,
-      ]),
-    ).rejects.toThrowError(
-      'Provide "--output" when using "--json" with "document-templates assets download".',
-    );
-
-    expect(fetchMock).not.toHaveBeenCalled();
-  });
-
-  it("blocks create in read-only mode", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    await expect(
-      program.parseAsync([
-        "node",
-        "zinkee",
-        "--read-only",
-        "document-templates",
-        "create",
-        "--name",
-        "Quarterly report",
-      ]),
-    ).rejects.toThrowError('Command "document-templates create" is not allowed in read-only mode.');
-
-    expect(fetchMock).not.toHaveBeenCalled();
-  });
-
-  it("blocks delete in read-only mode", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    await expect(
-      program.parseAsync([
-        "node",
-        "zinkee",
-        "--read-only",
-        "document-templates",
-        "delete",
-        TEMPLATE_ID,
-      ]),
-    ).rejects.toThrowError('Command "document-templates delete" is not allowed in read-only mode.');
-
-    expect(fetchMock).not.toHaveBeenCalled();
-  });
-
-  it("blocks asset uploads in read-only mode", async () => {
-    const configPath = createApiConfig();
-    const fetchMock = createFetchMock();
-    const tempDir = mkdtempSync(join(tmpdir(), "zinkee-document-templates-upload-ro-"));
-    const localPath = join(tempDir, "contract.docx");
-    writeFileSync(localPath, "binary-bytes", "utf8");
-    const program = createProgram();
-    registerDocumentTemplatesCommands(program, { configPath });
-
-    await expect(
-      program.parseAsync([
-        "node",
-        "zinkee",
-        "--read-only",
-        "document-templates",
-        "assets",
-        "add",
-        TEMPLATE_ID,
-        localPath,
-      ]),
-    ).rejects.toThrowError(
-      'Command "document-templates assets add" is not allowed in read-only mode.',
-    );
-
-    expect(fetchMock).not.toHaveBeenCalled();
-  });
-});