@skyleague/event-horizon

Index

Classes

• LogFormatter

Errors

• EventError
• EventOptions

Functions

• eventBridgeHandler
• eventEntries
• firehoseHandler
• httpApiAuthorizer
• httpApiHandler
• kinesisHandler
• parseJSON
• rawHandler
• restApiAuthorizer
• restApiHandler
• s3BatchHandler
• s3Handler
• secretRotationHandler
• snsHandler
• sqsGroupHandler
• sqsHandler

Interfaces

• APIGatewayCert
• AppConfigConstants
• AuthorizerReponse
• ClientContext
• ClientContextClient
• ClientContextEnv
• CognitoIdentity
• Context
• DefaultServices
• EventBridgeEvent
• EventBridgeEventHandler
• EventBridgeHandler
• EventBridgeSchema
• EventConstants
• EventHandlerDefinition
• FirehoseTransformationEvent
• FirehoseTransformationEventHandler
• FirehoseTransformationHandler
• FirehoseTransformationResult
• HTTPEventHandler
• HTTPHandler
• HTTPRequest
• HTTPResponse
• InitConstants
• KinesisDataStreamRecord
• KinesisDataStreamRecordPayload
• KinesisDataStreamSchema
• KinesisEvent
• KinesisEventHandler
• KinesisFirehoseRecord
• KinesisFirehoseSchema
• KinesisHandler
• KinesisRecordMetaData
• LambdaContext
• Logger
• LoggingConstants
• Metrics
• MetricsConstants
• ProfileSchema
• RawEventHandler
• RawHandler
• RequestAuthorizerEvent
• RequestAuthorizerEventHandler
• RequestAuthorizerHandler
• S3BatchEvent
• S3BatchEventHandler
• S3BatchEventJob
• S3BatchEventTask
• S3BatchHandler
• S3BatchTask
• S3BatchTaskResult
• S3Event
• S3EventHandler
• S3EventNotificationEventBridgeDetailSchema
• S3EventNotificationEventBridgeSchema
• S3EventRecordGlacierEventData
• S3Handler
• S3Identity
• S3Message
• S3RecordSchema
• S3RequestParameters
• S3ResponseElements
• S3Schema
• SNSEvent
• SNSEventHandler
• SNSHandler
• SQSEvent
• SQSEventHandler
• SQSGroupEventHandler
• SQSGroupHandler
• SQSHandler
• SQSMessageGroup
• SecretRotationEvent
• SecretRotationEventHandler
• SecretRotationHandler
• SecretRotationRequest
• ServiceConstants
• SnsMsgAttribute
• SnsNotificationSchema
• SnsRecordSchema
• SnsSchema
• SqsAttributesSchema
• SqsMsgAttributeSchema
• SqsRecordSchema
• SqsSchema
• Tracer

Namespaces

• HttpApiGateway
• RestApiGateway

Type Aliases

• APIGatewayHttpMethod
• APIGatewayRecord
• Config
• ErrorLike
• EventFromHandler
• EventHandler
• GatewayVersion
• HTTPHeaders
• HTTPMethod
• HTTPPathParameters
• HTTPQueryParameters
• Services

Variables

• APIGatewayHttpMethod
• Context
• EventBridgeSchema
• KinesisDataStreamRecord
• KinesisDataStreamSchema
• KinesisFirehoseRecord
• KinesisFirehoseSchema
• S3BatchEvent
• S3BatchEventTask
• S3EventNotificationEventBridgeDetailSchema
• S3RecordSchema
• S3Schema
• SecretRotationEvent
• SnsRecordSchema
• SnsSchema
• SqsRecordSchema
• SqsSchema
• appConfigConstants
• eventConstants
• initConstants
• logger
• loggingConstants
• metrics
• metricsConstants
• serviceConstants
• tracer

Type Aliases

APIGatewayHttpMethod

APIGatewayHttpMethod: typeof APIGatewayHttpMethod

APIGatewayRecord

APIGatewayRecord: {} | null

Config

Config<C>: C | () => C | Promise<C>

Type parameters

• C

ErrorLike

ErrorLike: Error | string

EventFromHandler

EventFromHandler<Handler>: Handler extends { handler: (event: infer EventType, ...args: any[]) => any } ? EventType : never

Type parameters

