@zapier/zapier-sdk 0.13.5 → 0.13.7

package/src/plugins/listInputFields/index.test.ts

@@ -1,439 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import {
-  ZapierValidationError,
-  ZapierConfigurationError,
-  ZapierApiError,
-} from "../../types/errors";
-import { listInputFieldsPlugin } from "./index";
-import { getActionPlugin } from "../getAction";
-import { getAppPlugin } from "../getApp";
-import { listActionsPlugin } from "../listActions";
-import { listAppsPlugin } from "../listApps";
-import { createSdk } from "../../sdk";
-import type { ApiClient } from "../../api";
-import type { ListInputFieldsOptions } from "./schemas";
-import type { NeedsResponse, Need } from "../../api/types";
-
-const mockNeeds: Need[] = [
-  {
-    key: "message",
-    label: "Message",
-    help_text: "The message to send",
-    required: true,
-    type: "string",
-    placeholder: "Enter your message",
-    default: "",
-  },
-  {
-    key: "channel",
-    label: "Channel",
-    help_text: "The channel to send to",
-    required: true,
-    type: "string",
-    choices: [
-      { value: "#general", label: "General", sample: "#general" },
-      { value: "#random", label: "Random", sample: "#random" },
-    ],
-  },
-  {
-    key: "tags",
-    label: "Tags",
-    help_text: "List of tags",
-    type: "string",
-    list: true,
-  },
-];
-
-const mockNeedsResponse: NeedsResponse = {
-  success: true,
-  needs: mockNeeds,
-};
-
-const mockActionsResponse = {
-  results: [
-    {
-      slug: "slack",
-      selected_api: "slack",
-      actions: [
-        {
-          key: "send_message",
-          name: "Send Message",
-          description: "Send a message to a channel",
-          type_of: "write",
-          type: "write",
-          id: "core:12345",
-        },
-      ],
-    },
-  ],
-  meta: {
-    next_cursor: null,
-  },
-};
-
-describe("listInputFields plugin", () => {
-  let mockApiClient: ApiClient;
-  let mockGetVersionedImplementationId: any;
-
-  beforeEach(() => {
-    vi.clearAllMocks();
-    mockApiClient = {
-      get: vi.fn().mockResolvedValue(mockActionsResponse),
-      post: vi.fn().mockResolvedValue(mockNeedsResponse),
-    } as Partial<ApiClient> as ApiClient;
-
-    mockGetVersionedImplementationId = vi
-      .fn()
-      .mockResolvedValue("SlackCLIAPI@1.21.1");
-  });
-
-  function createTestSdk() {
-    return createSdk(
-      {},
-      {},
-      {
-        api: mockApiClient,
-        meta: {},
-        getVersionedImplementationId: mockGetVersionedImplementationId,
-      },
-    )
-      .addPlugin(listAppsPlugin as any)
-      .addPlugin(listActionsPlugin as any)
-      .addPlugin(getAppPlugin as any)
-      .addPlugin(getActionPlugin as any)
-      .addPlugin(listInputFieldsPlugin as any);
-  }
-
-  describe("schema validation", () => {
-    it("should throw validation error for missing required fields", () => {
-      const sdk = createTestSdk();
-      expect(() => {
-        sdk.listInputFields({
-          // Missing required fields
-        } as ListInputFieldsOptions);
-      }).toThrow(ZapierValidationError);
-    });
-
-    it("should throw validation error for invalid field types", () => {
-      const sdk = createTestSdk();
-      expect(() => {
-        sdk.listInputFields({
-          appKey: 123 as any,
-          actionType: "write",
-          actionKey: "send_message",
-        });
-      }).toThrow(ZapierValidationError);
-    });
-
-    it("should pass validation with all required fields", async () => {
-      const sdk = createTestSdk();
-      const result = await sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-      });
-
-      expect(result.data).toBeDefined();
-    });
-
-    it("should pass validation with optional fields", async () => {
-      const sdk = createTestSdk();
-      const result = await sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-        authenticationId: 123,
-        inputs: { channel: "#general" },
-      });
-
-      expect(result.data).toBeDefined();
-    });
-  });
-
-  describe("API integration", () => {
-    it("should call the correct API endpoint", async () => {
-      const sdk = createTestSdk();
-      await sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-      });
-
-      expect(mockApiClient.post).toHaveBeenCalledWith(
-        "/api/v4/implementations/needs/",
-        {
-          selected_api: "SlackCLIAPI@1.21.1",
-          action: "send_message",
-          type_of: "write",
-          params: {},
-        },
-      );
-    });
-
-    it("should include authentication_id when provided", async () => {
-      const sdk = createTestSdk();
-      await sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-        authenticationId: 123,
-      });
-
-      expect(mockApiClient.post).toHaveBeenCalledWith(
-        "/api/v4/implementations/needs/",
-        {
-          selected_api: "SlackCLIAPI@1.21.1",
-          action: "send_message",
-          type_of: "write",
-          params: {},
-          authentication_id: 123,
-        },
-      );
-    });
-
-    it("should exclude authentication_id when null", async () => {
-      const sdk = createTestSdk();
-      await sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-        authenticationId: null,
-      });
-
-      expect(mockApiClient.post).toHaveBeenCalledWith(
-        "/api/v4/implementations/needs/",
-        {
-          selected_api: "SlackCLIAPI@1.21.1",
-          action: "send_message",
-          type_of: "write",
-          params: {},
-          // No authentication_id
-        },
-      );
-    });
-
-    it("should include inputs when provided", async () => {
-      const sdk = createTestSdk();
-      const inputs = { channel: "#general", message: "test" };
-
-      await sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-        inputs,
-      });
-
-      expect(mockApiClient.post).toHaveBeenCalledWith(
-        "/api/v4/implementations/needs/",
-        {
-          selected_api: "SlackCLIAPI@1.21.1",
-          action: "send_message",
-          type_of: "write",
-          params: inputs,
-        },
-      );
-    });
-  });
-
-  describe("data transformation", () => {
-    it("should transform needs to input field items correctly", async () => {
-      const sdk = createTestSdk();
-      const result = await sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-      });
-
-      expect(result.data).toHaveLength(3);
-
-      // Check message field transformation
-      expect(result.data[0]).toEqual(
-        expect.objectContaining({
-          key: "message",
-          title: "Message",
-          description: "The message to send",
-          is_required: true,
-          value_type: "STRING",
-          placeholder: "Enter your message",
-          default_value: "",
-        }),
-      );
-
-      // Check channel field with SELECT format
-      expect(result.data[1]).toEqual(
-        expect.objectContaining({
-          key: "channel",
-          title: "Channel",
-          description: "The channel to send to",
-          is_required: true,
-          value_type: "STRING",
-          format: "SELECT",
-        }),
-      );
-
-      // Check array field
-      expect(result.data[2]).toEqual(
-        expect.objectContaining({
-          key: "tags",
-          title: "Tags",
-          description: "List of tags",
-          value_type: "ARRAY",
-          items: { type: "STRING" },
-        }),
-      );
-    });
-
-    it("should handle different field types correctly", async () => {
-      const complexNeeds: Need[] = [
-        {
-          key: "count",
-          type: "integer",
-          label: "Count",
-          required: false,
-        },
-        {
-          key: "price",
-          type: "decimal",
-          label: "Price",
-        },
-        {
-          key: "enabled",
-          type: "boolean",
-          label: "Enabled",
-        },
-        {
-          key: "config",
-          type: "dict",
-          label: "Configuration",
-        },
-        {
-          key: "description",
-          type: "text",
-          label: "Description",
-        },
-      ];
-
-      mockApiClient.post = vi.fn().mockResolvedValue({
-        success: true,
-        needs: complexNeeds,
-      });
-
-      const sdk = createTestSdk();
-      const result = await sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-      });
-
-      expect(result.data[0].value_type).toBe("INTEGER");
-      expect(result.data[1].value_type).toBe("NUMBER");
-      expect(result.data[2].value_type).toBe("BOOLEAN");
-      expect(result.data[3].value_type).toBe("OBJECT");
-      expect(result.data[4].value_type).toBe("STRING");
-      expect(result.data[4].format).toBe("MULTILINE");
-    });
-  });
-
-  describe("error handling", () => {
-    it("should throw ZapierConfigurationError when app has no current_implementation_id", async () => {
-      mockGetVersionedImplementationId.mockResolvedValue(null);
-
-      const sdk = createTestSdk();
-      await expect(
-        sdk.listInputFields({
-          appKey: "invalid",
-          actionType: "write",
-          actionKey: "send_message",
-        }),
-      ).rejects.toThrow(ZapierConfigurationError);
-    });
-
-    it("should throw ZapierApiError when API response indicates failure", async () => {
-      mockApiClient.post = vi.fn().mockResolvedValue({
-        success: false,
-        errors: ["Authentication failed", "Invalid credentials"],
-      });
-
-      const sdk = createTestSdk();
-      await expect(
-        sdk.listInputFields({
-          appKey: "slack",
-          actionType: "write",
-          actionKey: "send_message", // Use valid action so we get to the POST call
-        }),
-      ).rejects.toThrow(ZapierApiError);
-
-      await expect(
-        sdk.listInputFields({
-          appKey: "slack",
-          actionType: "write",
-          actionKey: "send_message", // Use valid action so we get to the POST call
-        }),
-      ).rejects.toThrow(
-        "Failed to get action fields: Authentication failed, Invalid credentials",
-      );
-    });
-
-    it("should handle API errors gracefully", async () => {
-      mockApiClient.post = vi
-        .fn()
-        .mockRejectedValue(new Error("Network error"));
-
-      const sdk = createTestSdk();
-      await expect(
-        sdk.listInputFields({
-          appKey: "slack",
-          actionType: "write",
-          actionKey: "send_message",
-        }),
-      ).rejects.toThrow("Network error");
-    });
-  });
-
-  describe("context and metadata", () => {
-    it("should provide context with meta information", () => {
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-
-      expect((context.meta as any).listInputFields).toBeDefined();
-      expect((context.meta as any).listInputFields.inputSchema).toBeDefined();
-    });
-  });
-
-  describe("pagination", () => {
-    it("should support async iteration over pages", async () => {
-      const sdk = createTestSdk();
-      const listInputFieldsResult = sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-      });
-
-      const pages = [];
-      for await (const page of listInputFieldsResult) {
-        pages.push(page);
-        break; // Just get first page for testing
-      }
-
-      expect(pages).toHaveLength(1);
-      expect(pages[0].data).toHaveLength(3);
-    });
-
-    it("should support async iteration over individual items", async () => {
-      const sdk = createTestSdk();
-      const listInputFieldsResult = sdk.listInputFields({
-        appKey: "slack",
-        actionType: "write",
-        actionKey: "send_message",
-      });
-
-      const items = [];
-      for await (const item of listInputFieldsResult.items()) {
-        items.push(item);
-      }
-
-      expect(items).toHaveLength(3);
-      expect(items[0].key).toBe("message");
-    });
-  });
-});