@zapier/zapier-sdk 0.6.4 → 0.8.0

package/dist/plugins/listInputFieldChoices/schemas.js

@@ -0,0 +1,73 @@
+import { z } from "zod";
+import { AuthenticationIdPropertySchema, AppKeyPropertySchema, ActionTypePropertySchema, ActionKeyPropertySchema, InputsPropertySchema, } from "../../types/properties";
+import { withFormatter, withOutputSchema } from "../../utils/schema-utils";
+// ============================================================================
+// Input Field Choice Item Schema
+// ============================================================================
+export const InputFieldChoiceItemSchema = withFormatter(z.object({
+    key: z.string().optional().describe("Unique key/value for the choice"),
+    label: z
+        .string()
+        .optional()
+        .describe("Human readable label for the choice"),
+    sample: z.string().optional().describe("Sample value for the choice"),
+    value: z
+        .string()
+        .optional()
+        .describe("Value to be submitted when selected"),
+}), {
+    format: (item) => {
+        const title = item.label || item.key || "Choice";
+        const subtitle = item.label && item.key && item.label !== item.key
+            ? `(${item.key})`
+            : undefined;
+        const details = [];
+        if (item.sample && item.sample !== item.key) {
+            details.push({ text: `Sample: ${item.sample}`, style: "dim" });
+        }
+        if (item.value && item.value !== item.key) {
+            details.push({ text: `Value: ${item.value}`, style: "normal" });
+        }
+        return {
+            title,
+            subtitle,
+            details,
+        };
+    },
+});
+// ============================================================================
+// Plugin Schema Definition
+// ============================================================================
+export const ListInputFieldChoicesSchema = withOutputSchema(z
+    .object({
+    // Required action identification
+    appKey: AppKeyPropertySchema,
+    actionType: ActionTypePropertySchema,
+    actionKey: ActionKeyPropertySchema,
+    // Input field specification
+    inputFieldKey: z
+        .string()
+        .min(1)
+        .describe("Input field key to get choices for."),
+    // Common parameters
+    authenticationId: AuthenticationIdPropertySchema.nullable().optional(),
+    inputs: InputsPropertySchema.optional().describe("Current input values that may affect available choices"),
+    page: z
+        .number()
+        .int()
+        .min(0)
+        .optional()
+        .describe("Page number for paginated results"),
+    // Pagination options (SDK-level)
+    pageSize: z
+        .number()
+        .min(1)
+        .optional()
+        .describe("Number of choices per page"),
+    maxItems: z
+        .number()
+        .min(1)
+        .optional()
+        .describe("Maximum total items to return across all pages"),
+})
+    .describe("Get the available choices for a dynamic dropdown input field"), InputFieldChoiceItemSchema);

package/dist/sdk.d.ts

@@ -6,7 +6,7 @@ export interface ZapierSdkOptions extends BaseSdkOptions {
 export declare function createSdk<TCurrentSdk = {}, TCurrentContext = {
     meta: Record<string, PluginMeta>;
 }>(options?: ZapierSdkOptions, initialSdk?: TCurrentSdk, initialContext?: TCurrentContext): Sdk<TCurrentSdk, TCurrentContext>;
-export declare function createZapierSdkWithoutRegistry(options?: ZapierSdkOptions): Sdk<import("./types/plugin").ExtractSdkProperties<import(".").ApiPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ListAppsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ManifestPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").GetAppPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ListActionsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").GetActionPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ListInputFieldsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").RunActionPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").LockVersionPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ListAuthenticationsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").GetAuthenticationPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").FindFirstAuthenticationPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").FindUniqueAuthenticationPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").RequestPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").FetchPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").AppsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").GetProfilePluginProvides>, {
+export declare function createZapierSdkWithoutRegistry(options?: ZapierSdkOptions): Sdk<import("./types/plugin").ExtractSdkProperties<import(".").ApiPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ListAppsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ManifestPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").GetAppPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ListActionsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").GetActionPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ListInputFieldsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import("./plugins/listInputFieldChoices").ListInputFieldChoicesPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").RunActionPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").LockVersionPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").ListAuthenticationsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").GetAuthenticationPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").FindFirstAuthenticationPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").FindUniqueAuthenticationPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").RequestPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").FetchPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").AppsPluginProvides> & import("./types/plugin").ExtractSdkProperties<import(".").GetProfilePluginProvides>, {
     meta: Record<string, PluginMeta>;
 } & {
     api: import("./api").ApiClient;
@@ -44,6 +44,12 @@ export declare function createZapierSdkWithoutRegistry(options?: ZapierSdkOption
             inputSchema: typeof import("./plugins/listInputFields/schemas").ListInputFieldsSchema;
         };
     };
