Class EventValidator

Utility class for validating event data using Zod schemas. Provides performance monitoring and configurable validation behavior.

See

API: EventValidator

Index

Constructors

Methods

updateConfig validateInput validateOutput validateFromSchemas isValidationEnabled

Constructors

constructor

new EventValidator(
config?: Partial<EventValidationConfig>,
logger?: IPluginLogging,
): EventValidator
Create a new EventValidator instance.
Parameters
- config: Partial<EventValidationConfig> = {}
  Validation configuration options
- Optionallogger: IPluginLogging
  Optional logger for error reporting
Returns EventValidator
See
API: EventValidator#constructor
- Defined in src/base/EventValidator.ts:67

Methods

updateConfig

updateConfig(config: Partial<EventValidationConfig>): void
Update validation configuration at runtime.
Parameters
- config: Partial<EventValidationConfig>
  New configuration options to merge
Returns void
See
API: EventValidator#updateConfig
- Defined in src/base/EventValidator.ts:77

validateInput

validateInput<T = unknown>(
    eventName: string,
    data: unknown,
    schema: BSBType | ZodType<T, unknown, $ZodTypeInternals<T, unknown>>,
    trace: DTrace,
    eventConfig?: Partial<EventValidationConfig>,
): ValidationResult<T>
Validate input data for an event.
Type Parameters
- T = unknown
Parameters
- eventName: string
  Name of the event being validated
- data: unknown
  Data to validate
- schema: BSBType | ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
  BSBType or Zod schema to validate against
- trace: DTrace
  Trace for logging context
- OptionaleventConfig: Partial<EventValidationConfig>
  Override configuration for this validation
Returns ValidationResult<T>
Validation result with parsed data or error

See
API: EventValidator#validateInput
- Defined in src/base/EventValidator.ts:91

validateOutput

validateOutput<T = unknown>(
    eventName: string,
    data: unknown,
    schema: BSBType | ZodType<T, unknown, $ZodTypeInternals<T, unknown>>,
    trace: DTrace,
    eventConfig?: Partial<EventValidationConfig>,
): ValidationResult<T>
Validate output/return data for an event.
Type Parameters
- T = unknown
Parameters
- eventName: string
  Name of the event being validated
- data: unknown
  Data to validate
- schema: BSBType | ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
  BSBType or Zod schema to validate against
- trace: DTrace
  Trace for logging context
- OptionaleventConfig: Partial<EventValidationConfig>
  Override configuration for this validation
Returns ValidationResult<T>
Validation result with parsed data or error

See
API: EventValidator#validateOutput
- Defined in src/base/EventValidator.ts:113

validateFromSchemas

validateFromSchemas<T = unknown>(
    eventName: string,
    data: unknown,
    schemas: any,
    trace: DTrace,
    direction?: "output" | "input",
): ValidationResult<T> | null
Validate event data using schemas from a validation schema map.
Type Parameters
- T = unknown
Parameters
- eventName: string
  Name of the event to validate
- data: unknown
  Data to validate
- schemas: any
  Map of event validation schemas
- trace: DTrace
  Trace for logging context
- direction: "output" | "input" = 'input'
  Whether validating 'input' or 'output' data
Returns ValidationResult<T> | null
Validation result or null if no schema is defined

See
API: EventValidator#validateFromSchemas
- Defined in src/base/EventValidator.ts:145

isValidationEnabled

isValidationEnabled(eventConfig?: Partial<EventValidationConfig>): boolean
Check if validation is enabled for the current configuration.
Parameters
- OptionaleventConfig: Partial<EventValidationConfig>
  Override configuration to check
Returns boolean
True if validation is enabled

See
API: EventValidator#isValidationEnabled
- Defined in src/base/EventValidator.ts:171