@zapier/zapier-sdk 0.13.5 → 0.13.7

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

@@ -1,378 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import { ZapierValidationError } from "../../types/errors";
-import { listAppsPlugin } from "./index";
-import { createSdk } from "../../sdk";
-import { apiPlugin } from "../api/index";
-
-const mockAppsResponse = {
-  results: [
-    {
-      id: "SlackCLIAPI@1.0.0",
-      slug: "slack",
-      name: "Slack",
-      description: "Team communication",
-      primary_color: "#4A154B",
-      categories: ["communication"],
-    },
-    {
-      id: "GoogleSheetsCLIAPI@1.0.0",
-      slug: "google-sheets",
-      name: "Google Sheets",
-      description: "Online spreadsheets",
-      primary_color: "#34A853",
-      categories: ["productivity"],
-    },
-  ],
-  meta: {
-    next_cursor: null,
-  },
-};
-
-const mockResolveAppKeys = vi
-  .fn()
-  .mockImplementation(async ({ appKeys }: { appKeys: string[] }) => {
-    // Mock implementation that returns resolved locators for the app keys
-    return appKeys.map((appKey) => ({
-      lookupAppKey: appKey,
-      implementationName: appKey, // For testing, use appKey as implementationName
-      slug: appKey.toLowerCase(),
-      version: undefined,
-    }));
-  });
-
-function createTestSdk() {
-  return createSdk()
-    .addPlugin(apiPlugin, { fetch: global.fetch })
-    .addPlugin(() => ({
-      context: {
-        resolveAppKeys: mockResolveAppKeys,
-      },
-    }))
-    .addPlugin(listAppsPlugin as any);
-}
-
-describe("listApps plugin", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  describe("schema validation", () => {
-    it("should pass validation with empty options", async () => {
-      const mockServicesResponse = {
-        results: [
-          {
-            id: "slack_service_id",
-            slug: "slack",
-            name: "Slack",
-            description: "Team communication",
-            current_implementation_id: "SlackCLIAPI@1.0.0",
-          },
-          {
-            id: "sheets_service_id",
-            slug: "google-sheets",
-            name: "Google Sheets",
-            description: "Online spreadsheets",
-            current_implementation_id: "GoogleSheetsCLIAPI@1.0.0",
-          },
-        ],
-        next: null,
-      };
-
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-      // Mock the API client in context
-      (context.api as any).get = vi
-        .fn()
-        .mockResolvedValue(mockServicesResponse);
-
-      const result = await sdk.listApps({});
-      expect(result.data).toHaveLength(2);
-    });
-
-    it("should handle undefined options by converting to empty object", async () => {
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-
-      // Mock the API client in context
-      (context.api as any).get = vi.fn().mockResolvedValueOnce({
-        results: [
-          {
-            id: "SlackCLIAPI@1.0.0",
-            name: "Slack",
-            description: "Team communication",
-            primary_color: "#4A154B",
-            categories: ["communication"],
-          },
-        ],
-        next: null,
-      });
-
-      const result = await sdk.listApps(undefined as any);
-
-      expect(result.data).toHaveLength(1);
-      expect(result.data[0]).toMatchObject({
-        key: "SlackCLIAPI",
-        title: "Slack",
-      });
-      expect((context.api as any).get).toHaveBeenCalledWith(
-        "/api/v4/implementations-meta/lookup/",
-        {
-          searchParams: {
-            latest_only: "true",
-            limit: "100",
-            selected_apis: "",
-          },
-        },
-      );
-    });
-
-    it("should throw validation error for invalid pageSize", () => {
-      const sdk = createTestSdk();
-      expect(() => {
-        sdk.listApps({
-          pageSize: 0, // Should be >= 1
-        });
-      }).toThrow(ZapierValidationError);
-
-      expect(() => {
-        sdk.listApps({
-          pageSize: -5, // Should be >= 1
-        });
-      }).toThrow(ZapierValidationError);
-    });
-
-    it("should throw validation error for invalid maxItems", () => {
-      const sdk = createTestSdk();
-      expect(() => {
-        sdk.listApps({
-          maxItems: 0 as any, // Should be >= 1
-        });
-      }).toThrow(ZapierValidationError);
-
-      expect(() => {
-        sdk.listApps({
-          maxItems: -10 as any, // Should be >= 1
-        });
-      }).toThrow(ZapierValidationError);
-    });
-
-    it("should throw validation error for invalid appKeys type", () => {
-      const sdk = createTestSdk();
-      expect(() => {
-        sdk.listApps({
-          appKeys: 123 as any,
-        });
-      }).toThrow(ZapierValidationError);
-    });
-
-    it("should pass validation with all valid fields", async () => {
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-
-      // Mock the API client in context
-      (context.api as any).get = vi.fn().mockResolvedValueOnce({
-        results: [
-          {
-            id: "SlackCLIAPI@1.0.0",
-            name: "Slack",
-            description: "Team communication",
-            primary_color: "#4A154B",
-            categories: ["communication"],
-          },
-          {
-            id: "GitHubCLIAPI@1.0.0",
-            name: "GitHub",
-            description: "Code repository hosting",
-            primary_color: "#24292e",
-            categories: ["developer-tools"],
-          },
-        ],
-        next: null,
-      });
-
-      const result = await sdk.listApps({
-        appKeys: ["SlackCLIAPI", "GitHubCLIAPI"],
-        pageSize: 10,
-        maxItems: 50,
-      });
-
-      expect(result.data).toHaveLength(2);
-      expect(result.data[0].key).toBe("SlackCLIAPI");
-      expect(result.data[1].key).toBe("GitHubCLIAPI");
-    });
-  });
-
-  describe("data mapping", () => {
-    it("should return essential app properties", async () => {
-      const mockServicesResponse = {
-        results: [
-          {
-            id: "slack_service_id",
-            slug: "slack",
-            name: "Slack",
-            description: "Team communication",
-            current_implementation_id: "SlackCLIAPI@1.0.0",
-          },
-        ],
-        next: null,
-      };
-
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-      // Mock the API client in context
-      (context.api as any).get = vi
-        .fn()
-        .mockResolvedValue(mockServicesResponse);
-
-      const result = await sdk.listApps({});
-
-      expect(result.data[0]).toHaveProperty("title");
-      expect(result.data[0]).toHaveProperty("key");
-      expect(result.data[0]).toHaveProperty("implementation_id");
-      // Version is optional
-      expect(result.data[0]).toHaveProperty("version");
-    });
-  });
-
-  describe("pagination", () => {
-    it("should handle pagination with maxItems", async () => {
-      const mockServicesResponse = {
-        results: [
-          {
-            id: "slack_service_id",
-            slug: "slack",
-            name: "Slack",
-            description: "Team communication",
-            current_implementation_id: "SlackCLIAPI@1.0.0",
-          },
-          {
-            id: "sheets_service_id",
-            slug: "google-sheets",
-            name: "Google Sheets",
-            description: "Online spreadsheets",
-            current_implementation_id: "GoogleSheetsCLIAPI@1.0.0",
-          },
-        ],
-        next: null,
-      };
-
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-      const mockGet = vi.fn().mockResolvedValue(mockServicesResponse);
-      (context.api as any).get = mockGet;
-
-      const result = await sdk.listApps({ maxItems: 5 });
-
-      // Should return all items since maxItems (5) is greater than available items (2)
-      expect(result.data).toHaveLength(2);
-      expect(mockGet).toHaveBeenCalledTimes(1);
-    });
-
-    it("should support async iteration over pages", async () => {
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-      const mockGet = vi
-        .fn()
-        .mockResolvedValueOnce({
-          results: [
-            {
-              id: "SlackCLIAPI@1.0.0",
-              slug: "slack",
-              name: "Slack",
-              description: "Team communication",
-            },
-          ],
-          next: "https://zapier.com/api/v4/services/?offset=cursor-page-2",
-        })
-        .mockResolvedValueOnce({
-          results: [
-            {
-              id: "GoogleSheetsCLIAPI@1.0.0",
-              slug: "google-sheets",
-              name: "Google Sheets",
-              description: "Online spreadsheets",
-            },
-          ],
-          next: null,
-        });
-      (context.api as any).get = mockGet;
-
-      const pages = [];
-      for await (const page of sdk.listApps({ pageSize: 1 })) {
-        pages.push(page);
-        if (pages.length >= 2) break;
-      }
-
-      expect(pages).toHaveLength(2);
-      expect(pages[0].data).toHaveLength(1);
-      expect(pages[1].data).toHaveLength(1);
-      expect(pages[0].data[0].key).toBe("SlackCLIAPI");
-      expect(pages[1].data[0].key).toBe("GoogleSheetsCLIAPI");
-    });
-
-    it("should support async iteration over individual items", async () => {
-      const mockServicesResponse = {
-        results: [
-          {
-            id: "SlackCLIAPI@1.0.0",
-            slug: "slack",
-            name: "Slack",
-            description: "Team communication",
-          },
-          {
-            id: "GoogleSheetsCLIAPI@1.0.0",
-            slug: "google-sheets",
-            name: "Google Sheets",
-            description: "Online spreadsheets",
-          },
-        ],
-        next: null,
-      };
-
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-      (context.api as any).get = vi
-        .fn()
-        .mockResolvedValue(mockServicesResponse);
-
-      const items = [];
-      for await (const item of sdk.listApps({ maxItems: 2 }).items()) {
-        items.push(item);
-      }
-
-      expect(items).toHaveLength(2);
-      expect(items[0].key).toBe("SlackCLIAPI");
-      expect(items[1].key).toBe("GoogleSheetsCLIAPI");
-    });
-  });
-
-  describe("API integration", () => {
-    it("should pass appKeys filter to API", async () => {
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-      const mockGet = vi.fn().mockResolvedValue(mockAppsResponse);
-      (context.api as any).get = mockGet;
-
-      await sdk.listApps({ appKeys: ["SlackCLIAPI", "GitHubCLIAPI"] });
-
-      expect(mockGet).toHaveBeenCalledWith(
-        expect.stringContaining("implementations-meta"),
-        expect.objectContaining({
-          searchParams: expect.objectContaining({
-            selected_apis: "SlackCLIAPI@latest,GitHubCLIAPI@latest",
-          }),
-        }),
-      );
-    });
-  });
-
-  describe("plugin integration", () => {
-    it("should provide metadata in context", () => {
-      const sdk = createTestSdk();
-      const context = sdk.getContext();
-
-      expect((context.meta as any).listApps).toBeDefined();
-      expect((context.meta as any).listApps.inputSchema).toBeDefined();
-    });
-  });
-});