+} & {
+    meta: {
+        listInputFieldChoices: {
+            inputSchema: typeof import("./plugins/listInputFieldChoices/schemas").ListInputFieldChoicesSchema;
+        };
+    };
 } & {
     meta: {
         runAction: {

package/dist/sdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAM7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EACV,GAAG,EAIH,UAAU,EACX,MAAM,gBAAgB,CAAC;AAyBxB,MAAM,WAAW,gBAAiB,SAAQ,cAAc;CAAG;AAG3D,wBAAgB,SAAS,CACvB,WAAW,GAAG,EAAE,EAChB,eAAe,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;CAAE,EAEtD,OAAO,GAAE,gBAAqB,EAC9B,UAAU,GAAE,WAA+B,EAC3C,cAAc,GAAE,eAAiD,GAChE,GAAG,CAAC,WAAW,EAAE,eAAe,CAAC,CAqEnC;AAED,wBAAgB,8BAA8B,CAAC,OAAO,GAAE,gBAAqB;UA5EjD,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkHrD;AAED,wBAAgB,eAAe,CAAC,OAAO,GAAE,gBAAqB,GAAG,SAAS,CAMzE"}
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAM7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EACV,GAAG,EAIH,UAAU,EACX,MAAM,gBAAgB,CAAC;AA0BxB,MAAM,WAAW,gBAAiB,SAAQ,cAAc;CAAG;AAG3D,wBAAgB,SAAS,CACvB,WAAW,GAAG,EAAE,EAChB,eAAe,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;CAAE,EAEtD,OAAO,GAAE,gBAAqB,EAC9B,UAAU,GAAE,WAA+B,EAC3C,cAAc,GAAE,eAAiD,GAChE,GAAG,CAAC,WAAW,EAAE,eAAe,CAAC,CAqEnC;AAED,wBAAgB,8BAA8B,CAAC,OAAO,GAAE,gBAAqB;UA5EjD,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmHrD;AAED,wBAAgB,eAAe,CAAC,OAAO,GAAE,gBAAqB,GAAG,SAAS,CAMzE"}

package/dist/sdk.js

@@ -14,6 +14,7 @@ import { getAuthenticationPlugin } from "./plugins/getAuthentication";
 import { findFirstAuthenticationPlugin } from "./plugins/findFirstAuthentication";
 import { findUniqueAuthenticationPlugin } from "./plugins/findUniqueAuthentication";
 import { listInputFieldsPlugin } from "./plugins/listInputFields";
+import { listInputFieldChoicesPlugin } from "./plugins/listInputFieldChoices";
 import { requestPlugin } from "./plugins/request";
 import { manifestPlugin } from "./plugins/manifest";
 import { lockVersionPlugin } from "./plugins/lockVersion";
@@ -84,6 +85,7 @@ export function createZapierSdkWithoutRegistry(options = {}) {
         .addPlugin(listActionsPlugin)
         .addPlugin(getActionPlugin)
         .addPlugin(listInputFieldsPlugin)
+        .addPlugin(listInputFieldChoicesPlugin)
         // Run action
         .addPlugin(runActionPlugin)
         // Version locking

package/package.json

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

package/src/api/schemas.ts

@@ -385,3 +385,65 @@ export const ImplementationsMetaResponseSchema = z.object({
   previous: z.string().nullable().optional(),
   results: z.array(ImplementationMetaSchema),
 });
+
+// ============================================================================
+// Need Choices Schemas (for listInputFieldChoices functionality)
+// ============================================================================
+
+export const NeedChoicesResponseMetaSchema = z.object({
+  page: z.string().nullable().optional(),
+});
+
+export const NeedChoicesResponseLinksSchema = z.object({
+  next: z.string().nullable().optional(),
+  prev: z.string().nullable().optional(),
+});
+
+export const NeedChoicesRequestSchema = z.object({
+  selected_api: z
+    .string()
+    .optional()
+    .describe(
+      "Something like `SlackAPI` (for Python apps) or `SplitwiseCLIAPI@1.0.0` (for CLI apps). Non-public apps are fine as long as the authed user can access them.",
+    ),
+  authentication_id: z
+    .number()
+    .optional()
+    .describe(
+      "If the app needs auth, provide an `authentication_id` that has the `selected_api` of the app you want to run. Can be any auth visible to the user (including shared).",
+    ),
+  params: z
+    .record(z.any())
+    .optional()
+    .describe(
+      "Object that matches the input the node would normally get. Has all the same keys/types as the `needs` of the action.",
+    ),
+  page: z.number().optional().default(0),
+  prefill: z
+    .string()
+    .optional()
+    .describe(
+      "The prefill string to indicate what we're fetching choices for. Likely something like `spreadsheet.id.title`. Must be provided alongside `selected_api` if both `action_id` and `input_field_id` are not.",
+    ),
+  action_id: z
+    .string()
+    .optional()
+    .describe(
+      "The id that will be used to lookup the Action for prefill lookup. If provided, `input_field_id` is required, else `prefill` must be provided.",
+    ),
+  input_field_id: z
+    .string()
+    .optional()
+    .describe(
+      "The id (key) of the input field (Need) that dynamic choices are being retrieved for. If provided, `action_id` is required, else `prefill` must be provided.",
+    ),
+});
+
+export const NeedChoicesResponseSchema = z.object({
+  success: z.boolean(),
+  choices: z.array(NeedChoicesSchema).optional(),
+  next_page: z.number().optional(),
+  errors: z.array(z.string()).optional(),
+  meta: NeedChoicesResponseMetaSchema.optional(),
+  links: NeedChoicesResponseLinksSchema.optional(),
+});

package/src/api/types.ts

@@ -33,6 +33,10 @@ import {
   ImplementationsMetaResponseSchema,
   ServiceSchema,
   ServicesResponseSchema,
+  NeedChoicesRequestSchema,
+  NeedChoicesResponseSchema,
+  NeedChoicesResponseMetaSchema,
+  NeedChoicesResponseLinksSchema,
 } from "./schemas";
 
 // ============================================================================
@@ -136,3 +140,13 @@ export type ImplementationMeta = z.infer<typeof ImplementationMetaSchema>;
 export type ImplementationsMetaResponse = z.infer<
   typeof ImplementationsMetaResponseSchema
 >;
+
+// Need Choices types (for listInputFieldChoices functionality)
+export type NeedChoicesRequest = z.infer<typeof NeedChoicesRequestSchema>;
+export type NeedChoicesResponse = z.infer<typeof NeedChoicesResponseSchema>;
+export type NeedChoicesResponseMeta = z.infer<
+  typeof NeedChoicesResponseMetaSchema
+>;
+export type NeedChoicesResponseLinks = z.infer<
+  typeof NeedChoicesResponseLinksSchema
+>;

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

@@ -97,7 +97,7 @@ describe("findFirstAuthentication plugin", () => {
       await expect(
         sdk.findFirstAuthentication({
           title: 123 as any,
-          account_id: 456 as any,
+          accountId: 456 as any,
           owner: true as any,
         }),
       ).rejects.toThrow(ZapierValidationError);
@@ -109,7 +109,7 @@ describe("findFirstAuthentication plugin", () => {
         appKey: "slack",
         search: "workspace",
         title: "My Slack Workspace",
-        account_id: "acc_123",
+        accountId: "acc_123",
         owner: "me",
       });
 
@@ -167,7 +167,7 @@ describe("findFirstAuthentication plugin", () => {
         appKey: "slack",
         search: "workspace",
         title: "My Slack Workspace",
-        account_id: "acc_123",
+        accountId: "acc_123",
         owner: "me",
       };
 

package/src/plugins/findFirstAuthentication/schemas.ts

@@ -16,7 +16,7 @@ export const FindFirstAuthenticationSchema = z
       .string()
       .optional()
       .describe("Filter authentications by exact title match"),
-    account_id: z.string().optional().describe("Filter by account ID"),
+    accountId: z.string().optional().describe("Filter by account ID"),
     owner: z.string().optional().describe("Filter by owner"),
   })
   .describe("Find the first authentication matching the criteria");

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

@@ -88,7 +88,7 @@ describe("findUniqueAuthentication plugin", () => {
         sdk.findUniqueAuthentication({
           search: 123 as any,
           title: 456 as any,
-          account_id: 789 as any,
+          accountId: 789 as any,
           owner: false as any,
         }),
       ).rejects.toThrow(ZapierValidationError);
@@ -100,7 +100,7 @@ describe("findUniqueAuthentication plugin", () => {
         appKey: "slack",
         search: "Workspace",
         title: "My Slack",
-        account_id: "acc_123",
+        accountId: "acc_123",
         owner: "me",
       });
 
@@ -172,7 +172,7 @@ describe("findUniqueAuthentication plugin", () => {
         appKey: "slack",
         search: "workspace",
         title: "My Slack Workspace",
-        account_id: "acc_123",
+        accountId: "acc_123",
         owner: "me",
       };
 

package/src/plugins/findUniqueAuthentication/schemas.ts

@@ -16,7 +16,7 @@ export const FindUniqueAuthenticationSchema = z
       .string()
       .optional()
       .describe("Filter authentications by exact title match"),
-    account_id: z.string().optional().describe("Filter by account ID"),
+    accountId: z.string().optional().describe("Filter by account ID"),
     owner: z.string().optional().describe("Filter by owner"),
   })
   .describe("Find a unique authentication matching the criteria");

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

@@ -134,11 +134,11 @@ describe("listAuthentications plugin", () => {
       }).toThrow(ZapierValidationError);
     });
 
-    it("should throw validation error for invalid account_id type", () => {
+    it("should throw validation error for invalid accountId type", () => {
       const sdk = createTestSdk();
       expect(() => {
         sdk.listAuthentications({
-          account_id: 123 as any,
+          accountId: 123 as any,
         });
       }).toThrow(ZapierValidationError);
     });
@@ -188,7 +188,7 @@ describe("listAuthentications plugin", () => {
         appKey: "slack",
         search: "workspace",
         title: "My Slack Workspace",
-        account_id: "acc_123",
+        accountId: "acc_123",
         owner: "me",
         pageSize: 10,
         maxItems: 50,
@@ -309,9 +309,9 @@ describe("listAuthentications plugin", () => {
       );
     });
 
-    it("should pass account_id filter to API", async () => {
+    it("should pass accountId filter to API", async () => {
       const sdk = createTestSdk();
-      await sdk.listAuthentications({ account_id: "acc_123" });
+      await sdk.listAuthentications({ accountId: "acc_123" });
 
       expect(mockApiClient.get).toHaveBeenCalledWith(
         "/api/v4/authentications/",

package/src/plugins/listAuthentications/index.ts

@@ -71,8 +71,8 @@ export const listAuthenticationsPlugin: Plugin<
       } else if (options.title) {
         searchParams.search = options.title;
       }
-      if (options.account_id) {
-        searchParams.account_id = options.account_id;
+      if (options.accountId) {
+        searchParams.account_id = options.accountId;
       }
       if (options.owner) {
         searchParams.owner = options.owner;
@@ -83,7 +83,6 @@ 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/",
         {

package/src/plugins/listAuthentications/schemas.ts

@@ -17,7 +17,7 @@ export const ListAuthenticationsSchema = z
       .string()
       .optional()
       .describe("Filter authentications by exact title match"),
-    account_id: z.string().optional().describe("Filter by account ID"),
+    accountId: z.string().optional().describe("Filter by account ID"),
     owner: z.string().optional().describe("Filter by owner"),
     pageSize: z
       .number()