API Reference blog_engine v#0.1.0

Copy Markdown View Source

Modules

Tenant-scoped entry point for the BlogEngine Elixir API.

Selects submitted attributes from string- or atom-keyed maps, honoring clearable fields.

Composes append-only audit writes and post-commit event delivery.

Validates command actors and delegates authorization to the host application.

Allows every command after BlogEngine validates its actor and action.

Denies every BlogEngine command.

Tenant-scoped author commands and reads.

Tenant-scoped blog configuration commands and reads.

Provides context-selected UTC time for deterministic BlogEngine operations.

Uses the system clock for BlogEngine operations.

Runtime dependencies and tenant identity for a BlogEngine operation.

Stable error value returned by BlogEngine operations.

Argument parsing, validation, and file helpers shared by the BlogEngine generators.

Row locks shared by the route registry and the routing lifecycle.

Versioned BlogEngine schema migrations for host applications.

Initial prefix-safe BlogEngine database schema.

Dispatches committed BlogEngine events to a host notifier.

Ignores committed BlogEngine events.

A transport-neutral page of BlogEngine records.

Public tenant-scoped post authoring, review, publication, and moderation API.

A stable public author projection used by editorial post reads.

Tenant-scoped post authoring, publication, review, and moderation commands.

A stable post projection for an editorial review queue.

Stable, non-persisted input boundary for BlogEngine revision forms.

Working-revision writes for posts.

A stable editorial projection of a post's effective editable revision.

A stable public tag projection used by editorial post reads.

Transport-neutral public read models for effective blog content.

A transport-neutral public post projection.

Stable route ownership data passed to a host route registry.

Stable route claim whose durable owner and exclusions were verified by BlogEngine.

Validates route claims and delegates host route conflict checks.

Accepts claims for BlogEngine's own tenant-scoped route table.

Validates and materializes safe canonical route templates.

Tenant-scoped route reservations, history, template moves, and resolution.

Stable tenant-scoped facts about one durable BlogEngine route reservation.

An append-only record of a BlogEngine domain change.

A tenant-owned author identity.

A publisher-owned blog and its routing policy.

A stable post identity with lifecycle state and revision pointers.

An authored content revision for a post.

The tenant-safe join between a post revision and a tag.

A reserved draft, current, or former path for a blog or post.

A curated request to syndicate a post into another blog.

A tenant-scoped post tag.

Prefix-safe access to the host application's Ecto Repo.

Curated, tenant-scoped syndication workflow.

A stable projection of a requested syndication placement.

Race-safe tenant tag normalization and lookup.

Mix Tasks

Diagnoses the installed BlogEngine version and immutable PostgreSQL catalog.

Generates a host-owned ReqLLM assistant for editorial suggestions.

Generates a host-owned Phoenix LiveView editor for BlogEngine.

Generates a pinned wrapper for one supported adjacent BlogEngine schema upgrade.

Generates host-owned Phoenix controllers for BlogEngine public pages.

Installs BlogEngine configuration and queues its host-owned migration.

Generates the host application's pinned initial BlogEngine migration wrapper.