@idpass/data-collect-core / EventUpcaster

Interface: EventUpcaster

Defined in: services/EventUpcasterService.ts:45

Defines a single upcaster that transforms event data from one schema version to the next.

Upcasters form a chain: v1->v2, v2->v3, etc. Each upcaster is responsible for transforming data from exactly one version to the next sequential version.

Example

const upcaster: EventUpcaster = {
  eventType: "create-individual",
  fromVersion: 1,
  toVersion: 2,
  upcast(data) {
    // Split "name" into "firstName" and "lastName"
    const parts = (data.name as string).split(" ");
    return { ...data, firstName: parts[0], lastName: parts.slice(1).join(" ") };
  },
};

Properties

eventType

eventType: string

Defined in: services/EventUpcasterService.ts:47

The event type this upcaster applies to (e.g., "create-individual")

---

fromVersion

fromVersion: number

Defined in: services/EventUpcasterService.ts:49

The schema version this upcaster reads from

---

toVersion

toVersion: number

Defined in: services/EventUpcasterService.ts:51

The schema version this upcaster produces

Methods

upcast()

upcast(eventData): Record<string, unknown>

Defined in: services/EventUpcasterService.ts:53

Pure function that transforms event data from fromVersion to toVersion

Parameters

eventData

Record<string, unknown>

Returns

Record<string, unknown>