zinkee 0.1.24 → 0.1.26

package/package.json

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

package/src/api/automations.ts

@@ -180,7 +180,7 @@ export class AutomationsApi {
 
   moveAutomation(input: MoveAutomationInput): Promise<Record<string, unknown>> {
     return this.client.requestJson<Record<string, unknown>>(
-      `/api/v2/automation-folders/${segment(input.targetFolderId)}/automations:move`,
+      "/api/v2/automation-folders/automations:move",
       jsonOptions(input, "POST"),
     );
   }

package/src/api/displays.ts

@@ -45,6 +45,19 @@ export interface ApiDisplayNavigationTarget {
   label?: string;
 }
 
+export interface ApiDisplayFolder {
+  [key: string]: unknown;
+  id?: string;
+  name?: string | null;
+  isRoot?: boolean;
+  displayCount?: number;
+}
+
+export interface MoveDisplayInput {
+  displayId: string;
+  targetFolderId: string;
+}
+
 export type DisplaySummary = ApiDisplay;
 export type DisplayResource = ApiDisplay;
 
@@ -273,4 +286,39 @@ export class DisplaysApi {
       { method: "DELETE" },
     );
   }
+
+  listFolders(): Promise<ApiDisplayFolder[]> {
+    return this.client.getJson<ApiDisplayFolder[]>("/api/v2/display-folders");
+  }
+
+  createFolder(body: Record<string, unknown>): Promise<ApiDisplayFolder> {
+    return this.client.requestJson<ApiDisplayFolder>(
+      "/api/v2/display-folders",
+      jsonOptions(body, "POST"),
+    );
+  }
+
+  updateFolder(
+    folder: NormalizedUuidOrSlug,
+    body: Record<string, unknown>,
+  ): Promise<ApiDisplayFolder> {
+    return this.client.requestJson<ApiDisplayFolder>(
+      `/api/v2/display-folders/${selectorValue(folder)}`,
+      jsonOptions(body, "PATCH"),
+    );
+  }
+
+  deleteFolder(folder: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/display-folders/${selectorValue(folder)}`,
+      { method: "DELETE" },
+    );
+  }
+
+  moveDisplay(input: MoveDisplayInput): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      "/api/v2/display-folders/displays:move",
+      jsonOptions(input, "POST"),
+    );
+  }
 }

package/src/api/navigation.ts

@@ -16,7 +16,6 @@ export interface NavigationFolderMutation {
 
 export interface NavigationMoveResourceInput {
   resourceId: string;
-  resourceType: string;
   targetFolderId: string;
 }
 

package/src/command-registry.ts

@@ -280,6 +280,41 @@ export const commandRegistry = {
     supportsRaw: false,
     output: writeOutput,
   },
+  "displays folders list": {
+    command: "displays folders list",
+    accessLevel: "read",
+    supportsExample: true,
+    supportsRaw: false,
+    output: readOutput,
+  },
+  "displays folders create": {
+    command: "displays folders create",
+    accessLevel: "write",
+    supportsExample: true,
+    supportsRaw: false,
+    output: writeOutput,
+  },
+  "displays folders update": {
+    command: "displays folders update",
+    accessLevel: "write",
+    supportsExample: true,
+    supportsRaw: false,
+    output: writeOutput,
+  },
+  "displays folders delete": {
+    command: "displays folders delete",
+    accessLevel: "destructive",
+    supportsExample: true,
+    supportsRaw: false,
+    output: writeOutput,
+  },
+  "displays folders move": {
+    command: "displays folders move",
+    accessLevel: "write",
+    supportsExample: true,
+    supportsRaw: false,
+    output: writeOutput,
+  },
   "displays layout get": {
     command: "displays layout get",
     accessLevel: "read",

package/src/commands/automations.test.ts

@@ -87,6 +87,38 @@ describe("automations commands", () => {
     expect(program.commands.some((command) => command.name() === "automations")).toBe(true);
   });
 
+  it("moves an automation with the folder id in the body, not the path", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({ id: "folder-1", name: "Ops", isRoot: false }),
+    );
+    const program = buildAutomationsProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "automations",
+      "folders",
+      "move",
+      "11111111-1111-4111-a111-111111111111",
+      "--to",
+      "22222222-2222-4222-a222-222222222222",
+    ]);
+
+    expect(fetchMock.mock.calls[0]?.[0]).toBe(
+      "https://api.zinkee.test/api/v2/automation-folders/automations:move",
+    );
+    const init = fetchMock.mock.calls[0]?.[1];
+    expect(init?.method).toBe("POST");
+    expect(JSON.parse(String(init?.body))).toEqual({
+      automationId: "11111111-1111-4111-a111-111111111111",
+      targetFolderId: "22222222-2222-4222-a222-222222222222",
+    });
+  });
+
   it("sets trigger payloads through the generic trigger flags", async () => {
     const configPath = createApiConfig();
     const output = createStdoutBuffer();

package/src/commands/automations.ts

@@ -1408,11 +1408,13 @@ export function registerAutomationsCommands(
     .command("automations")
     .description("Manage automations, triggers, actions, and connections");
 
-  const folders = automations.command("folders").description("Manage automation folders");
+  const folders = automations
+    .command("folders")
+    .description("Manage automation folders (flat: a folder only has a name, no order or properties)");
 
   folders
     .command("list")
-    .description("List automation folders")
+    .description("List automation folders (non-root folders plus the root bucket, whose name is null)")
     .action(async function action(this: Command) {
       const { api, json } = createAutomationsApi(this, filePath);
       const data = await api.listFolders();
@@ -1500,7 +1502,11 @@ export function registerAutomationsCommands(
     .command("move")
     .description("Move an automation into a folder")
     .argument("<automation>", "automation UUID", parseUuidOrSlugSelector)
-    .requiredOption("--to <folder>", "target folder UUID or exact name", parseUuidOrSlugSelector)
+    .requiredOption(
+      "--to <folder>",
+      "target folder UUID or exact name (use the root folder to move it out of any folder)",
+      parseUuidOrSlugSelector,
+    )
     .action(async function action(
       this: Command,
       automation: NormalizedUuidOrSlug,

package/src/commands/displays.test.ts

@@ -252,6 +252,243 @@ describe("displays commands", () => {
     });
   });
 
+  it("builds KANBAN viewState fieldMapping, cardConfig and aggregation from flags", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(jsonResponse({ displayId: "display-1", widgetId: "widget-k1" }));
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "displays",
+      "widgets",
+      "create",
+      "display-1",
+      "--type",
+      "kanban",
+      "--field",
+      "name-uuid",
+      "--column-field",
+      "status-uuid",
+      "--swimlane-field",
+      "owner-uuid",
+      "--card-title-field",
+      "name-uuid",
+      "--card-category3-field",
+      "amount-uuid",
+      "--aggregation-method",
+      "sum",
+      "--aggregation-field",
+      "amount-uuid",
+      "--view-state",
+      '{"showNoValueColumn":true,"hideEmptyColumns":false}',
+    ]);
+
+    const init = fetchMock.mock.calls[0]?.[1];
+    expect(JSON.parse(String(init?.body))).toMatchObject({
+      type: "KANBAN",
+      view: {
+        fields: ["name-uuid"],
+        viewAdditionalProperties: {
+          viewState: {
+            showNoValueColumn: true,
+            hideEmptyColumns: false,
+            fieldMapping: {
+              columnField: "status-uuid",
+              swimlaneField: "owner-uuid",
+              cardConfig: { titleField: "name-uuid", category3Field: "amount-uuid" },
+              aggregationConfig: { method: "sum", fieldId: "amount-uuid" },
+            },
+          },
+        },
+      },
+    });
+  });
+
+  it("builds TIMELINE viewState fieldMapping with category4 from flags", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(jsonResponse({ displayId: "display-1", widgetId: "widget-t1" }));
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "displays",
+      "widgets",
+      "create",
+      "display-1",
+      "--type",
+      "timeline",
+      "--start-date-field",
+      "start-uuid",
+      "--end-date-field",
+      "end-uuid",
+      "--label-field",
+      "name-uuid",
+      "--card-category4-field",
+      "amount-uuid",
+      "--view-state",
+      '{"granularity":"month","sidebarWidth":300}',
+    ]);
+
+    const init = fetchMock.mock.calls[0]?.[1];
+    expect(JSON.parse(String(init?.body))).toMatchObject({
+      type: "TIMELINE",
+      view: {
+        viewAdditionalProperties: {
+          viewState: {
+            granularity: "month",
+            sidebarWidth: 300,
+            fieldMapping: {
+              startDateField: "start-uuid",
+              endDateField: "end-uuid",
+              labelField: "name-uuid",
+              cardConfig: { category4Field: "amount-uuid" },
+            },
+          },
+        },
+      },
+    });
+  });
+
+  it("builds HIERARCHY hierarchyConfig from columns, root and child flags", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(jsonResponse({ displayId: "display-1", widgetId: "widget-h1" }));
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "displays",
+      "widgets",
+      "create",
+      "display-1",
+      "--type",
+      "hierarchy",
+      "--hierarchy-label",
+      "Name",
+      "--hierarchy-info",
+      "col-info-status:Status",
+      "--hierarchy-number",
+      "col-num-amount:Total amount:sum",
+      "--hierarchy-root-name",
+      "Customers",
+      "--hierarchy-root-label-field",
+      "name-uuid",
+      "--hierarchy-root-info",
+      "col-info-status:status-uuid",
+      "--hierarchy-root-number",
+      "col-num-amount:amount-uuid",
+      "--hierarchy-child",
+      '{"name":"Projects","schemaId":"projects-uuid","childFieldId":"child-uuid","labelFieldId":"project-name-uuid","infoMappings":[],"numberMappings":[{"columnId":"col-num-amount","fieldId":"project-amount-uuid"}]}',
+    ]);
+
+    const init = fetchMock.mock.calls[0]?.[1];
+    expect(JSON.parse(String(init?.body))).toMatchObject({
+      type: "HIERARCHY",
+      view: {
+        hierarchyConfig: {
+          columns: {
+            label: "Name",
+            infos: [{ id: "col-info-status", name: "Status" }],
+            numbers: [{ id: "col-num-amount", name: "Total amount", aggregation: "SUM" }],
+          },
+          rootLevel: {
+            name: "Customers",
+            labelFieldId: "name-uuid",
+            infoMappings: [{ columnId: "col-info-status", fieldId: "status-uuid" }],
+            numberMappings: [{ columnId: "col-num-amount", fieldId: "amount-uuid" }],
+          },
+          childLevels: [
+            {
+              name: "Projects",
+              schemaId: "projects-uuid",
+              childFieldId: "child-uuid",
+              labelFieldId: "project-name-uuid",
+              infoMappings: [],
+              numberMappings: [{ columnId: "col-num-amount", fieldId: "project-amount-uuid" }],
+            },
+          ],
+        },
+      },
+    });
+  });
+
+  it("deep merges KANBAN flags over view state coming from --raw", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(jsonResponse({ displayId: "display-1", widgetId: "widget-k2" }));
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "displays",
+      "widgets",
+      "create",
+      "display-1",
+      "--type",
+      "kanban",
+      "--raw",
+      '{"view":{"viewAdditionalProperties":{"viewState":{"columnOrder":["a","b"],"fieldMapping":{"columnField":"old-uuid","cardConfig":{"titleField":"name-uuid"}}}}}}',
+      "--column-field",
+      "status-uuid",
+      "--card-category1-field",
+      "status-uuid",
+    ]);
+
+    const init = fetchMock.mock.calls[0]?.[1];
+    expect(JSON.parse(String(init?.body))).toMatchObject({
+      type: "KANBAN",
+      view: {
+        viewAdditionalProperties: {
+          viewState: {
+            columnOrder: ["a", "b"],
+            fieldMapping: {
+              columnField: "status-uuid",
+              cardConfig: { titleField: "name-uuid", category1Field: "status-uuid" },
+            },
+          },
+        },
+      },
+    });
+  });
+
+  it("rejects --hierarchy-number with an invalid aggregation", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await expect(
+      program.parseAsync([
+        "node",
+        "zinkee",
+        "--json",
+        "displays",
+        "widgets",
+        "create",
+        "display-1",
+        "--type",
+        "hierarchy",
+        "--hierarchy-number",
+        "col-num-amount:Total:BOGUS",
+      ]),
+    ).rejects.toThrow(/aggregation/i);
+    expect(fetchMock).not.toHaveBeenCalled();
+  });
+
   it("translates --filter into the structured display filter contract", async () => {
     const configPath = createApiConfig();
     const output = createStdoutBuffer();
@@ -486,4 +723,78 @@ describe("displays commands", () => {
 
     expect(fetchMock).not.toHaveBeenCalled();
   });
+
+  it("creates a display folder with just a name", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({ id: "folder-1", name: "Executive Dashboards", isRoot: false, displayCount: 0 }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "displays",
+      "folders",
+      "create",
+      "--name",
+      "Executive Dashboards",
+    ]);
+
+    expect(fetchMock.mock.calls[0]?.[0]).toBe("https://api.zinkee.test/api/v2/display-folders");
+    const init = fetchMock.mock.calls[0]?.[1];
+    expect(init?.method).toBe("POST");
+    expect(JSON.parse(String(init?.body))).toEqual({ name: "Executive Dashboards" });
+  });
+
+  it("moves a display into a folder resolved by name", async () => {
+    const configPath = createApiConfig();
+    const output = createStdoutBuffer();
+    const fetchMock = createFetchMock();
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse([{ id: "folder-1", name: "Executive Dashboards", isRoot: false, displayCount: 2 }]),
+    );
+    fetchMock.mockResolvedValueOnce(
+      jsonResponse({ id: "folder-1", name: "Executive Dashboards", isRoot: false }),
+    );
+    const program = buildProgram({ configPath, stdout: output.stdout });
+
+    await program.parseAsync([
+      "node",
+      "zinkee",
+      "--json",
+      "displays",
+      "folders",
+      "move",
+      "0f6f062f-1478-4df2-96a1-c495d037d260",
+      "--to",
+      "Executive Dashboards",
+    ]);
+
+    expect(fetchMock.mock.calls[0]?.[0]).toBe("https://api.zinkee.test/api/v2/display-folders");
+    expect(fetchMock.mock.calls[1]?.[0]).toBe(
+      "https://api.zinkee.test/api/v2/display-folders/displays:move",
+    );
+    const moveInit = fetchMock.mock.calls[1]?.[1];
+    expect(moveInit?.method).toBe("POST");
+    expect(JSON.parse(String(moveInit?.body))).toEqual({
+      displayId: "0f6f062f-1478-4df2-96a1-c495d037d260",
+      targetFolderId: "folder-1",
+    });
+  });
+
+  it("blocks destructive display folder commands in read-only mode", async () => {
+    const configPath = createApiConfig();
+    const fetchMock = createFetchMock();
+    const program = buildProgram({ configPath });
+
+    await expect(
+      program.parseAsync(["node", "zinkee", "--read-only", "displays", "folders", "delete", "folder-1"]),
+    ).rejects.toThrowError('Command "displays folders delete" is not allowed in read-only mode.');
+
+    expect(fetchMock).not.toHaveBeenCalled();
+  });
 });