@zapier/zapier-sdk 0.23.2 → 0.25.0

package/dist/index.d.mts

@@ -60,6 +60,12 @@ interface PluginProvides extends Record<string, any> {
     context?: Record<string, any>;
 }
 interface PluginMeta {
+    /**
+     * Human-readable description of the plugin function. Used by the CLI (help text),
+     * MCP (tool description), and README generators. When omitted, falls back to
+     * the inputSchema's `.describe()` value or a generic placeholder.
+     */
+    description?: string;
     categories: string[];
     type?: "list" | "item" | "create" | "delete";
     itemType?: string;
@@ -1128,7 +1134,6 @@ declare const RelayRequestSchema: z.ZodObject<{
     callbackUrl: z.ZodOptional<z.ZodString>;
     authenticationTemplate: z.ZodOptional<z.ZodString>;
     headers: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodCustom<Headers, Headers>, z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>>]>>;
-    relayBaseUrl: z.ZodOptional<z.ZodString>;
     _telemetry: z.ZodOptional<z.ZodObject<{
         isNested: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>;
@@ -1150,7 +1155,6 @@ declare const RelayFetchSchema: z.ZodObject<{
     callbackUrl: z.ZodOptional<z.ZodString>;
     authenticationTemplate: z.ZodOptional<z.ZodString>;
     headers: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodCustom<Headers, Headers>, z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>>]>>;
-    relayBaseUrl: z.ZodOptional<z.ZodString>;
     _telemetry: z.ZodOptional<z.ZodObject<{
         isNested: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>;
@@ -1226,6 +1230,7 @@ declare const OffsetPropertySchema: z.ZodDefault<z.ZodNumber>;
 declare const OutputPropertySchema: z.ZodString;
 declare const DebugPropertySchema: z.ZodDefault<z.ZodBoolean>;
 declare const ParamsPropertySchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+declare const ActionTimeoutMsPropertySchema: z.ZodOptional<z.ZodNumber>;
 type AppKeyProperty = z.infer<typeof AppKeyPropertySchema>;
 type ActionTypeProperty = z.infer<typeof ActionTypePropertySchema>;
 type ActionKeyProperty = z.infer<typeof ActionKeyPropertySchema>;
@@ -1236,10 +1241,12 @@ type OffsetProperty = z.infer<typeof OffsetPropertySchema>;
 type OutputProperty = z.infer<typeof OutputPropertySchema>;
 type DebugProperty = z.infer<typeof DebugPropertySchema>;
 type ParamsProperty = z.infer<typeof ParamsPropertySchema>;
+type ActionTimeoutMsProperty = z.infer<typeof ActionTimeoutMsPropertySchema>;
 
 declare const ActionExecutionInputSchema: z.ZodObject<{
     inputs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     authenticationId: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    timeoutMs: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 type ActionExecutionOptions = z.infer<typeof ActionExecutionInputSchema>;
 declare const AppFactoryInputSchema: z.ZodObject<{
@@ -1276,32 +1283,19 @@ interface ActionProxy {
     [app: string]: AppProxyWithFactory;
 }
 
-interface RequestPluginProvides {
-    request: (options: RelayRequestOptions) => Promise<Response>;
-    context: {
-        meta: {
-            request: {
-                inputSchema: typeof RelayRequestSchema;
-            };
-        };
-    };
-}
-declare const requestPlugin: Plugin<{}, // no SDK dependencies
-// no SDK dependencies
-{
-    api: ApiClient;
-} & EventEmissionContext, // requires api in context
-RequestPluginProvides>;
-
 interface FetchPluginProvides {
     fetch: (url: string | URL, init?: RequestInit & {
         authenticationId?: string | number;
         callbackUrl?: string;
         authenticationTemplate?: string;
+        _telemetry?: {
+            isNested?: boolean;
+        };
     }) => Promise<Response>;
     context: {
         meta: {
             fetch: {
+                description: string;
                 packages: string[];
                 categories: string[];
                 returnType: string;
@@ -1314,10 +1308,14 @@ interface FetchPluginProvides {
     };
 }
 /**
- * Direct plugin function - takes options + sdk + context in one object
+ * Fetch plugin — the primary way to make authenticated HTTP requests through Zapier's Relay service.
+ * Mirrors the native fetch(url, init?) signature with additional Zapier-specific options.
  */
-declare const fetchPlugin: Plugin<GetSdkType<RequestPluginProvides>, // requires request in SDK
-EventEmissionContext, // requires eventEmission context for telemetry
+declare const fetchPlugin: Plugin<{}, // no SDK dependencies
+// no SDK dependencies
+{
+    api: ApiClient;
+} & EventEmissionContext, // requires api + eventEmission in context
 FetchPluginProvides>;
 type ZapierFetchInitOptions = RequestInit & {
     authenticationId?: string | number;
@@ -1342,6 +1340,7 @@ declare const RunActionSchema: z.ZodObject<{
     actionKey: z.ZodString;
     authenticationId: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
     inputs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    timeoutMs: z.ZodOptional<z.ZodNumber>;
     pageSize: z.ZodOptional<z.ZodNumber>;
     maxItems: z.ZodOptional<z.ZodNumber>;
     cursor: z.ZodOptional<z.ZodString>;
@@ -1825,6 +1824,24 @@ interface ListInputFieldChoicesPluginProvides {
     };
 }
 
+interface RequestPluginProvides {
+    request: (options: RelayRequestOptions) => Promise<Response>;
+    context: {
+        meta: {
+            request: {
+                inputSchema: typeof RelayRequestSchema;
+            };
+        };
+    };
+}
+/**
+ * @deprecated Use `sdk.fetch(url, init?)` instead. This plugin now delegates to the fetch plugin
+ * and is kept only for backward compatibility. It is hidden from the CLI/MCP registries.
+ */
+declare const requestPlugin: Plugin<GetSdkType<FetchPluginProvides>, // requires fetch in SDK
+EventEmissionContext, // requires eventEmission context for telemetry
+RequestPluginProvides>;
+
 /**
  * SDK-related types and interfaces
  */
@@ -1854,6 +1871,12 @@ interface BaseSdkOptions {
 
 interface FunctionRegistryEntry {
     name: string;
+    /**
+     * Human-readable description of the function. Surfaced as CLI help text,
+     * MCP tool description, and README documentation. Prefer providing this
+     * directly rather than relying solely on inputSchema.describe().
+     */
+    description?: string;
     type?: "list" | "item" | "create" | "delete";
     itemType?: string;
     returnType?: string;
@@ -2081,9 +2104,9 @@ declare const AuthItemSchema: z.ZodObject<{
 type AuthItem = z.infer<typeof AuthItemSchema>;
 
 declare const ActionItemSchema: z.ZodObject<{
+    description: z.ZodString;
     key: z.ZodString;
     id: z.ZodOptional<z.ZodString>;
-    description: z.ZodString;
     is_important: z.ZodOptional<z.ZodBoolean>;
     is_hidden: z.ZodOptional<z.ZodBoolean>;
     app_key: z.ZodString;
@@ -2506,6 +2529,10 @@ declare const ZAPIER_BASE_URL: string;
  * Maximum number of items that can be requested per page across all paginated functions
  */
 declare const MAX_PAGE_LIMIT = 10000;
+/**
+ * Default timeout for action execution (in milliseconds)
+ */
+declare const DEFAULT_ACTION_TIMEOUT_MS = 180000;
 /**
  * Credentials from environment variables
  */
@@ -2533,7 +2560,7 @@ declare function createSdk<TCurrentSdk = {}, TCurrentContext extends {
         getContext(): TCurrentContext;
     }, TRequiresContext, TProvides>, addPluginOptions?: Record<string, unknown>): Sdk<TCurrentSdk & ExtractSdkProperties<TProvides>, TCurrentContext & NonNullable<ExtractContextProperties<TProvides>>>;
 };
-declare function createZapierSdkWithoutRegistry(options?: ZapierSdkOptions): Sdk<ExtractSdkProperties<EventEmissionProvides> & ExtractSdkProperties<ApiPluginProvides> & ExtractSdkProperties<ManifestPluginProvides> & ExtractSdkProperties<ListAppsPluginProvides> & ExtractSdkProperties<GetAppPluginProvides> & ExtractSdkProperties<ListActionsPluginProvides> & ExtractSdkProperties<GetActionPluginProvides> & ExtractSdkProperties<ListInputFieldsPluginProvides> & ExtractSdkProperties<GetInputFieldsSchemaPluginProvides> & ExtractSdkProperties<ListInputFieldChoicesPluginProvides> & ExtractSdkProperties<RunActionPluginProvides> & ExtractSdkProperties<ListAuthenticationsPluginProvides> & ExtractSdkProperties<GetAuthenticationPluginProvides> & ExtractSdkProperties<FindFirstAuthenticationPluginProvides> & ExtractSdkProperties<FindUniqueAuthenticationPluginProvides> & ExtractSdkProperties<ListClientCredentialsPluginProvides> & ExtractSdkProperties<CreateClientCredentialsPluginProvides> & ExtractSdkProperties<DeleteClientCredentialsPluginProvides> & ExtractSdkProperties<RequestPluginProvides> & ExtractSdkProperties<FetchPluginProvides> & ExtractSdkProperties<AppsPluginProvides> & ExtractSdkProperties<GetProfilePluginProvides>, {
+declare function createZapierSdkWithoutRegistry(options?: ZapierSdkOptions): Sdk<ExtractSdkProperties<EventEmissionProvides> & ExtractSdkProperties<ApiPluginProvides> & ExtractSdkProperties<ManifestPluginProvides> & ExtractSdkProperties<ListAppsPluginProvides> & ExtractSdkProperties<GetAppPluginProvides> & ExtractSdkProperties<ListActionsPluginProvides> & ExtractSdkProperties<GetActionPluginProvides> & ExtractSdkProperties<ListInputFieldsPluginProvides> & ExtractSdkProperties<GetInputFieldsSchemaPluginProvides> & ExtractSdkProperties<ListInputFieldChoicesPluginProvides> & ExtractSdkProperties<RunActionPluginProvides> & ExtractSdkProperties<ListAuthenticationsPluginProvides> & ExtractSdkProperties<GetAuthenticationPluginProvides> & ExtractSdkProperties<FindFirstAuthenticationPluginProvides> & ExtractSdkProperties<FindUniqueAuthenticationPluginProvides> & ExtractSdkProperties<ListClientCredentialsPluginProvides> & ExtractSdkProperties<CreateClientCredentialsPluginProvides> & ExtractSdkProperties<DeleteClientCredentialsPluginProvides> & ExtractSdkProperties<FetchPluginProvides> & ExtractSdkProperties<RequestPluginProvides> & ExtractSdkProperties<AppsPluginProvides> & ExtractSdkProperties<GetProfilePluginProvides>, {
     meta: Record<string, PluginMeta>;
 } & EventEmissionContext & {
     api: ApiClient;
@@ -2656,15 +2683,10 @@ declare function createZapierSdkWithoutRegistry(options?: ZapierSdkOptions): Sdk
             inputSchema: typeof DeleteClientCredentialsSchema;
         };
     };
-} & {
-    meta: {
-        request: {
-            inputSchema: typeof RelayRequestSchema;
-        };
-    };
 } & {
     meta: {
         fetch: {
+            description: string;
             packages: string[];
             categories: string[];
             returnType: string;
@@ -2674,6 +2696,12 @@ declare function createZapierSdkWithoutRegistry(options?: ZapierSdkOptions): Sdk
             }>;
         };
     };
+} & {
+    meta: {
+        request: {
+            inputSchema: typeof RelayRequestSchema;
+        };
+    };
 } & {
     meta: {
         getProfile: {
@@ -2683,4 +2711,4 @@ declare function createZapierSdkWithoutRegistry(options?: ZapierSdkOptions): Sdk
 }>;
 declare function createZapierSdk(options?: ZapierSdkOptions): ZapierSdk;
 
-export { type Action, type ActionEntry, type ActionExecutionOptions, type ActionExecutionResult, type ActionField, type ActionFieldChoice, type ActionItem$1 as ActionItem, type ActionKeyProperty, ActionKeyPropertySchema, type ActionTypeProperty, ActionTypePropertySchema, type AddActionEntryOptions, type AddActionEntryResult, type ApiError, type ApiEvent, type ApiPluginOptions, type ApiPluginProvides, type App, type AppItem, type AppKeyProperty, AppKeyPropertySchema, type ApplicationLifecycleEventData, type AppsPluginProvides, type AuthEvent, type Authentication, type AuthenticationIdProperty, AuthenticationIdPropertySchema, type AuthenticationItem, type AuthenticationsResponse, type BaseEvent, type BatchOptions, type Choice, type ClientCredentialsObject, type CreateClientCredentialsPluginProvides, type Credentials, type CredentialsObject, DEFAULT_CONFIG_PATH, type DebugProperty, DebugPropertySchema, type DeleteClientCredentialsPluginProvides, type EnhancedErrorEventData, type ErrorOptions, type EventCallback, type EventContext, type EventEmissionContext, type FetchPluginProvides, type Field, type FieldsetItem, type FindFirstAuthenticationPluginProvides, type FindUniqueAuthenticationPluginProvides, type FormatMetadata, type FormattedItem, type FunctionOptions, type FunctionRegistryEntry, type GetActionPluginProvides, type GetAppPluginProvides, type GetAuthenticationPluginProvides, type GetContextType, type GetProfilePluginProvides, type GetSdkType, type InfoFieldItem, type InputFieldItem, type InputsProperty, InputsPropertySchema, type LimitProperty, LimitPropertySchema, type ListActionsPluginProvides, type ListAppsPluginProvides, type ListAuthenticationsPluginProvides, type ListClientCredentialsPluginProvides, type ListInputFieldsPluginProvides, type LoadingEvent, MAX_PAGE_LIMIT, type Manifest, type ManifestEntry, type ManifestPluginOptions, type ManifestPluginProvides, type MethodCalledEvent, type MethodCalledEventData, type Need, type NeedsRequest, type NeedsResponse, type OffsetProperty, OffsetPropertySchema, type OutputProperty, OutputPropertySchema, type PaginatedSdkFunction, type ParamsProperty, ParamsPropertySchema, type PkceCredentialsObject, type Plugin, type PluginDependencies, type PluginOptions, type PluginProvides, type PositionalMetadata, RelayFetchSchema, RelayRequestSchema, type RequestPluginProvides, type ResolveAuthTokenOptions, type ResolveCredentialsOptions, type ResolvedCredentials, type RootFieldItem, type RunActionPluginProvides, type Sdk, type SdkEvent, type UpdateManifestEntryOptions, type UpdateManifestEntryResult, type UserProfile, type UserProfileItem, ZAPIER_AUTH_BASE_URL, ZAPIER_AUTH_CLIENT_ID, ZAPIER_BASE_URL, ZAPIER_CREDENTIALS, ZAPIER_CREDENTIALS_BASE_URL, ZAPIER_CREDENTIALS_CLIENT_ID, ZAPIER_CREDENTIALS_CLIENT_SECRET, ZAPIER_CREDENTIALS_SCOPE, ZAPIER_TOKEN, ZapierActionError, ZapierApiError, ZapierAppNotFoundError, ZapierAuthenticationError, ZapierBundleError, ZapierConfigurationError, ZapierError, type ZapierFetchInitOptions, ZapierNotFoundError, ZapierResourceNotFoundError, type ZapierSdk, type ZapierSdkApps, type ZapierSdkOptions, ZapierTimeoutError, ZapierUnknownError, ZapierValidationError, actionKeyResolver, actionTypeResolver, apiPlugin, appKeyResolver, appsPlugin, authenticationIdGenericResolver, authenticationIdResolver, batch, buildApplicationLifecycleEvent, buildErrorEvent, buildErrorEventWithContext, buildMethodCalledEvent, clearTokenCache, clientCredentialsNameResolver, clientIdResolver, createBaseEvent, createClientCredentialsPlugin, createFunction, createSdk, createZapierSdk, createZapierSdkWithoutRegistry, deleteClientCredentialsPlugin, fetchPlugin, findFirstAuthenticationPlugin, findManifestEntry, findUniqueAuthenticationPlugin, formatErrorMessage, generateEventId, getActionPlugin, getAppPlugin, getAuthenticationPlugin, getBaseUrlFromCredentials, getCiPlatform, getClientIdFromCredentials, getCpuTime, getCurrentTimestamp, getMemoryUsage, getOsInfo, getPlatformVersions, getPreferredManifestEntryKey, getProfilePlugin, getReleaseId, getTokenFromCliLogin, inputFieldKeyResolver, inputsAllOptionalResolver, inputsResolver, invalidateCachedToken, invalidateCredentialsToken, isCi, isClientCredentials, isCredentialsFunction, isCredentialsObject, isPkceCredentials, isPositional, listActionsPlugin, listAppsPlugin, listAuthenticationsPlugin, listClientCredentialsPlugin, listInputFieldsPlugin, logDeprecation, manifestPlugin, readManifestFromFile, registryPlugin, requestPlugin, resetDeprecationWarnings, resolveAuthToken, resolveCredentials, resolveCredentialsFromEnv, runActionPlugin, toSnakeCase, toTitleCase };
+export { type Action, type ActionEntry, type ActionExecutionOptions, type ActionExecutionResult, type ActionField, type ActionFieldChoice, type ActionItem$1 as ActionItem, type ActionKeyProperty, ActionKeyPropertySchema, type ActionTimeoutMsProperty, ActionTimeoutMsPropertySchema, type ActionTypeProperty, ActionTypePropertySchema, type AddActionEntryOptions, type AddActionEntryResult, type ApiError, type ApiEvent, type ApiPluginOptions, type ApiPluginProvides, type App, type AppItem, type AppKeyProperty, AppKeyPropertySchema, type ApplicationLifecycleEventData, type AppsPluginProvides, type AuthEvent, type Authentication, type AuthenticationIdProperty, AuthenticationIdPropertySchema, type AuthenticationItem, type AuthenticationsResponse, type BaseEvent, type BatchOptions, type Choice, type ClientCredentialsObject, type CreateClientCredentialsPluginProvides, type Credentials, type CredentialsObject, DEFAULT_ACTION_TIMEOUT_MS, DEFAULT_CONFIG_PATH, type DebugProperty, DebugPropertySchema, type DeleteClientCredentialsPluginProvides, type EnhancedErrorEventData, type ErrorOptions, type EventCallback, type EventContext, type EventEmissionContext, type FetchPluginProvides, type Field, type FieldsetItem, type FindFirstAuthenticationPluginProvides, type FindUniqueAuthenticationPluginProvides, type FormatMetadata, type FormattedItem, type FunctionOptions, type FunctionRegistryEntry, type GetActionPluginProvides, type GetAppPluginProvides, type GetAuthenticationPluginProvides, type GetContextType, type GetProfilePluginProvides, type GetSdkType, type InfoFieldItem, type InputFieldItem, type InputsProperty, InputsPropertySchema, type LimitProperty, LimitPropertySchema, type ListActionsPluginProvides, type ListAppsPluginProvides, type ListAuthenticationsPluginProvides, type ListClientCredentialsPluginProvides, type ListInputFieldsPluginProvides, type LoadingEvent, MAX_PAGE_LIMIT, type Manifest, type ManifestEntry, type ManifestPluginOptions, type ManifestPluginProvides, type MethodCalledEvent, type MethodCalledEventData, type Need, type NeedsRequest, type NeedsResponse, type OffsetProperty, OffsetPropertySchema, type OutputProperty, OutputPropertySchema, type PaginatedSdkFunction, type ParamsProperty, ParamsPropertySchema, type PkceCredentialsObject, type Plugin, type PluginDependencies, type PluginOptions, type PluginProvides, type PositionalMetadata, RelayFetchSchema, RelayRequestSchema, type RequestPluginProvides, type ResolveAuthTokenOptions, type ResolveCredentialsOptions, type ResolvedCredentials, type RootFieldItem, type RunActionPluginProvides, type Sdk, type SdkEvent, type UpdateManifestEntryOptions, type UpdateManifestEntryResult, type UserProfile, type UserProfileItem, ZAPIER_AUTH_BASE_URL, ZAPIER_AUTH_CLIENT_ID, ZAPIER_BASE_URL, ZAPIER_CREDENTIALS, ZAPIER_CREDENTIALS_BASE_URL, ZAPIER_CREDENTIALS_CLIENT_ID, ZAPIER_CREDENTIALS_CLIENT_SECRET, ZAPIER_CREDENTIALS_SCOPE, ZAPIER_TOKEN, ZapierActionError, ZapierApiError, ZapierAppNotFoundError, ZapierAuthenticationError, ZapierBundleError, ZapierConfigurationError, ZapierError, type ZapierFetchInitOptions, ZapierNotFoundError, ZapierResourceNotFoundError, type ZapierSdk, type ZapierSdkApps, type ZapierSdkOptions, ZapierTimeoutError, ZapierUnknownError, ZapierValidationError, actionKeyResolver, actionTypeResolver, apiPlugin, appKeyResolver, appsPlugin, authenticationIdGenericResolver, authenticationIdResolver, batch, buildApplicationLifecycleEvent, buildErrorEvent, buildErrorEventWithContext, buildMethodCalledEvent, clearTokenCache, clientCredentialsNameResolver, clientIdResolver, createBaseEvent, createClientCredentialsPlugin, createFunction, createSdk, createZapierSdk, createZapierSdkWithoutRegistry, deleteClientCredentialsPlugin, fetchPlugin, findFirstAuthenticationPlugin, findManifestEntry, findUniqueAuthenticationPlugin, formatErrorMessage, generateEventId, getActionPlugin, getAppPlugin, getAuthenticationPlugin, getBaseUrlFromCredentials, getCiPlatform, getClientIdFromCredentials, getCpuTime, getCurrentTimestamp, getMemoryUsage, getOsInfo, getPlatformVersions, getPreferredManifestEntryKey, getProfilePlugin, getReleaseId, getTokenFromCliLogin, inputFieldKeyResolver, inputsAllOptionalResolver, inputsResolver, invalidateCachedToken, invalidateCredentialsToken, isCi, isClientCredentials, isCredentialsFunction, isCredentialsObject, isPkceCredentials, isPositional, listActionsPlugin, listAppsPlugin, listAuthenticationsPlugin, listClientCredentialsPlugin, listInputFieldsPlugin, logDeprecation, manifestPlugin, readManifestFromFile, registryPlugin, requestPlugin, resetDeprecationWarnings, resolveAuthToken, resolveCredentials, resolveCredentialsFromEnv, runActionPlugin, toSnakeCase, toTitleCase };