@zapier/zapier-sdk 0.8.3 → 0.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/zapier-sdk",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "description": "Complete Zapier SDK - combines all Zapier SDK packages",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",

package/src/index.ts

@@ -17,7 +17,6 @@ export * from "./plugins/findUniqueAuthentication";
 export * from "./plugins/runAction";
 export * from "./plugins/request";
 export * from "./plugins/manifest";
-export * from "./plugins/lockVersion";
 export * from "./plugins/getProfile";
 export * from "./plugins/api";
 
@@ -74,6 +73,7 @@ export type {
   PluginDependencies,
   PluginOptions,
   GetSdkType,
+  GetContextType,
   Sdk,
 } from "./types/plugin";
 

package/src/plugins/apps/index.ts

@@ -1,5 +1,4 @@
-import type { ActionExecutionOptions } from "./types";
-import type { ActionProxy } from "./types";
+import type { ActionExecutionOptions, ActionProxy } from "./types";
 import { ZapierValidationError } from "../../types/errors";
 import type { Plugin, GetSdkType } from "../../types/plugin";
 import type { FetchPluginProvides } from "../fetch/index";
@@ -173,3 +172,11 @@ export const appsPlugin: Plugin<
     apps: createAppsProxy({ sdk }),
   };
 };
+
+// Export types for use in generated code
+export type { ActionExecutionOptions } from "./types";
+export type { ActionExecutionResult } from "../../api/types";
+
+// Interface for generated apps - will be augmented by generated .d.ts files
+// This interface will contain only the specifically typed apps
+export interface ZapierSdkApps {}

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

@@ -12,8 +12,8 @@ import { manifestPlugin } from "../manifest";
 function createTestSdk() {
   return createSdk()
     .addPlugin(apiPlugin, { fetch: global.fetch })
-    .addPlugin(listAppsPlugin)
     .addPlugin(manifestPlugin)
+    .addPlugin(listAppsPlugin)
     .addPlugin(getAppPlugin);
 }
 

package/src/plugins/getApp/index.ts

@@ -5,8 +5,7 @@ import type { GetAppOptions } from "./schemas";
 import type { AppItem } from "../../types/domain";
 import { ZapierAppNotFoundError } from "../../types/errors";
 import type { GetSdkType } from "../../types/plugin";