• Handler: { handler: (event: any, ...args: any[]) => any }

EventHandler

EventHandler<Service>: EventBridgeHandler | FirehoseTransformationHandler | HTTPHandler | KinesisHandler | RawHandler | S3BatchHandler | S3Handler | SNSHandler | SQSHandler | DynamoDBStreamHandler | (Service extends SetRequired<DefaultServices, secretsManager> ? SecretRotationHandler<unknown, Service> : never)

Type parameters

• Service = unknown

GatewayVersion

GatewayVersion: http | rest

HTTPHeaders

HTTPHeaders: Record<string, string | undefined>

HTTPMethod

HTTPMethod: delete | get | head | options | patch | post | put | trace

HTTPPathParameters

HTTPPathParameters: Record<string, string | undefined>

HTTPQueryParameters

HTTPQueryParameters: Record<string, string | undefined>

Services

Services<C, S>: S | (config: AsConfig<C>) => Promise<S> | S

Type parameters

• C
• S

Variables

constAPIGatewayHttpMethod

APIGatewayHttpMethod: { DELETE: DELETE; GET: GET; HEAD: HEAD; OPTIONS: OPTIONS; PATCH: PATCH; POST: POST; PUT: PUT } = ...

Type declaration

• readonlyDELETE: DELETE

• readonlyGET: GET

• readonlyHEAD: HEAD

• readonlyOPTIONS: OPTIONS

• readonlyPATCH: PATCH

• readonlyPOST: POST

• readonlyPUT: PUT

Context

Context: { is: (o: unknown) => o is Context; parse: (o: unknown) => { right: Context } | { left: DefinedError[] }; validate: ValidateFunction<Context>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is Context

  • • (o: unknown): o is Context

    • Parameters

      • o: unknown

      Returns o is Context

• readonlyparse: (o: unknown) => { right: Context } | { left: DefinedError[] }

  • • (o: unknown): { right: Context } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: Context } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<Context>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

EventBridgeSchema

