Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/server / / DeliveryCommentarySanitizer

Interface: DeliveryCommentarySanitizer

Defined in: packages/server/src/commentary/sanitizer.ts:46

Public surface returned by createDeliveryCommentarySanitizer.

Stable

Properties

Property	Modifier	Type	Defined in
applyToEvents	readonly	readonly string[]	packages/server/src/commentary/sanitizer.ts:48
patterns	readonly	readonly DeliveryCommentaryPattern[]	packages/server/src/commentary/sanitizer.ts:49
policy	readonly	DeliveryCommentaryPolicy	packages/server/src/commentary/sanitizer.ts:47

Methods

sanitize()

sanitize(frame, transport): {
  eventId: string;
  kind: "event";
  payload?: unknown;
  subject: string;
  subscriptionId: string;
  type: string;
  v: "1";
};

Defined in: packages/server/src/commentary/sanitizer.ts:60

Sanitize the payload of a single event frame. Returns the (possibly-replaced) frame; emits an audit decision via the configured sink when the sanitizer mutated the payload.

The frame is returned unchanged when:

• the policy is 'pass-through',
• the event type is not in applyToEvents,
• or no pattern matched the JSON-stringified payload.

Parameters

Parameter	Type
frame	{ eventId: string; kind: "event"; payload?: unknown; subject: string; subscriptionId: string; type: string; v: "1"; }
frame.eventId	string
frame.kind	"event"
frame.payload?	unknown
frame.subject	string
frame.subscriptionId	string
frame.type	string
frame.v	"1"
transport	DeliveryCommentaryTransport

Returns

{
  eventId: string;
  kind: "event";
  payload?: unknown;
  subject: string;
  subscriptionId: string;
  type: string;
  v: "1";
}

Name	Type	Defined in
eventId	string	packages/protocol/dist/server-message.d.ts:103
kind	"event"	packages/protocol/dist/server-message.d.ts:100
payload?	unknown	packages/protocol/dist/server-message.d.ts:104
subject	string	packages/protocol/dist/server-message.d.ts:102
subscriptionId	string	packages/protocol/dist/server-message.d.ts:101
type	string	packages/protocol/dist/server-message.d.ts:99
v	"1"	packages/protocol/dist/server-message.d.ts:98