-import type { GetImplementation } from "../manifest/schemas";
-import type { ManifestPluginProvides } from "../manifest";
+import type { ListAppsPluginProvides } from "../listApps";
 
 // GetApp plugin provides interface - getApp goes directly to SDK root
 export interface GetAppPluginProvides {
@@ -22,21 +21,20 @@ export interface GetAppPluginProvides {
 
 // GetApp plugin depends on listApps SDK function
 export const getAppPlugin: Plugin<
-  GetSdkType<ManifestPluginProvides>, // depends on manifest plugin with getImplementation in context
-  { getImplementation: GetImplementation }, //
+  GetSdkType<ListAppsPluginProvides>,
+  {},
   GetAppPluginProvides
-> = ({ context }) => {
+> = ({ sdk }) => {
   const getApp = createFunction(async function getApp(options: GetAppOptions) {
-    const app = await context.getImplementation(options.appKey);
-    if (!app) {
-      throw new ZapierAppNotFoundError("App not found", {
-        appKey: options.appKey,
-      });
+    const appsIterator = sdk.listApps({ appKeys: [options.appKey] }).items();
+    for await (const app of appsIterator) {
+      return {
+        data: app,
+      };
     }
-
-    return {
-      data: app,
-    };
+    throw new ZapierAppNotFoundError("App not found", {
+      appKey: options.appKey,
+    });
   }, GetAppSchema);
 
   // Return flat structure - getApp goes directly to SDK

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

@@ -45,8 +45,8 @@ describe("getAuthentication plugin", () => {
   function createTestSdk() {
     return createSdk()
       .addPlugin(apiPlugin)
-      .addPlugin(listAppsPlugin)
       .addPlugin(manifestPlugin)
+      .addPlugin(listAppsPlugin)
       .addPlugin(getAuthenticationPlugin);
   }
 

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

@@ -68,6 +68,8 @@ describe("listActions plugin", () => {
       .mockResolvedValue("SlackCLIAPI@1.21.1");
   });
 
+  const mockResolveAppKeys = vi.fn().mockResolvedValue([]);
+
   function createTestSdk() {
     // Create a proper plugin chain with context dependencies
 
@@ -76,18 +78,17 @@ describe("listActions plugin", () => {
       .addPlugin(() => ({
         context: {
           api: mockApiClient,
-          getVersionedImplementationId: mockGetVersionedImplementationId,
         },
       }))
-      .addPlugin(listAppsPlugin)
       .addPlugin(() => ({
         context: {
           manifest: null,
-          getManifestEntry: () => null,
           getVersionedImplementationId: mockGetVersionedImplementationId,
-          getImplementation: () => Promise.resolve(null),
+          resolveAppKeys: mockResolveAppKeys,
+          updateManifestEntry: vi.fn().mockResolvedValue(["test-key", {}]),
         },
       }))
+      .addPlugin(listAppsPlugin)
       .addPlugin(listActionsPlugin);
   }
 
@@ -166,7 +167,7 @@ describe("listActions plugin", () => {
 
       expect(result.data).toHaveLength(2); // Only write actions
       expect(
-        result.data.every((action) => action.action_type === "write"),
+        result.data.every((action: any) => action.action_type === "write"),
       ).toBe(true);
     });
   });
@@ -309,9 +310,9 @@ describe("listActions plugin", () => {
 
       expect(result.data).toHaveLength(2);
       expect(
-        result.data.every((action) => action.action_type === "write"),
+        result.data.every((action: any) => action.action_type === "write"),
       ).toBe(true);
-      expect(result.data.map((action) => action.key)).toEqual([
+      expect(result.data.map((action: any) => action.key)).toEqual([
         "send_message",
         "create_channel",
       ]);

package/src/plugins/listActions/index.ts

@@ -32,11 +32,11 @@ export interface ListActionsPluginProvides {
 }
 
 export const listActionsPlugin: Plugin<
-  GetSdkType<ManifestPluginProvides>, // requires getApp in SDK
+  GetSdkType<ManifestPluginProvides>,
   {
     api: ApiClient;
     getVersionedImplementationId: GetVersionedImplementationId;
-  }, // requires api and getVersionedImplementationId in context
+  },
   ListActionsPluginProvides
 > = ({ context }) => {
   const listActions = createPaginatedFunction(async function listActionsPage(
@@ -44,7 +44,7 @@ export const listActionsPlugin: Plugin<
   ): Promise<ListActionsPage> {
     const { api, getVersionedImplementationId } = context;
 
-    // Use the getApp function from the SDK (dependency injection)
+    // Use getVersionedImplementationId (optimized to check manifest first)
     const selectedApi = await getVersionedImplementationId(options.appKey);
 
     if (!selectedApi) {

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

@@ -28,9 +28,26 @@ const mockAppsResponse = {
   },
 };
 
+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);
 }
 
@@ -100,7 +117,11 @@ describe("listApps plugin", () => {
       expect((context.api as any).get).toHaveBeenCalledWith(
         "/api/v4/implementations-meta/lookup/",
         {
-          searchParams: { latest_only: "true", limit: "100" },
+          searchParams: {
+            latest_only: "true",
+            limit: "100",
+            selected_apis: "",
+          },
         },
       );
     });
@@ -338,7 +359,7 @@ describe("listApps plugin", () => {
         expect.stringContaining("implementations-meta"),
         expect.objectContaining({
           searchParams: expect.objectContaining({
-            selected_apis: "SlackCLIAPI,GitHubCLIAPI",
+            selected_apis: "SlackCLIAPI@latest,GitHubCLIAPI@latest",
           }),
         }),
       );

package/src/plugins/listApps/index.ts

@@ -1,16 +1,19 @@
-import type { Plugin } from "../../types/plugin";
-import type { ApiClient } from "../../api/types";
+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 type { ResolvedAppLocator } from "../../utils/domain-utils";
 import {
-  groupAppKeysByType,
   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[] }> &
@@ -26,10 +29,9 @@ export interface ListAppsPluginProvides {
   };
 }
 
-// Direct plugin function - takes options + sdk + context in one object
 export const listAppsPlugin: Plugin<
-  {}, // no SDK dependencies
-  { api: ApiClient }, // requires api in context
+  {},
+  GetContextType<ApiPluginProvides & ManifestPluginProvides>,
   ListAppsPluginProvides
 > = ({ context }) => {
   const listApps = createPaginatedFunction(async function listAppsPage(
@@ -38,9 +40,28 @@ export const listAppsPlugin: Plugin<
     const api = context.api;
     const opts = options;
 
-    const appKeys = [...(opts.appKeys ?? [])].map(
-      (key) => splitVersionedKey(key)[0],
-    );
+    const appLocators = await context.resolveAppKeys({
+      appKeys: [...(opts.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 (opts.search) {
       const searchParams: Record<string, string> = {};
@@ -58,12 +79,18 @@ export const listAppsPlugin: Plugin<
         normalizeImplementationMetaToAppItem,
       );
 
-      const appKeysSet = new Set(appKeys);
+      const implementationNameSet = new Set<string>(
+        appLocators.map((locator) => locator.implementationName),
+      );
 
       for (const implementation of implementations) {
-        if (!appKeysSet.has(implementation.key)) {
-          appKeysSet.add(implementation.key);
-          appKeys.push(implementation.key);
+        const [implementationName] = splitVersionedKey(implementation.key);
+        if (!implementationNameSet.has(implementationName)) {
+          implementationNameSet.add(implementationName);
+          appLocators.push({
+            ...toAppLocator(implementation.key),
+            implementationName,
+          });
         }
       }
     }
@@ -74,23 +101,17 @@ export const listAppsPlugin: Plugin<
       searchParams.limit = opts.pageSize.toString();
     }
 
-    searchParams.latest_only = "true";
+    if (appLocators.length === 0) {
+      searchParams.latest_only = "true";
+    }
 
     if (opts.cursor) {
       searchParams.offset = opts.cursor;
     }
 
-    if (appKeys.length > 0) {
-      const groupedAppKeys = groupAppKeysByType(appKeys);
-
-      if (groupedAppKeys.selectedApi.length > 0) {
-        searchParams.selected_apis = groupedAppKeys.selectedApi.join(",");
-      }
-
-      if (groupedAppKeys.slug.length > 0) {
-        searchParams.slugs = groupedAppKeys.slug.join(",");
-      }
-    }
+    searchParams.selected_apis = appLocators
+      .map((locator) => toImplementationId(locator))
+      .join(",");
 
     const implementationsEnvelope: ImplementationsMetaResponse = await api.get(
       "/api/v4/implementations-meta/lookup/",

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

@@ -6,7 +6,6 @@ import {
 import { listAuthenticationsPlugin } from "./index";
 import { createSdk } from "../../sdk";
 import type { ApiClient } from "../../api";
-import type { AppItem } from "../../types/domain";
 
 const mockAuthenticationsResponse = {
   results: [
@@ -42,15 +41,6 @@ const mockAuthenticationsResponse = {
   previous: null,
 };
 
-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 mockGetVersionedImplementationId: any;
@@ -72,15 +62,14 @@ describe("listAuthentications plugin", () => {
     },
   });
 
+  const mockResolveAppKeys = vi.fn().mockResolvedValue([]);
+
   const manifestPlugin = () => ({
     context: {
       manifest: null,
       getVersionedImplementationId: mockGetVersionedImplementationId,
-      getManifestEntry: () => ({
-        implementationName: "SlackCLIAPI",
-        version: "1.21.1",
-      }),
-      getImplementation: vi.fn().mockResolvedValue(mockSlackApp),
+      resolveAppKeys: mockResolveAppKeys,
+      updateManifestEntry: vi.fn().mockResolvedValue(["test-key", {}]),
     },
   });
 
@@ -152,6 +141,21 @@ describe("listAuthentications plugin", () => {
       }).toThrow(ZapierValidationError);
     });
 
+    it("should throw validation error for invalid authenticationIds type", () => {
+      const sdk = createTestSdk();
+      expect(() => {
+        sdk.listAuthentications({
+          authenticationIds: "123" as any, // Should be array of strings
+        });
+      }).toThrow(ZapierValidationError);
+
+      expect(() => {
+        sdk.listAuthentications({
+          authenticationIds: [123] as any, // Should be array of strings, not numbers
+        });
+      }).toThrow(ZapierValidationError);
+    });
+
     it("should throw validation error for invalid pageSize", () => {
       const sdk = createTestSdk();
       expect(() => {
@@ -186,6 +190,7 @@ describe("listAuthentications plugin", () => {
       const sdk = createTestSdk();
       const result = await sdk.listAuthentications({
         appKey: "slack",
+        authenticationIds: ["123", "456"],
         search: "workspace",
         title: "My Slack Workspace",
         accountId: "acc_123",
@@ -336,6 +341,38 @@ describe("listAuthentications plugin", () => {
         }),
       );
     });
+
+    it("should pass authenticationIds as ids parameter to API", async () => {
+      const sdk = createTestSdk();
+      await sdk.listAuthentications({
+        authenticationIds: ["123", "456", "789"],
+      });
+
+      expect(mockApiClient.get).toHaveBeenCalledWith(
+        "/api/v4/authentications/",
+        expect.objectContaining({
+          searchParams: expect.objectContaining({
+            ids: "123,456,789",
+          }),
+        }),
+      );
+    });
+
+    it("should not include ids parameter when authenticationIds is empty", async () => {
+      const sdk = createTestSdk();
+      await sdk.listAuthentications({
+        authenticationIds: [],
+      });
+
+      expect(mockApiClient.get).toHaveBeenCalledWith(
+        "/api/v4/authentications/",
+        expect.objectContaining({
+          searchParams: expect.not.objectContaining({
+            ids: expect.anything(),
+          }),
+        }),
+      );
+    });
   });
 
   describe("pagination", () => {

package/src/plugins/listAuthentications/index.ts

@@ -36,11 +36,11 @@ export interface ListAuthenticationsPluginProvides {
 }
 
 export const listAuthenticationsPlugin: Plugin<
-  GetSdkType<ManifestPluginProvides>, // requires getApp in SDK
+  GetSdkType<ManifestPluginProvides>,
   {
     api: ApiClient;
     getVersionedImplementationId: GetVersionedImplementationId;
-  }, // requires api in context
+  },
   ListAuthenticationsPluginProvides
 > = ({ context }) => {
   const listAuthentications = createPaginatedFunction(
@@ -64,6 +64,11 @@ export const listAuthenticationsPlugin: Plugin<
         }
       }
 
+      // Add authenticationIds as ids parameter if provided
+      if (options.authenticationIds && options.authenticationIds.length > 0) {
+        searchParams.ids = options.authenticationIds.join(",");
+      }
+
       // Add other query parameters if provided
       // Use title as search if no explicit search provided
       if (options.search) {

package/src/plugins/listAuthentications/schemas.ts

@@ -16,6 +16,10 @@ export const ListAuthenticationsSchema = z
     appKey: AppKeyPropertySchema.optional().describe(
       "App key of authentications to list (e.g., 'SlackCLIAPI')",
     ),
+    authenticationIds: z
+      .array(z.string())
+      .optional()
+      .describe("List of authentication IDs to filter by"),
     search: z
       .string()
       .optional()