AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents
TypeScript ai-agentai-agent-toolsai-agentsai-agents-frameworkmcpmcp-servermcp-toolsmcpsn8n-alternativeno-code-automationworkflowworkflow-automationworkflows
import * as z from "zod/mini";
import { ActionContext } from '../context';
import type { OutputSchema } from '../output-schema';
import { ActionBase, Audience, AiMetadata, ActionClassification, PropertyGroup } from '../piece-metadata';
import { InputPropertyMap } from '../property';
import { ExtractPieceAuthPropertyTypeForMethods, PieceAuthProperty } from '../property/authentication';
export type ActionRunner<PieceAuth extends PieceAuthProperty | PieceAuthProperty[] | undefined = PieceAuthProperty, ActionProps extends InputPropertyMap = InputPropertyMap> =
(ctx: ActionContext<PieceAuth, ActionProps>) => Promise<unknown | void>
export const ErrorHandlingOptionsParam = z.object({
retryOnFailure: z.object({
defaultValue: z.optional(z.boolean()),
hide: z.optional(z.boolean()),
}),
continueOnFailure: z.object({
defaultValue: z.optional(z.boolean()),
hide: z.optional(z.boolean()),
}),
})
export type ErrorHandlingOptionsParam = z.infer<typeof ErrorHandlingOptionsParam>
type CreateActionParams<PieceAuth extends PieceAuthProperty | PieceAuthProperty[] | undefined, ActionProps extends InputPropertyMap> = {
/**
* A dummy parameter used to infer {@code PieceAuth} type
*/
name: string
/**
* this parameter is used to infer the type of the piece auth value in run and test methods
*/
auth?: PieceAuth
displayName: string
description: string
props: ActionProps
propertyGroups?: PropertyGroup[]
run: ActionRunner<ExtractPieceAuthPropertyTypeForMethods<PieceAuth>, ActionProps>
test?: ActionRunner<ExtractPieceAuthPropertyTypeForMethods<PieceAuth>, ActionProps>
requireAuth?: boolean
errorHandlingOptions?: ErrorHandlingOptionsParam
outputSchema?: OutputSchema
audience?: Audience
aiMetadata?: AiMetadata
classification?: ActionClassification
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export class IAction<PieceAuth extends PieceAuthProperty | PieceAuthProperty[] | undefined = any, ActionProps extends InputPropertyMap = InputPropertyMap> implements ActionBase {
constructor(
public readonly name: string,
public readonly displayName: string,
public readonly description: string,
public readonly props: ActionProps,
public readonly propertyGroups: PropertyGroup[] | undefined,
public readonly run: ActionRunner<ExtractPieceAuthPropertyTypeForMethods<PieceAuth>, ActionProps>,
public readonly test: ActionRunner<ExtractPieceAuthPropertyTypeForMethods<PieceAuth>, ActionProps>,
public readonly requireAuth: boolean,
public readonly errorHandlingOptions: ErrorHandlingOptionsParam,
public readonly outputSchema?: OutputSchema,
public readonly audience?: Audience,
public readonly aiMetadata?: AiMetadata,
public readonly classification?: ActionClassification,
) { }
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type Action<
PieceAuth extends PieceAuthProperty | PieceAuthProperty[] | undefined = any,
ActionProps extends InputPropertyMap = any,
> = IAction<PieceAuth, ActionProps>
export const createAction = <
PieceAuth extends PieceAuthProperty | PieceAuthProperty[] | undefined = PieceAuthProperty,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
ActionProps extends InputPropertyMap = any
>(
params: CreateActionParams<PieceAuth, ActionProps>,
) => {
return new IAction(
params.name,
params.displayName,
params.description,
params.props,
params.propertyGroups,
params.run,
params.test ?? params.run,
params.requireAuth ?? true,
params.errorHandlingOptions ?? {
continueOnFailure: {
defaultValue: false,
},
retryOnFailure: {
defaultValue: false,
}
},
params.outputSchema,
params.audience,
params.aiMetadata,
params.classification,
)
}