Remote / foldkit-remote-domain/lower

Lowered

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

interface Lowered<
  M extends LowerableMutation,
  PrincipalId,
  Ms extends Domain.Middleware.List,
  Listed extends Domain.Event.Any,
  Ev extends Domain.Event.Any,
> {
  readonly command: LoweredCommand<M, Ev, Ms>
  readonly rejections: RejectionsOf<M>
  readonly state: Schema.Codec<LoweredState<EntityOf<M>>, unknown>
  readonly initial: LoweredState<EntityOf<M>>
  readonly decide: (
    state: LoweredState<EntityOf<M>>,
    command: Domain.Aggregate.InstanceOf<LoweredCommand<M, Ev, Ms>>,
    ctx: DecideContext<string>,
  ) => Effect.Effect<
    ReadonlyArray<Domain.Aggregate.InstanceOf<Ev>>,
    Domain.Aggregate.InstanceOf<RejectionClassOf<M>>,
    PrincipalId
  >
  readonly evolve: {
    readonly [Tag in Listed['tag'] | Ev['tag']]: EvolveOf<M, Listed, Ev, Tag>
  }
  readonly reply: (
    state: LoweredState<EntityOf<M>>,
  ) => Partial<RowOf<EntityOf<M>>>
  readonly view: {
    readonly state: EntityOf<M>['schema']
    readonly evolve: {
      readonly [Tag in Listed['tag'] | Ev['tag']]: ViewEvolveOf<
        M,
        Listed,
        Ev,
        Tag
      >
    }
  }
  readonly binding: <A extends AnyApi>(api: A) => CommandBinding<M, A>
  readonly reads: <A extends AnyApi, const Name extends ViewNameOf<A>>(
    api: A,
    name: Name,
  ) => ViewBinding<EntityOf<M>, A>
}

What a lowered write hands the aggregate, its View and the adapter.

Members

Lowered.command

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

readonly command: LoweredCommand<M, Ev, Ms>

Lowered.rejections

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

readonly rejections: RejectionsOf<M>

Lowered.state

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

readonly state: Schema.Codec<LoweredState<EntityOf<M>>, unknown>

The aggregate's state schema and the state of one never listed.

Lowered.initial

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

readonly initial: LoweredState<EntityOf<M>>

Lowered.decide

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

readonly decide: (
  state: LoweredState<EntityOf<M>>,
  command: Domain.Aggregate.InstanceOf<LoweredCommand<M, Ev, Ms>>,
  ctx: DecideContext<string>,
) => Effect.Effect<
  ReadonlyArray<Domain.Aggregate.InstanceOf<Ev>>,
  Domain.Aggregate.InstanceOf<RejectionClassOf<M>>,
  PrincipalId
>

The command's handler: the write landed through the server's chain, then the Reused check.

Lowered.evolve

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

readonly evolve: {
  readonly [Tag in Listed['tag'] | Ev['tag']]: EvolveOf<M, Listed, Ev, Tag>
}

How each event folds into the aggregate's state.

Lowered.reply

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

readonly reply: (
  state: LoweredState<EntityOf<M>>,
) => Partial<RowOf<EntityOf<M>>>

The command's reply: the fields the write sets, and the revision.

Lowered.view

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

readonly view: {
  readonly state: EntityOf<M>['schema']
  readonly evolve: {
    readonly [Tag in Listed['tag'] | Ev['tag']]: ViewEvolveOf<
      M,
      Listed,
      Ev,
      Tag
    >
  }
}

The by-id View's state and evolve, the aggregate's row field for field.

Lowered.binding

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

readonly binding: <A extends AnyApi>(api: A) => CommandBinding<M, A>

The adapter's binding of the command, for the Api that serves it.

Lowered.reads

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

readonly reads: <A extends AnyApi, const Name extends ViewNameOf<A>>(
  api: A,
  name: Name,
) => ViewBinding<EntityOf<M>, A>

The adapter's binding of the by-id View, for the Api that serves it under name.