Remote / foldkit-remote-domain/lower

LowerConfig

interface · packages/remote-domain/src/lower/write.ts:129

interface LowerConfig<
  M extends LowerableMutation,
  User,
  PrincipalId,
  Ms extends Domain.Middleware.List,
  Listed extends ListedEvent<EntityOf<M>>,
  Ev extends Domain.Event.Any,
> {
  readonly policy: Policy<User, never>
  readonly revision: RevisionKey<EntityOf<M>>
  readonly principal: Context.Key<PrincipalId, Option.Option<User>>
  readonly middleware: Ms
  readonly listed: Listed
  readonly event: Ev
  readonly record: (
    after: RowOf<EntityOf<M>>,
    before: RowOf<EntityOf<M>>,
    input: InputOf<M>,
  ) => Domain.Aggregate.InstanceOf<Ev>
  readonly apply: (
    row: RowOf<EntityOf<M>>,
    event: Domain.Aggregate.InstanceOf<Ev>,
  ) => RowOf<EntityOf<M>>
  readonly operators?: MemoryOperators | undefined
}

What Lower.write is given besides the mutation: what it cannot derive.

Members

LowerConfig.policy

property · packages/remote-domain/src/lower/write.ts:138

readonly policy: Policy<User, never>

The rules' implementations: the guard judges the write with them.

LowerConfig.revision

property · packages/remote-domain/src/lower/write.ts:140

readonly revision: RevisionKey<EntityOf<M>>

The field every event moves, which expect reads.

LowerConfig.principal

property · packages/remote-domain/src/lower/write.ts:142

readonly principal: Context.Key<PrincipalId, Option.Option<User>>

Who asks, as the command's middleware provides it: none for a visitor.

LowerConfig.middleware

property · packages/remote-domain/src/lower/write.ts:144

readonly middleware: Ms

The middleware the command runs behind, which provides principal.

LowerConfig.listed

property · packages/remote-domain/src/lower/write.ts:146

readonly listed: Listed

The event that makes a row exist, carrying the whole row.

LowerConfig.event

property · packages/remote-domain/src/lower/write.ts:148

readonly event: Ev

The event the command records.

LowerConfig.record

property · packages/remote-domain/src/lower/write.ts:150

readonly record: (
  after: RowOf<EntityOf<M>>,
  before: RowOf<EntityOf<M>>,
  input: InputOf<M>,
) => Domain.Aggregate.InstanceOf<Ev>

The event recorded for a write that landed: which outcome it carries.

LowerConfig.apply

property · packages/remote-domain/src/lower/write.ts:156

readonly apply: (
  row: RowOf<EntityOf<M>>,
  event: Domain.Aggregate.InstanceOf<Ev>,
) => RowOf<EntityOf<M>>

The row after the event: copies the outcome it carries, and decides nothing.

LowerConfig.operators

property · packages/remote-domain/src/lower/write.ts:161

readonly operators?: MemoryOperators | undefined

The memory table the rules and invariants are judged by. Operators.kernel when not given.