@zapier/zapier-sdk 0.5.1 → 0.6.0

package/src/plugins/getApp/index.ts

@@ -4,8 +4,9 @@ import { GetAppSchema } from "./schemas";
 import type { GetAppOptions } from "./schemas";
 import type { AppItem } from "../../types/domain";
 import { ZapierAppNotFoundError } from "../../types/errors";
-import type { ListAppsPluginProvides } from "../listApps";
 import type { GetSdkType } from "../../types/plugin";
+import { GetImplementation } from "../manifest/schemas";
+import { ManifestPluginProvides } from "../manifest";
 
 // GetApp plugin provides interface - getApp goes directly to SDK root
 export interface GetAppPluginProvides {
@@ -21,34 +22,20 @@ export interface GetAppPluginProvides {
 
 // GetApp plugin depends on listApps SDK function
 export const getAppPlugin: Plugin<
-  GetSdkType<ListAppsPluginProvides>, // depends on listApps
-  {}, // no additional context dependencies
+  GetSdkType<ManifestPluginProvides>, // depends on manifest plugin with getImplementation in context
+  { getImplementation: GetImplementation }, //
   GetAppPluginProvides
-> = ({ sdk }) => {
+> = ({ context }) => {
   const getApp = createFunction(async function getApp(options: GetAppOptions) {
-    const { appKey } = options;
-
-    // Use listApps to get the app by key
-    const appsIterator = sdk
-      .listApps({
-        ...options,
-        appKeys: [appKey],
-      })
-      .items();
-
-    // Get the first (and should be only) result
-    const apps = [];
-    for await (const app of appsIterator) {
-      apps.push(app);
-      break; // Only need the first result
-    }
-
-    if (apps.length === 0) {
-      throw new ZapierAppNotFoundError(appKey);
+    const app = await context.getImplementation(options.appKey);
+    if (!app) {
+      throw new ZapierAppNotFoundError("App not found", {
+        appKey: options.appKey,
+      });
     }
 
     return {
-      data: apps[0],
+      data: app,
     };
   }, GetAppSchema);
 
@@ -58,6 +45,7 @@ export const getAppPlugin: Plugin<
     context: {
       meta: {
         getApp: {
+          categories: ["app"],
           inputSchema: GetAppSchema,
         },
       },

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

@@ -9,6 +9,8 @@ import { createSdk } from "../../sdk";
 import type { ApiClient } from "../../api";
 import type { GetAuthenticationOptions } from "./schemas";
 import type { Authentication } from "../../api/types";
+import { manifestPlugin } from "../manifest";
+import { listAppsPlugin } from "../listApps";
 
 const mockAuthenticationResponse: Authentication = {
   id: 123,
@@ -34,10 +36,18 @@ describe("getAuthentication plugin", () => {
     } as Partial<ApiClient> as ApiClient;
   });
 
+  const apiPlugin = () => ({
+    context: {
+      api: mockApiClient,
+    },
+  });
+
   function createTestSdk() {
-    return createSdk({}, { api: mockApiClient, meta: {} }).addPlugin(
-      getAuthenticationPlugin,
-    );
+    return createSdk()
+      .addPlugin(apiPlugin)
+      .addPlugin(listAppsPlugin)
+      .addPlugin(manifestPlugin)
+      .addPlugin(getAuthenticationPlugin);
   }
 
   describe("schema validation", () => {

package/src/plugins/getAuthentication/index.ts

@@ -78,6 +78,7 @@ export const getAuthenticationPlugin: Plugin<
     context: {
       meta: {
         getAuthentication: {
+          categories: ["authentication"],
           inputSchema: GetAuthenticationSchema,
         },
       },

package/src/plugins/getProfile/index.ts

@@ -47,6 +47,7 @@ export const getProfilePlugin: Plugin<
     context: {
       meta: {
         getProfile: {
+          categories: ["user"],
           inputSchema: GetProfileSchema,
         },
       },

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

@@ -8,19 +8,8 @@ import { listActionsPlugin } from "./index";
 import { createSdk } from "../../sdk";
 import type { ApiClient } from "../../api";
 import type { ListActionsOptions } from "./schemas";
-import { App } from "../../api/types";
-import { GetAppSchema } from "../getApp/schemas";
-
-const mockAppResponse = {
-  data: {
-    slug: "slack",
-    name: "Slack",
-    current_implementation_id: "SlackCLIAPI@1.20.0",
-    key: "slack",
-    title: "Slack",
-    hex_color: "#4A154B",
-  } as Partial<App> as App & { key: string; title: string; hex_color: string },
-};
+
+import { listAppsPlugin } from "../listApps";
 
 const mockImplementationsResponse = {
   results: [
@@ -66,7 +55,7 @@ const mockEmptyImplementationsResponse = {
 
 describe("listActions plugin", () => {
   let mockApiClient: ApiClient;
-  let mockGetApp: any;
+  let mockGetVersionedImplementationId: any;
 
   beforeEach(() => {
     vi.clearAllMocks();
@@ -74,25 +63,31 @@ describe("listActions plugin", () => {
       get: vi.fn().mockResolvedValue(mockImplementationsResponse),
     } as Partial<ApiClient> as ApiClient;
 
-    mockGetApp = vi.fn().mockResolvedValue(mockAppResponse);
+    mockGetVersionedImplementationId = vi
+      .fn()
+      .mockResolvedValue("SlackCLIAPI@1.21.1");
   });
 
   function createTestSdk() {
     // Create a proper plugin chain with context dependencies
-    const mockGetAppPlugin = () => ({
-      getApp: mockGetApp,
-      context: {
-        meta: {
-          getApp: {
-            inputSchema: GetAppSchema,
-          },
-        },
-      },
-    });
 
     // Build SDK with proper plugin composition, providing API in initial context
-    return createSdk({}, { api: mockApiClient, meta: {} })
-      .addPlugin(mockGetAppPlugin)
+    return createSdk()
+      .addPlugin(() => ({
+        context: {
+          api: mockApiClient,
+          getVersionedImplementationId: mockGetVersionedImplementationId,
+        },
+      }))
+      .addPlugin(listAppsPlugin)
+      .addPlugin(() => ({
+        context: {
+          manifest: null,
+          getManifestEntry: () => null,
+          getVersionedImplementationId: mockGetVersionedImplementationId,
+          getImplementation: () => Promise.resolve(null),
+        },
+      }))
       .addPlugin(listActionsPlugin);
   }
 
@@ -401,9 +396,7 @@ describe("listActions plugin", () => {
       const sdk = createTestSdk();
       await sdk.listActions({ appKey: "slack" });
 
-      expect(mockGetApp).toHaveBeenCalledWith({
-        appKey: "slack",
-      });
+      expect(mockGetVersionedImplementationId).toHaveBeenCalledWith("slack");
     });
 
     it("should pass correct search parameters to implementations API", async () => {
@@ -416,7 +409,7 @@ describe("listActions plugin", () => {
           searchParams: expect.objectContaining({
             global: "true",
             public_only: "true",
-            selected_apis: "SlackCLIAPI", // Extracted from current_implementation_id
+            selected_apis: "SlackCLIAPI@1.21.1",
           }),
         }),
       );
@@ -425,12 +418,7 @@ describe("listActions plugin", () => {
 
   describe("error handling", () => {
     it("should throw ZapierConfigurationError when app has no current_implementation_id", async () => {
-      mockGetApp.mockResolvedValue({
-        data: {
-          ...mockAppResponse.data,
-          current_implementation_id: undefined, // Missing implementation ID
-        },
-      });
+      mockGetVersionedImplementationId.mockResolvedValue(null);
 
       const sdk = createTestSdk();
       await expect(sdk.listActions({ appKey: "slack" })).rejects.toThrow(
@@ -439,12 +427,7 @@ describe("listActions plugin", () => {
     });
 
     it("should throw ZapierConfigurationError when current_implementation_id is empty", async () => {
-      mockGetApp.mockResolvedValue({
-        data: {
-          ...mockAppResponse.data,
-          current_implementation_id: "", // Empty implementation ID
-        },
-      });
+      mockGetVersionedImplementationId.mockResolvedValue("");
 
       const sdk = createTestSdk();
       await expect(sdk.listActions({ appKey: "slack" })).rejects.toThrow(
@@ -516,8 +499,10 @@ describe("listActions plugin", () => {
       expect(result.data).toHaveLength(0);
     });
 
-    it("should propagate getApp errors", async () => {
-      mockGetApp.mockRejectedValue(new Error("App not found"));
+    it("should propagate getVersionedImplementationId errors", async () => {
+      mockGetVersionedImplementationId.mockRejectedValue(
+        new Error("App not found"),
+      );
 
       const sdk = createTestSdk();
       await expect(sdk.listActions({ appKey: "nonexistent" })).rejects.toThrow(
@@ -526,50 +511,6 @@ describe("listActions plugin", () => {
     });
   });
 
-  describe("implementation ID extraction", () => {
-    it("should extract implementation name from versioned ID", async () => {
-      mockGetApp.mockResolvedValue({
-        data: {
-          ...mockAppResponse.data,
-          current_implementation_id: "CustomAPIName@2.5.0",
-        },
-      });
-
-      const sdk = createTestSdk();
-      await sdk.listActions({ appKey: "slack" });
-
-      expect(mockApiClient.get).toHaveBeenCalledWith(
-        "/api/v4/implementations/",
-        expect.objectContaining({
-          searchParams: expect.objectContaining({
-            selected_apis: "CustomAPIName", // Extracted name without version
-          }),
-        }),
-      );
-    });
-
-    it("should handle implementation ID without version", async () => {
-      mockGetApp.mockResolvedValue({
-        data: {
-          ...mockAppResponse.data,
-          current_implementation_id: "PlainAPIName",
-        },
-      });
-
-      const sdk = createTestSdk();
-      await sdk.listActions({ appKey: "slack" });
-
-      expect(mockApiClient.get).toHaveBeenCalledWith(
-        "/api/v4/implementations/",
-        expect.objectContaining({
-          searchParams: expect.objectContaining({
-            selected_apis: "PlainAPIName", // Used as-is
-          }),
-        }),
-      );
-    });
-  });
-
   describe("context and metadata", () => {
     it("should provide context with meta information", () => {
       const sdk = createTestSdk();

package/src/plugins/listActions/index.ts

@@ -1,5 +1,5 @@
 import type { Plugin, GetSdkType } from "../../types/plugin";
-import type { ApiClient } from "../../api";
+import type { ApiClient, Implementation } from "../../api";
 import type { ActionItem } from "../../types/domain";
 import { normalizeActionItem } from "../../utils/domain-utils";
 import {
@@ -12,7 +12,8 @@ import {
   ZapierAuthenticationError,
 } from "../../types/errors";
 import { createPaginatedFunction } from "../../utils/function-utils";
-import type { GetAppPluginProvides } from "../getApp";
+import { ManifestPluginProvides } from "../manifest";
+import { GetVersionedImplementationId } from "../manifest/schemas";
 
 export interface ListActionsPluginProvides {
   listActions: (options?: ListActionsOptions) => Promise<{
@@ -31,20 +32,22 @@ export interface ListActionsPluginProvides {
 }
 
 export const listActionsPlugin: Plugin<
-  GetSdkType<GetAppPluginProvides>, // requires getApp in SDK
-  { api: ApiClient }, // requires api in context
+  GetSdkType<ManifestPluginProvides>, // requires getApp in SDK
+  {
+    api: ApiClient;
+    getVersionedImplementationId: GetVersionedImplementationId;
+  }, // requires api and getVersionedImplementationId in context
   ListActionsPluginProvides
-> = ({ sdk, context }) => {
+> = ({ context }) => {
   const listActions = createPaginatedFunction(async function listActionsPage(
     options: ListActionsOptions & { cursor?: string } & { pageSize: number },
   ): Promise<ListActionsPage> {
-    const { api } = context;
+    const { api, getVersionedImplementationId } = context;
 
     // Use the getApp function from the SDK (dependency injection)
-    const app = await sdk.getApp({ appKey: options.appKey });
+    const selectedApi = await getVersionedImplementationId(options.appKey);
 
-    const implementationId = app.data.current_implementation_id?.split("@")[0];
-    if (!implementationId) {
+    if (!selectedApi) {
       throw new ZapierConfigurationError(
         "No current_implementation_id found for app",
         { configType: "current_implementation_id" },
@@ -54,27 +57,30 @@ export const listActionsPlugin: Plugin<
     const searchParams: Record<string, string> = {
       global: "true",
       public_only: "true",
-      selected_apis: implementationId,
+      selected_apis: selectedApi,
     };
 
-    const data = await api.get("/api/v4/implementations/", {
-      searchParams,
-      customErrorHandler: ({ status }) => {
-        if (status === 401) {
-          return new ZapierAuthenticationError(
-            `Authentication failed. Your token may not have permission to access implementations or may be expired. (HTTP ${status})`,
-            { statusCode: status },
-          );
-        }
-        if (status === 403) {
-          return new ZapierAuthenticationError(
-            `Access forbidden. Your token may not have the required scopes to list implementations. (HTTP ${status})`,
-            { statusCode: status },
-          );
-        }
-        return undefined;
+    const data = await api.get<{ results: Implementation[] }>(
+      "/api/v4/implementations/",
+      {
+        searchParams,
+        customErrorHandler: ({ status }) => {
+          if (status === 401) {
+            return new ZapierAuthenticationError(
+              `Authentication failed. Your token may not have permission to access implementations or may be expired. (HTTP ${status})`,
+              { statusCode: status },
+            );
+          }
+          if (status === 403) {
+            return new ZapierAuthenticationError(
+              `Access forbidden. Your token may not have the required scopes to list implementations. (HTTP ${status})`,
+              { statusCode: status },
+            );
+          }
+          return undefined;
+        },
       },
-    });
+    );
 
     let allActions: ActionItem[] = [];
 
@@ -107,6 +113,7 @@ export const listActionsPlugin: Plugin<
     context: {
       meta: {
         listActions: {
+          categories: ["action"],
           inputSchema: ListActionsSchema,
         },
       },

package/src/plugins/listApps/index.ts

@@ -113,6 +113,7 @@ export const listAppsPlugin: Plugin<
     context: {
       meta: {
         listApps: {
+          categories: ["app"],
           inputSchema: ListAppsSchema,
         },
       },

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

@@ -6,7 +6,7 @@ import {
 import { listAuthenticationsPlugin } from "./index";
 import { createSdk } from "../../sdk";
 import type { ApiClient } from "../../api";
-import type { App } from "../../api/types";
+import type { AppItem } from "../../types/domain";
 
 const mockAuthenticationsResponse = {
   results: [
@@ -42,29 +42,18 @@ const mockAuthenticationsResponse = {
   previous: null,
 };
 
-const mockSlackApp = {
-  data: {
-    id: 1,
-    key: "slack",
-    title: "Slack",
-    hex_color: "#000000",
-    age_in_days: "100",
-    api_docs_url: "https://slack.com/api-docs",
-    app_profile_url: "https://slack.com",
-    banner: "https://slack.com/banner.png",
-    categories: [],
-    canonical_id: "slack",
-    zap_usage_count: 100,
-    zap_usage_count_last_updated: "2021-01-01",
-    zap_usage_count_last_updated_by: "user1",
-    zap_usage_count_last_updated_by_id: 123,
-    current_implementation_id: "SlackCLIAPI@1.21.1",
-  } as Partial<App> as App,
+const mockSlackApp: AppItem = {
+  title: "Slack",
+  key: "SlackCLIAPI",
+  current_implementation_id: "SlackCLIAPI@1.21.1",
+  version: "1.21.1",
+  description: "Team communication platform",
+  slug: "slack",
 };
 
 describe("listAuthentications plugin", () => {
   let mockApiClient: ApiClient;
-  let mockGetApp: any;
+  let mockGetVersionedImplementationId: any;
 
   beforeEach(() => {
     vi.clearAllMocks();
@@ -72,14 +61,34 @@ describe("listAuthentications plugin", () => {
       get: vi.fn().mockResolvedValue(mockAuthenticationsResponse),
     } as Partial<ApiClient> as ApiClient;
 
-    mockGetApp = vi.fn().mockResolvedValue(mockSlackApp);
+    mockGetVersionedImplementationId = vi
+      .fn()
+      .mockResolvedValue("SlackCLIAPI@1.21.1");
+  });
+
+  const apiPlugin = () => ({
+    context: {
+      api: mockApiClient,
+    },
+  });
+
+  const manifestPlugin = () => ({
+    context: {
+      manifest: null,
+      getVersionedImplementationId: mockGetVersionedImplementationId,
+      getManifestEntry: () => ({
+        implementationName: "SlackCLIAPI",
+        version: "1.21.1",
+      }),
+      getImplementation: vi.fn().mockResolvedValue(mockSlackApp),
+    },
   });
 
   function createTestSdk() {
-    return createSdk(
-      { getApp: mockGetApp }, // Provide getApp in SDK
-      { api: mockApiClient, meta: {} },
-    ).addPlugin(listAuthenticationsPlugin as any);
+    return createSdk()
+      .addPlugin(apiPlugin)
+      .addPlugin(manifestPlugin)
+      .addPlugin(listAuthenticationsPlugin);
   }
 
   describe("schema validation", () => {
@@ -129,7 +138,7 @@ describe("listAuthentications plugin", () => {
       const sdk = createTestSdk();
       expect(() => {
         sdk.listAuthentications({
-          account_id: 123,
+          account_id: 123 as any,
         });
       }).toThrow(ZapierValidationError);
     });
@@ -192,7 +201,7 @@ describe("listAuthentications plugin", () => {
   describe("data mapping", () => {
     it("should map is_stale to is_expired and marked_stale_at to expired_at", async () => {
       const sdk = createTestSdk();
-      const result = await sdk.listAuthentications({});
+      const result = await sdk.listAuthentications();
 
       expect(result.data[0].is_expired).toBe("false");
       expect(result.data[0].expired_at).toBe(null);
@@ -582,16 +591,7 @@ describe("listAuthentications plugin", () => {
 
   describe("app key integration", () => {
     it("should handle app without current_implementation_id", async () => {
-      const appWithoutImplementation = {
-        data: {
-          id: 123,
-          key: "slack",
-          title: "Slack",
-          current_implementation_id: undefined,
-        } as Partial<App> as App,
-      };
-
-      mockGetApp.mockResolvedValue(appWithoutImplementation);
+      mockGetVersionedImplementationId.mockResolvedValue(null);
 
       const sdk = createTestSdk();
       await sdk.listAuthentications({ appKey: "slack" });
@@ -608,16 +608,7 @@ describe("listAuthentications plugin", () => {
     });
 
     it("should extract versionless API from versioned implementation ID", async () => {
-      const appWithVersionedApi = {
-        data: {
-          id: 123,
-          key: "slack",
-          title: "Slack",
-          current_implementation_id: "SlackCLIAPI@2.1.3",
-        } as Partial<App> as App,
-      };
-
-      mockGetApp.mockResolvedValue(appWithVersionedApi);
+      mockGetVersionedImplementationId.mockResolvedValue("SlackCLIAPI@2.1.3");
 
       const sdk = createTestSdk();
       await sdk.listAuthentications({ appKey: "slack" });

package/src/plugins/listAuthentications/index.ts

@@ -7,13 +7,17 @@ import {
   type ListAuthenticationsOptions,
   type ListAuthenticationsPage,
 } from "./schemas";
-import { normalizeAuthenticationItem } from "../../utils/domain-utils";
+import {
+  normalizeAuthenticationItem,
+  splitVersionedKey,
+} from "../../utils/domain-utils";
 import { ZapierAuthenticationError } from "../../types/errors";
 import {
   createPaginatedFunction,
   extractCursor,
 } from "../../utils/function-utils";
-import type { GetAppPluginProvides } from "../getApp";
+import { GetVersionedImplementationId } from "../manifest/schemas";
+import { ManifestPluginProvides } from "../manifest";
 
 export interface ListAuthenticationsPluginProvides {
   listAuthentications: (options?: ListAuthenticationsOptions) => Promise<{
@@ -32,33 +36,31 @@ export interface ListAuthenticationsPluginProvides {
 }
 
 export const listAuthenticationsPlugin: Plugin<
-  GetSdkType<GetAppPluginProvides>, // requires getApp in SDK
-  { api: ApiClient }, // requires api in context
+  GetSdkType<ManifestPluginProvides>, // requires getApp in SDK
+  {
+    api: ApiClient;
+    getVersionedImplementationId: GetVersionedImplementationId;
+  }, // requires api in context
   ListAuthenticationsPluginProvides
-> = ({ sdk, context }) => {
+> = ({ context }) => {
   const listAuthentications = createPaginatedFunction(
     async function listAuthenticationsPage(
       options: ListAuthenticationsOptions & { cursor?: string } & {
         pageSize: number;
       },
     ): Promise<ListAuthenticationsPage> {
-      const { api } = context;
-
+      const { api, getVersionedImplementationId } = context;
       // Build search parameters
       const searchParams: Record<string, string> = {};
 
       // Handle appKey filtering by getting the selected_api first
       if (options.appKey) {
-        const app = await sdk.getApp({
-          appKey: options.appKey,
-        });
-
-        const selectedApi = app.data.current_implementation_id;
-        if (selectedApi) {
-          // Use versionless_selected_api to find auths across all app versions
-          // Extract the base name without the version (e.g., "SlackCLIAPI" from "SlackCLIAPI@1.21.1")
-          const versionlessApi = selectedApi.split("@")[0];
-          searchParams.versionless_selected_api = versionlessApi;
+        const implementationId = await getVersionedImplementationId(
+          options.appKey,
+        );
+        if (implementationId) {
+          const [versionlessSelectedApi] = splitVersionedKey(implementationId);
+          searchParams.versionless_selected_api = versionlessSelectedApi;
         }
       }
 
@@ -81,7 +83,7 @@ export const listAuthenticationsPlugin: Plugin<
         // Convert cursor back to offset for the API
         searchParams.offset = options.cursor;
       }
-
+      console.log({ searchParams });
       const data: AuthenticationsResponse = await api.get(
         "/api/v4/authentications/",
         {
@@ -128,6 +130,7 @@ export const listAuthenticationsPlugin: Plugin<
     context: {
       meta: {
         listAuthentications: {
+          categories: ["authentication"],
           inputSchema: ListAuthenticationsSchema,
         },
       },

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

@@ -47,7 +47,7 @@ const mockNeedsResponse: NeedsResponse = {
 
 describe("listInputFields plugin", () => {
   let mockApiClient: ApiClient;
-  let mockGetApp: any;
+  let mockGetVersionedImplementationId: any;
 
   beforeEach(() => {
     vi.clearAllMocks();
@@ -55,15 +55,20 @@ describe("listInputFields plugin", () => {
       post: vi.fn().mockResolvedValue(mockNeedsResponse),
     } as Partial<ApiClient> as ApiClient;
 
-    mockGetApp = vi.fn().mockResolvedValue({
-      data: { current_implementation_id: "SlackCLIAPI@1.21.1" },
-    });
+    mockGetVersionedImplementationId = vi
+      .fn()
+      .mockResolvedValue("SlackCLIAPI@1.21.1");
   });
 
   function createTestSdk() {
     return createSdk(
-      { getApp: mockGetApp },
-      { api: mockApiClient, meta: {} },
+      {},
+      {},
+      {
+        api: mockApiClient,
+        meta: {},
+        getVersionedImplementationId: mockGetVersionedImplementationId,
+      },
     ).addPlugin(listInputFieldsPlugin as any);
   }
 
@@ -303,9 +308,7 @@ describe("listInputFields plugin", () => {
 
   describe("error handling", () => {
     it("should throw ZapierConfigurationError when app has no current_implementation_id", async () => {
-      mockGetApp.mockResolvedValue({
-        data: { current_implementation_id: undefined },
-      });
+      mockGetVersionedImplementationId.mockResolvedValue(null);
 
       const sdk = createTestSdk();
       await expect(