Chronicle.Compliance (cratis_chronicle v1.0.3)

Compliance support for marking event and read model fields as containing sensitive data, mirroring the @pii decorator in the C# and TypeScript clients.

Marking a field as PII causes the Chronicle kernel to encrypt that field's value using compliance-aware (GDPR) encryption. The marking is carried to the kernel as compliance metadata embedded in the generated JSON schema for the event type or read model — see Chronicle.Schemas.JsonSchemaGenerator.

The pii/1 and pii/2 macros are imported automatically inside modules that use Chronicle.Events.EventType or use Chronicle.ReadModels.ReadModel:

defmodule MyApp.Events.CustomerRegistered do
  use Chronicle.Events.EventType, id: "customer-registered"
  defstruct [:customer_id, :email, :full_name]

  pii :email, "Customer email address"
  pii :full_name
end

Each marked field is exposed through the module's __chronicle_pii__/0 accessor as {field, details} tuples.

Summary

Functions

pii(field, details \\ "")

Marks a struct field as containing Personally Identifiable Information (PII).

subject(field)

Marks a struct field as the data subject identifier for GDPR compliance.

Functions

pii(field, details \\ "")

(macro)

Marks a struct field as containing Personally Identifiable Information (PII).

Accumulates the field into the module's @chronicle_pii attribute. details is an optional human-readable explanation of why the field is classified as PII and defaults to an empty string.

subject(field)

(macro)

Marks a struct field as the data subject identifier for GDPR compliance.

The subject field identifies the natural person whose data is encrypted in PII fields. Chronicle uses this value as the key when calling the compliance Release endpoint to decrypt PII fields on read model retrieval.

When no subject/1 declaration is present, Chronicle falls back to the field named :id as the subject identifier.

Only one subject field may be declared per module. A second call overwrites the first.

defmodule MyApp.ReadModels.Customer do
  use Chronicle.ReadModels.ReadModel

  defstruct customer_id: nil, email: "", full_name: ""

  subject :customer_id
  pii :email
  pii :full_name
end