@zapier/zapier-sdk 0.13.5 → 0.13.7

package/src/plugins/listInputFieldChoices/index.ts

@@ -1,173 +0,0 @@
-import type { Plugin, GetSdkType } from "../../types/plugin";
-import type { ApiClient } from "../../api";
-import type {
-  NeedChoicesRequest,
-  NeedChoicesResponse,
-  NeedChoices,
-} from "../../api/types";
-import type { InputFieldChoiceItem } from "./schemas";
-import {
-  ListInputFieldChoicesSchema,
-  type ListInputFieldChoicesOptions,
-  type ListInputFieldChoicesPage,
-  InputFieldChoiceItemSchema,
-} from "./schemas";
-import { ZapierApiError } from "../../types/errors";
-import { createPaginatedFunction } from "../../utils/function-utils";
-import type { GetActionPluginProvides } from "../getAction";
-import {
-  appKeyResolver,
-  actionTypeResolver,
-  actionKeyResolver,
-  authenticationIdResolver,
-  inputFieldKeyResolver,
-  inputsAllOptionalResolver,
-} from "../../resolvers";
-
-// Transform NeedChoices to InputFieldChoiceItem
-function transformNeedChoicesToInputFieldChoiceItem(
-  choice: NeedChoices,
-): InputFieldChoiceItem {
-  return {
-    key: choice.key,
-    label: choice.label,
-    sample: choice.sample,
-    value: choice.value,
-  };
-}
-
-export interface ListInputFieldChoicesPluginProvides {
-  listInputFieldChoices: (options: ListInputFieldChoicesOptions) => Promise<{
-    data: InputFieldChoiceItem[];
-    nextCursor?: string;
-  }> &
-    AsyncIterable<{ data: InputFieldChoiceItem[]; nextCursor?: string }> & {
-      items(): AsyncIterable<InputFieldChoiceItem>;
-    };
-  context: {
-    meta: {
-      listInputFieldChoices: {
-        inputSchema: typeof ListInputFieldChoicesSchema;
-      };
-    };
-  };
-}
-
-export const listInputFieldChoicesPlugin: Plugin<
-  GetSdkType<GetActionPluginProvides>, // requires getAction in SDK
-  { api: ApiClient }, // requires api in context
-  ListInputFieldChoicesPluginProvides
-> = ({ context, sdk }) => {
-  const listInputFieldChoices = createPaginatedFunction<
-    ListInputFieldChoicesOptions & { cursor?: string },
-    ListInputFieldChoicesPage,
-    ListInputFieldChoicesOptions
-  >(async function listInputFieldChoicesPage(
-    options: ListInputFieldChoicesOptions & { cursor?: string } & {
-      pageSize: number;
-    },
-  ): Promise<ListInputFieldChoicesPage> {
-    const { api } = context;
-
-    // Extract parameters
-    const {
-      appKey,
-      actionType,
-      actionKey,
-      inputFieldKey,
-      authenticationId,
-      inputs,
-      page,
-      cursor,
-    } = options;
-
-    // Use sdk.getAction to get the action ID
-    const actionResult = await sdk.getAction({ appKey, actionType, actionKey });
-    const actionId = actionResult.data.id;
-
-    if (!actionId) {
-      throw new ZapierApiError(
-        `Action ${actionKey} does not have an ID - cannot retrieve input field choices`,
-      );
-    }
-
-    // Build choices request using action ID from getAction
-    // Use cursor (from pagination) as page number if available, otherwise use explicit page or default to 0
-    const requestPage = cursor ? parseInt(cursor, 10) : (page ?? 0);
-    const choicesRequest: NeedChoicesRequest = {
-      action_id: actionId,
-      input_field_id: inputFieldKey,
-      page: requestPage,
-      params: inputs || {},
-    };
-
-    // Only include authentication_id if it's not null (skip authentication when null)
-    if (authenticationId !== null) {
-      choicesRequest.authentication_id = authenticationId;
-    }
-
-    const choicesData: NeedChoicesResponse = await api.post(
-      "/api/v4/implementations/choices/",
-      choicesRequest,
-    );
-
-    if (!choicesData.success) {
-      throw new ZapierApiError(
-        `Failed to get input field choices: ${
-          choicesData.errors?.join(", ") || "Unknown error"
-        }`,
-      );
-    }
-
-    // Transform NeedChoices objects to InputFieldChoiceItem objects
-    const choices: InputFieldChoiceItem[] = (choicesData.choices || []).map(
-      transformNeedChoicesToInputFieldChoiceItem,
-    );
-
-    // Handle pagination
-    let nextCursor: string | undefined;
-    if (choicesData.next_page != null) {
-      nextCursor = choicesData.next_page.toString();
-    } else if (choicesData.links?.next) {
-      // Extract page from next URL for external actions
-      try {
-        const nextUrl = new URL(choicesData.links.next);
-        const nextPage = nextUrl.searchParams.get("page");
-        if (nextPage) {
-          nextCursor = nextPage;
-        }
-      } catch {
-        // Handle malformed URLs gracefully by not setting nextCursor
-        nextCursor = undefined;
-      }
-    }
-
-    return {
-      data: choices,
-      nextCursor,
-    };
-  }, ListInputFieldChoicesSchema);
-
-  return {
-    listInputFieldChoices,
-    context: {
-      meta: {
-        listInputFieldChoices: {
-          categories: ["action"],
-          type: "list",
-          itemType: "InputFieldChoice",
-          inputSchema: ListInputFieldChoicesSchema,
-          outputSchema: InputFieldChoiceItemSchema,
-          resolvers: {
-            appKey: appKeyResolver,
-            actionType: actionTypeResolver,
-            actionKey: actionKeyResolver,
-            authenticationId: authenticationIdResolver,
-            inputFieldKey: inputFieldKeyResolver,
-            inputs: inputsAllOptionalResolver,
-          },
-        },
-      },
-    },
-  };
-};

