dom-mutation/com.j0y.joy.dom.mutation

Package-level declarations

Types

sealed class Action

One thing an interaction does.

class ActionError(val identity: String, val verb: String, val path: String, val at: List<Int> = emptyList(), message: String? = null)

Why an interaction stopped.

ApplyResult

data class ApplyResult(val state: <Error class: unknown class>, val events: List<EmittedEvent> = emptyList(), val error: ActionError? = null)

What one interaction produced.

EmittedEvent

data class EmittedEvent(val name: String, val params: <Error class: unknown class> = JsonObject(emptyMap()))

An event an interaction produced, in the order it was reached.

JoyStore

class JoyStore(view: <Error class: unknown class>, initialState: <Error class: unknown class> = JsonObject(emptyMap()), resolver: <Error class: unknown class> = Resolver.Default, onEvent: (EmittedEvent) -> Unit? = null, onError: (LoggedEvent, ActionError) -> Unit? = null)

The one state owner: holds the state and the session log, and runs dispatch → apply → resolve serially.

LoggedEvent

data class LoggedEvent(val binding: Action.Emit, val payload: <Error class: unknown class> = JsonNull)

One interaction as it was fired — enough to replay it.

MutationAction

sealed class MutationAction : Action

A write against state: a verb, an RFC 6901 path, and whatever the verb needs.

Functions

applyAction

fun applyAction(state: <Error class: unknown class>, action: Action, payload: <Error class: unknown class> = JsonNull): ApplyResult

Runs action against state and returns the settled state plus the events it emitted.

dispatchEvent

fun dispatchEvent(state: <Error class: unknown class>, binding: Action.Emit, handlers: Map<String, Action>, payload: <Error class: unknown class> = JsonNull): ApplyResult

Resolves a fired binding against the document's handlers region and runs one interaction.

handlersOf

fun handlersOf(document: <Error class: unknown class>): Map<String, Action>

The document's handlers region: event name → Action.