Which of an event's fields and metadata entries hold personal data, and whose.
declaration/1 answers a Decree.PersonalFields.Declaration, or nil for an event that
declares nothing. The protocol falls back to Any, which answers nil, so such an event
costs one protocol dispatch and is otherwise untouched: its stored JSON and metadata are
what they would be without this protocol.
An event declares by deriving:
defmodule UserInvited do
@derive [
Jason.Encoder,
{Decree.Event.PersonalFields,
personal: [email: {:first_present, [:target_user_id, :invitation_id]}],
personal_metadata: [email: :target_user_id, password_hash: :target_user_id]}
]
defstruct [:invitation_id, :target_user_id, :email]
endpersonal: lists the event's own fields. personal_metadata: lists metadata entries, which
need not be fields of the struct. Each names a subject, the person whose key protects the
value, in one of three forms:
:x- the subject isevent.x. A nilevent.xfails the append.{:first_present, [:a, :b]}- the first non-nil of those fields. If all are nil the append fails.{:when_present, :x}- the subject isevent.x, and with a nilevent.xthe value is stored in the clear.
A field or metadata entry that no longer holds personal data, but whose stored values are envelopes, is retired rather than dropped from the declaration:
@derive [
Jason.Encoder,
{Decree.Event.PersonalFields,
personal_retired: [:email], personal_metadata_retired: [:email]}
]personal_retired: lists fields of the struct and personal_metadata_retired: metadata
entries, by name and with no subject. A retired slot is decrypt-only: a stored envelope is read
under its own subject as a declared one is, and a new value is stored as given, never
encrypted. An event may declare only retired names.
The derive refuses, with a CompileError, any other form, a declared or retired field or a
subject field that is not in the struct, a subject field that is itself declared personal or
retired, a name both declared and retired in the same list pair, a retired list that is not a
list of names or repeats one, an option it does not know, and a declaration with every list
empty. A typo must never leave a field in the clear.
Decree.PersonalFields says what is done with a declaration.
Summary
Functions
Answers the event's declaration, or nil when it declares nothing.
Types
@type t() :: term()
All the types that implement this protocol.
Functions
@spec declaration(t()) :: Decree.PersonalFields.Declaration.t() | nil
Answers the event's declaration, or nil when it declares nothing.