package/src/plugins/listApps/index.ts

@@ -1,159 +0,0 @@
-import type { GetContextType, Plugin } from "../../types/plugin";
-import { createPaginatedFunction } from "../../utils/function-utils";
-import { ListAppsSchema } from "./schemas";
-import type { ListAppsOptions, ListAppsPage } from "./schemas";
-import type { AppItem } from "../../types/domain";
-import { AppItemSchema } from "../../schemas/App";
-import type { ResolvedAppLocator } from "../../utils/domain-utils";
-import {
-  normalizeImplementationMetaToAppItem,
-  splitVersionedKey,
-  toAppLocator,
-  toImplementationId,
-} from "../../utils/domain-utils";
-import { extractCursor } from "../../utils/function-utils";
-import type { ImplementationsMetaResponse } from "../../api/types";
-import type { ManifestPluginProvides } from "../manifest";
-import type { ApiPluginProvides } from "../api";
-// ListApps plugin provides interface - listApps goes directly to SDK root
-export interface ListAppsPluginProvides {
-  listApps: (options?: ListAppsOptions) => Promise<{
-    data: AppItem[];
-    nextCursor?: string;
-  }> &
-    AsyncIterable<{ data: AppItem[]; nextCursor?: string }> & {
-      items(): AsyncIterable<AppItem>;
-    };
-  context: {
-    meta: {
-      listApps: {
-        inputSchema: typeof ListAppsSchema;
-      };
-    };
-  };
-}
-
-export const listAppsPlugin: Plugin<
-  {},
-  GetContextType<ApiPluginProvides & ManifestPluginProvides>,
-  ListAppsPluginProvides
-> = ({ context }) => {
-  const listApps = createPaginatedFunction(async function listAppsPage(
-    options: ListAppsOptions & { cursor?: string } & { pageSize: number },
-  ): Promise<ListAppsPage> {
-    const { api, resolveAppKeys } = context;
-    const appKeys = options.appKeys ?? [];
-
-    const appLocators = await resolveAppKeys({
-      appKeys: [...appKeys],
-    });
-    const implementationNameToLocator: Record<string, ResolvedAppLocator[]> =
-      {};
-    for (const locator of appLocators) {
-      implementationNameToLocator[locator.implementationName] = [
-        ...(implementationNameToLocator[locator.implementationName] ?? []),
-        locator,
-      ];
-    }
-    const duplicatedLookupAppKeys = Object.keys(implementationNameToLocator)
-      .filter((key) => implementationNameToLocator[key].length > 1)
-      .map((key) => implementationNameToLocator[key])
-      .flat()
-      .map((locator) => locator.lookupAppKey);
-
-    if (duplicatedLookupAppKeys.length > 0) {
-      throw new Error(
-        `Duplicate lookup app keys found: ${duplicatedLookupAppKeys.join(", ")}`,
-      );
-    }
-
-    if (options.search) {
-      const searchParams: Record<string, string> = {};
-
-      searchParams.term = options.search;
-
-      const searchEnvelope: ImplementationsMetaResponse = await api.get(
-        "/api/v4/implementations-meta/search/",
-        {
-          searchParams,
-        },
-      );
-
-      const implementations = searchEnvelope.results.map(
-        normalizeImplementationMetaToAppItem,
-      );
-
-      const implementationNameSet = new Set<string>(
-        appLocators.map((locator) => locator.implementationName),
-      );
-
-      for (const implementation of implementations) {
-        const [implementationName] = splitVersionedKey(implementation.key);
-        if (!implementationNameSet.has(implementationName)) {
-          implementationNameSet.add(implementationName);
-          appLocators.push({
-            ...toAppLocator(implementation.key),
-            implementationName,
-          });
-        }
-      }
-    }
-
-    const searchParams: Record<string, string> = {};
-
-    if (options.pageSize) {
-      searchParams.limit = options.pageSize.toString();
-    }
-
-    if (appLocators.length === 0) {
-      searchParams.latest_only = "true";
-    }
-
-    if (options.cursor) {
-      searchParams.offset = options.cursor;
-    }
-
-    searchParams.selected_apis = appLocators
-      .map((locator) => toImplementationId(locator))
-      .join(",");
-
-    // If we have app keys, but they resolved to an empty list, then we need to short-circuit and return an empty list.
-    // Otherwise, the API will return all apps, since no selected_apis are provided.
-    if (appKeys.length > 0 && appLocators.length === 0) {
-      return {
-        data: [],
-        nextCursor: undefined,
-      };
-    }
-
-    const implementationsEnvelope: ImplementationsMetaResponse = await api.get(
-      "/api/v4/implementations-meta/lookup/",
-      {
-        searchParams,
-      },
-    );
-
-    return {
-      data: implementationsEnvelope.results.map(
-        normalizeImplementationMetaToAppItem,
-      ),
-      nextCursor: extractCursor(implementationsEnvelope),
-    };
-  }, ListAppsSchema);
-
-  // Return flat structure - listApps goes directly to SDK
-  return {
-    listApps,
-    context: {
-      meta: {
-        listApps: {
-          categories: ["app"],
-          type: "list",
-          itemType: "App",
-          inputSchema: ListAppsSchema,
-          outputSchema: AppItemSchema,
-        },
-      },
-    },
-  };
-};

