Arc (cratis_arc v0.1.0)

Arc for Elixir: an opinionated CQRS application framework for Phoenix and Plug, on Cratis Chronicle.

You declare what your application does as plain modules, and Arc serves it:

Arc.Command - a request struct with a handle/2 that decides and returns events
Arc.ReadModel - queries over a Chronicle read model, snapshot or observable
Arc.Application - the supervised runtime that discovers them
Arc.Plug - the Arc HTTP contract, so @cratis/arc, @cratis/arc.react and Cratis Components work against it unchanged
Arc.LiveView - the same commands and queries, called in-process from LiveView
Arc.ProxyGenerator - opt-in TypeScript proxies for React
Arc.Test - ExUnit scenarios that run the real pipelines

Use execute/3 and query/5 to call the pipelines from code.

Summary

Builds a context for application from the given options.

Executes a command through the full pipeline.

new_id()

A new UUID v4 string, for a command key such as a new author's id.

Executes a query of a read model by function name.

@spec context(module(), keyword()) :: Arc.Context.t()

Builds a context for application from the given options.

@spec execute(module(), struct() | {module(), map()}, keyword()) ::
  Arc.CommandResult.t()

Executes a command through the full pipeline.

command is a command struct, or a {module, wire_map} pair to bind a wire map first.

:principal, :tenant, :correlation_id, :causation_id, :metadata - context values
:validate_only - authorize and validate without handling

@spec new_id() :: String.t()

A new UUID v4 string, for a command key such as a new author's id.

%RegisterAuthor{id: Arc.new_id(), name: "Ada"}

@spec query(module(), module(), atom(), map(), keyword()) :: Arc.QueryResult.t()

Executes a query of a read model by function name.

args are the declared parameters, as a map keyed by name (atoms or strings).

context options as for execute/3
:page, :page_size, :sort_by, :sort_direction - see Arc.Pipeline.execute_query/5