Package com.tnsai.hooks.events

Record Class PreChat

java.lang.Object

java.lang.Record

com.tnsai.hooks.events.PreChat

Record Components:

eventId - ULID-shaped correlation id

timestamp - when the event was constructed

context - surrounding hook context

userMessage - the user's raw message — Modify-able

history - prior conversation turns

metadata - free-form per-turn metadata (channel-specific fields, e.g. Telegram message id, attachments)

All Implemented Interfaces:

ChatHookEvent, HookEvent

public record PreChat(String eventId, Instant timestamp, HookContext context, String userMessage, List<Map<String,Object>> history, Map<String,Object> metadata)
extends Record
implements ChatHookEvent

Fires when a user message is submitted, before prompt assembly (issue #60). The natural intercept point for content-safety checks: prompt injection scanners, PII redactors, tenant quota enforcement, language detection.

Hooks may Block the message (refuse the chat outright with a structured deny) or Modify via withUserMessage(String) (rewrite the message before it reaches the LLM — useful for PII redaction).

history is the framework's ambient chat history shape (List<Map<String, Object>>) — same contract used by LLMClient.chat(message, systemPrompt, history, tools). A typed ConversationTurn record is a separate cleanup task, not a prerequisite for shipping the hook.

Since:

0.5.0 (issue #60)

Constructor Summary

Constructors

Constructor	Description
PreChat(String eventId, Instant timestamp, HookContext context, String userMessage, List<Map<String,Object>> history, Map<String,Object> metadata)	Creates an instance of a PreChat record class.

Method Summary

Modifier and Type	Method	Description
HookContext	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	eventId()	Returns the value of the eventId record component.
String	eventType()	Short stable string identifier of the event kind, e.g.
final int	hashCode()	Returns a hash code value for this object.
List<Map<String,Object>>	history()	Returns the value of the history record component.
Map<String,Object>	metadata()	Returns the value of the metadata record component.
Instant	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.
String	userMessage()	Returns the value of the userMessage record component.
PreChat	withUserMessage(String newUserMessage)	Build a copy with newUserMessage replacing userMessage.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PreChat

public PreChat(String eventId,
 Instant timestamp,
 HookContext context,
 String userMessage,
 List<Map<String,Object>> history,
 Map<String,Object> metadata)

Creates an instance of a PreChat record class.

Parameters:

eventId - the value for the eventId record component

timestamp - the value for the timestamp record component

context - the value for the context record component

userMessage - the value for the userMessage record component

history - the value for the history record component

metadata - the value for the metadata record component

Method Details

eventType

public String eventType()

Description copied from interface: HookEvent

Short stable string identifier of the event kind, e.g. "PreToolUse". Default implementation derives it from the concrete record's simple class name; concrete records may override if a different naming is desirable.

Specified by:

eventType in interface HookEvent

withUserMessage

public PreChat withUserMessage(String newUserMessage)

Build a copy with newUserMessage replacing userMessage. Used by Modify hooks doing PII / prompt scrubbing before the message reaches the LLM.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

eventId

public String eventId()

Returns the value of the eventId record component.

Specified by:

eventId in interface HookEvent

Returns:

the value of the eventId record component

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Specified by:

timestamp in interface HookEvent

Returns:

the value of the timestamp record component

context

public HookContext context()

Returns the value of the context record component.

Specified by:

context in interface HookEvent

Returns:

the value of the context record component

userMessage

public String userMessage()

Returns the value of the userMessage record component.

Returns:

the value of the userMessage record component

history

public List<Map<String,Object>> history()

Returns the value of the history record component.

Returns:

the value of the history record component

metadata

public Map<String,Object> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component