package/src/plugins/listApps/schemas.ts

@@ -1,41 +0,0 @@
-import { z } from "zod";
-import type { AppItem } from "../../types/domain";
-import type { PaginatedSdkFunction } from "../../types/functions";
-import type { ZapierApiError, ZapierValidationError } from "../../types/errors";
-
-// Union of all possible errors for listApps
-export type ListAppsError = ZapierApiError | ZapierValidationError;
-
-// A page of results returned when awaiting listApps
-export interface ListAppsPage {
-  data: AppItem[];
-  nextCursor?: string;
-}
-
-// Pure Zod schema - no pagination metadata exposed
-export const ListAppsSchema = z
-  .object({
-    appKeys: z
-      .array(z.string())
-      .optional()
-      .describe(
-        "Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github')",
-      ),
-    search: z.string().optional().describe("Search for apps by name"),
-    pageSize: z.number().min(1).optional().describe("Number of apps per page"),
-    maxItems: z
-      .number()
-      .min(1)
-      .optional()
-      .describe("Maximum total items to return across all pages"),
-    cursor: z.string().optional().describe("Cursor to start from"),
-  })
-  .describe("List all available apps with optional filtering");
-
-// Type inferred from schema
-export type ListAppsOptions = z.infer<typeof ListAppsSchema>;
-
-// SDK function interface
-export interface ListAppsSdkFunction {
-  listApps: PaginatedSdkFunction<ListAppsOptions | undefined, AppItem>;
-}