Align UnionMessageReply with the various replies that processMessage

[LiranCohen]

UnionMessageReply was not fully in sync with the actual replies.

• data is actually within record for a RecordsReadReply.
• modified events to entries for EventsGetReply and EventsQueryReply
• modified messages to entries for MessagesGetReply

This way all of the individual replies can be represented by:

/**
 * Catch-all message reply type. It is recommended to use GenericMessageReply or a message-specific reply type wherever possible.
 */
export type UnionMessageReply = GenericMessageReply & {
  /**
   * Resulting message entries or events returned from the invocation of the corresponding message.
   * e.g. the resulting messages from a RecordsQuery, or array of messageCid strings for EventsGet or EventsQuery
   * Mutually exclusive with `record`.
   */
  entries?: QueryResultEntry[] | ProtocolsConfigureMessage[] | MessagesGetReplyEntry[] | string[];

  /**
   * Record corresponding to the message received if applicable (e.g. RecordsRead).
   * Mutually exclusive with `entries` and `cursor`.
   */
  record?: RecordsWriteReply;

  /**
   * A cursor for pagination if applicable (e.g. RecordsQuery).
   * Mutually exclusive with `record`.
   */
  cursor?: string;

  /**
   * A subscription object if a subscription was requested.
   */
  subscription?: GenericMessageSubscription;
};

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a6f95fb) 98.83% compared to head (788e1b7) 98.83%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #648   +/-   ##
=======================================
  Coverage   98.83%   98.83%           
=======================================
  Files          71       71           
  Lines        9240     9243    +3     
  Branches     1391     1391           
=======================================
+ Hits         9132     9135    +3     
  Misses        100      100           
  Partials        8        8           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.