EventBridgeSchema: { is: (o: unknown) => o is EventBridgeSchema; parse: (o: unknown) => { right: EventBridgeSchema } | { left: DefinedError[] }; validate: ValidateFunction<EventBridgeSchema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is EventBridgeSchema

  • • (o: unknown): o is EventBridgeSchema

    • Parameters

      • o: unknown

      Returns o is EventBridgeSchema

• readonlyparse: (o: unknown) => { right: EventBridgeSchema } | { left: DefinedError[] }

  • • (o: unknown): { right: EventBridgeSchema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: EventBridgeSchema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<EventBridgeSchema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

KinesisDataStreamRecord

KinesisDataStreamRecord: { is: (o: unknown) => o is KinesisDataStreamRecord; parse: (o: unknown) => { right: KinesisDataStreamRecord } | { left: DefinedError[] }; validate: ValidateFunction<KinesisDataStreamRecord>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is KinesisDataStreamRecord

  • • (o: unknown): o is KinesisDataStreamRecord

    • Parameters

      • o: unknown

      Returns o is KinesisDataStreamRecord

• readonlyparse: (o: unknown) => { right: KinesisDataStreamRecord } | { left: DefinedError[] }

  • • (o: unknown): { right: KinesisDataStreamRecord } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: KinesisDataStreamRecord } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<KinesisDataStreamRecord>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

KinesisDataStreamSchema

KinesisDataStreamSchema: { is: (o: unknown) => o is KinesisDataStreamSchema; parse: (o: unknown) => { right: KinesisDataStreamSchema } | { left: DefinedError[] }; validate: ValidateFunction<KinesisDataStreamSchema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is KinesisDataStreamSchema

  • • (o: unknown): o is KinesisDataStreamSchema

    • Parameters

      • o: unknown

      Returns o is KinesisDataStreamSchema

• readonlyparse: (o: unknown) => { right: KinesisDataStreamSchema } | { left: DefinedError[] }

  • • (o: unknown): { right: KinesisDataStreamSchema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: KinesisDataStreamSchema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<KinesisDataStreamSchema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

KinesisFirehoseRecord

KinesisFirehoseRecord: { is: (o: unknown) => o is KinesisFirehoseRecord; parse: (o: unknown) => { right: KinesisFirehoseRecord } | { left: DefinedError[] }; validate: ValidateFunction<KinesisFirehoseRecord>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is KinesisFirehoseRecord

  • • (o: unknown): o is KinesisFirehoseRecord

    • Parameters

      • o: unknown

      Returns o is KinesisFirehoseRecord

• readonlyparse: (o: unknown) => { right: KinesisFirehoseRecord } | { left: DefinedError[] }

  • • (o: unknown): { right: KinesisFirehoseRecord } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: KinesisFirehoseRecord } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<KinesisFirehoseRecord>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

KinesisFirehoseSchema

KinesisFirehoseSchema: { is: (o: unknown) => o is KinesisFirehoseSchema; parse: (o: unknown) => { right: KinesisFirehoseSchema } | { left: DefinedError[] }; validate: ValidateFunction<KinesisFirehoseSchema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is KinesisFirehoseSchema

  • • (o: unknown): o is KinesisFirehoseSchema

    • Parameters

      • o: unknown

      Returns o is KinesisFirehoseSchema

• readonlyparse: (o: unknown) => { right: KinesisFirehoseSchema } | { left: DefinedError[] }

  • • (o: unknown): { right: KinesisFirehoseSchema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: KinesisFirehoseSchema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<KinesisFirehoseSchema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

S3BatchEvent

S3BatchEvent: { is: (o: unknown) => o is S3BatchEvent; parse: (o: unknown) => { right: S3BatchEvent } | { left: DefinedError[] }; validate: ValidateFunction<S3BatchEvent>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is S3BatchEvent

  • • (o: unknown): o is S3BatchEvent

    • Parameters

      • o: unknown

      Returns o is S3BatchEvent

• readonlyparse: (o: unknown) => { right: S3BatchEvent } | { left: DefinedError[] }

  • • (o: unknown): { right: S3BatchEvent } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: S3BatchEvent } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<S3BatchEvent>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

S3BatchEventTask

S3BatchEventTask: { is: (o: unknown) => o is S3BatchEventTask; parse: (o: unknown) => { right: S3BatchEventTask } | { left: DefinedError[] }; validate: ValidateFunction<S3BatchEventTask>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is S3BatchEventTask

  • • (o: unknown): o is S3BatchEventTask

    • Parameters

      • o: unknown

      Returns o is S3BatchEventTask

• readonlyparse: (o: unknown) => { right: S3BatchEventTask } | { left: DefinedError[] }

  • • (o: unknown): { right: S3BatchEventTask } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: S3BatchEventTask } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<S3BatchEventTask>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

S3EventNotificationEventBridgeDetailSchema

S3EventNotificationEventBridgeDetailSchema: { is: (o: unknown) => o is S3EventNotificationEventBridgeDetailSchema; parse: (o: unknown) => { right: S3EventNotificationEventBridgeDetailSchema } | { left: DefinedError[] }; validate: ValidateFunction<S3EventNotificationEventBridgeDetailSchema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is S3EventNotificationEventBridgeDetailSchema

  • • (o: unknown): o is S3EventNotificationEventBridgeDetailSchema

    • Parameters

      • o: unknown

      Returns o is S3EventNotificationEventBridgeDetailSchema

• readonlyparse: (o: unknown) => { right: S3EventNotificationEventBridgeDetailSchema } | { left: DefinedError[] }

  • • (o: unknown): { right: S3EventNotificationEventBridgeDetailSchema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: S3EventNotificationEventBridgeDetailSchema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<S3EventNotificationEventBridgeDetailSchema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

S3RecordSchema

S3RecordSchema: { is: (o: unknown) => o is S3RecordSchema; parse: (o: unknown) => { right: S3RecordSchema } | { left: DefinedError[] }; validate: ValidateFunction<S3RecordSchema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is S3RecordSchema

  • • (o: unknown): o is S3RecordSchema

    • Parameters

      • o: unknown

      Returns o is S3RecordSchema

• readonlyparse: (o: unknown) => { right: S3RecordSchema } | { left: DefinedError[] }

  • • (o: unknown): { right: S3RecordSchema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: S3RecordSchema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<S3RecordSchema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

S3Schema

S3Schema: { is: (o: unknown) => o is S3Schema; parse: (o: unknown) => { right: S3Schema } | { left: DefinedError[] }; validate: ValidateFunction<S3Schema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is S3Schema

  • • (o: unknown): o is S3Schema

    • Parameters

      • o: unknown

      Returns o is S3Schema

• readonlyparse: (o: unknown) => { right: S3Schema } | { left: DefinedError[] }

  • • (o: unknown): { right: S3Schema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: S3Schema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<S3Schema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

SecretRotationEvent

SecretRotationEvent: { is: (o: unknown) => o is SecretRotationEvent; parse: (o: unknown) => { right: SecretRotationEvent } | { left: DefinedError[] }; validate: ValidateFunction<SecretRotationEvent>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is SecretRotationEvent

  • • (o: unknown): o is SecretRotationEvent

    • Parameters

      • o: unknown

      Returns o is SecretRotationEvent

• readonlyparse: (o: unknown) => { right: SecretRotationEvent } | { left: DefinedError[] }

  • • (o: unknown): { right: SecretRotationEvent } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: SecretRotationEvent } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<SecretRotationEvent>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

SnsRecordSchema

SnsRecordSchema: { is: (o: unknown) => o is SnsRecordSchema; parse: (o: unknown) => { right: SnsRecordSchema } | { left: DefinedError[] }; validate: ValidateFunction<SnsRecordSchema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is SnsRecordSchema

  • • (o: unknown): o is SnsRecordSchema

    • Parameters

      • o: unknown

      Returns o is SnsRecordSchema

• readonlyparse: (o: unknown) => { right: SnsRecordSchema } | { left: DefinedError[] }

  • • (o: unknown): { right: SnsRecordSchema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: SnsRecordSchema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<SnsRecordSchema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

SnsSchema

SnsSchema: { is: (o: unknown) => o is SnsSchema; parse: (o: unknown) => { right: SnsSchema } | { left: DefinedError[] }; validate: ValidateFunction<SnsSchema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is SnsSchema

  • • (o: unknown): o is SnsSchema

    • Parameters

      • o: unknown

      Returns o is SnsSchema

• readonlyparse: (o: unknown) => { right: SnsSchema } | { left: DefinedError[] }

  • • (o: unknown): { right: SnsSchema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: SnsSchema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<SnsSchema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

SqsRecordSchema

SqsRecordSchema: { is: (o: unknown) => o is SqsRecordSchema; parse: (o: unknown) => { right: SqsRecordSchema } | { left: DefinedError[] }; validate: ValidateFunction<SqsRecordSchema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is SqsRecordSchema

  • • (o: unknown): o is SqsRecordSchema

    • Parameters

      • o: unknown

      Returns o is SqsRecordSchema

• readonlyparse: (o: unknown) => { right: SqsRecordSchema } | { left: DefinedError[] }

  • • (o: unknown): { right: SqsRecordSchema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: SqsRecordSchema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<SqsRecordSchema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

SqsSchema

SqsSchema: { is: (o: unknown) => o is SqsSchema; parse: (o: unknown) => { right: SqsSchema } | { left: DefinedError[] }; validate: ValidateFunction<SqsSchema>; errors: any; schema: any }

Type declaration

• readonlyis: (o: unknown) => o is SqsSchema

  • • (o: unknown): o is SqsSchema

    • Parameters

      • o: unknown

      Returns o is SqsSchema

• readonlyparse: (o: unknown) => { right: SqsSchema } | { left: DefinedError[] }

  • • (o: unknown): { right: SqsSchema } | { left: DefinedError[] }

    • Parameters

      • o: unknown

      Returns { right: SqsSchema } | { left: DefinedError[] }

• readonlyvalidate: ValidateFunction<SqsSchema>

• get errors(): undefined | ErrorObject<string, Record<string, any>, unknown>[]

• get schema(): AnySchema

constappConfigConstants

appConfigConstants: AppConfigConstants = ...

consteventConstants

eventConstants: EventConstants = ...

constinitConstants

initConstants: InitConstants = ...

constlogger

logger: Logger = ...

constloggingConstants

loggingConstants: LoggingConstants = ...

constmetrics

metrics: Metrics = ...

constmetricsConstants

metricsConstants: { namespace: string } = ...

Type declaration

• namespace: string

constserviceConstants

serviceConstants: ServiceConstants = ...

consttracer

tracer: Tracer = ...