package/src/plugins/listInputFieldChoices/schemas.ts

@@ -1,125 +0,0 @@
-import { z } from "zod";
-import {
-  AuthenticationIdPropertySchema,
-  AppKeyPropertySchema,
-  ActionTypePropertySchema,
-  ActionKeyPropertySchema,
-  InputsPropertySchema,
-} from "../../types/properties";
-import { withFormatter } from "../../utils/schema-utils";
-import { NeedChoicesSchema } from "../../api/schemas";
-import type { PaginatedSdkFunction } from "../../types/functions";
-import type {
-  ZapierConfigurationError,
-  ZapierApiError,
-  ZapierAuthenticationError,
-  ZapierAppNotFoundError,
-  ZapierValidationError,
-  ZapierUnknownError,
-} from "../../types/errors";
-
-// ============================================================================
-// Input Field Choice Item Schema
-// ============================================================================
-
-export const InputFieldChoiceItemSchema = withFormatter(NeedChoicesSchema, {
-  format: (item) => {
-    const title = item.label || item.key || "Choice";
-    const details: Array<{
-      text: string;
-      style: "success" | "dim" | "normal" | "accent" | "warning";
-    }> = [];
-
-    // Show key as detail if different from label
-    if (item.label && item.key && item.label !== item.key) {
-      details.push({ text: `Key: ${item.key}`, style: "dim" });
-    }
-
-    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,
-      key: item.key,
-      details,
-    };
-  },
-});
-
-export type InputFieldChoiceItem = z.infer<typeof InputFieldChoiceItemSchema>;
-
-// ============================================================================
-// Plugin Schema Definition
-// ============================================================================
-
-export const ListInputFieldChoicesSchema = 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"),
-    cursor: z.string().optional().describe("Cursor to start from"),
-  })
-  .describe("Get the available choices for a dynamic dropdown input field");
-
-// Type inferred from schema
-export type ListInputFieldChoicesOptions = z.infer<
-  typeof ListInputFieldChoicesSchema
->;
-
-// Error union for this function
-export type ListInputFieldChoicesError =
-  | ZapierConfigurationError
-  | ZapierApiError
-  | ZapierAuthenticationError
-  | ZapierAppNotFoundError
-  | ZapierValidationError
-  | ZapierUnknownError;
-
-// Page result structure
-export interface ListInputFieldChoicesPage {
-  data: InputFieldChoiceItem[];
-  nextCursor?: string;
-}
-
-// SDK function interface
-export interface ListInputFieldChoicesSdkFunction {
-  listInputFieldChoices: PaginatedSdkFunction<
-    ListInputFieldChoicesOptions,
-    InputFieldChoiceItem
-  >;
-}