API Reference incant v#0.1.0

Code-first admin, content, analytics, and operations surfaces for Phoenix applications.

Semantic results returned by Incant actions.

Expose a prepared download.

A user-visible action error.

Expose a background job created by an action.

Navigate to a route.

Open another semantic Incant surface.

Refresh one or more semantic targets.

Reveal a one-time value (such as a newly created secret) to the user.

A user-visible notification.

Defines the root Incant admin surface for an application.

Transport-safe description of an Incant admin surface.

Compiled metadata for an Incant admin surface.

Defines a code-first dashboard with variables and widgets.

Metadata for a dashboard table widget column.

Compiled metadata for an Incant dashboard.

Metadata for a dashboard variable.

Metadata for a dashboard widget.

Behaviour for non-Ecto and analytical data sources.

Defines a code-first analytical dataset.

Metadata for an analytical dataset dimension.

Metadata for a table drilldown path in an analytical dataset.

Metadata for an analytical dataset filter.

Compiled metadata for an Incant analytical dataset.

Metadata for an analytical dataset metric.

Metadata for the default table view of an analytical dataset.

Design-token names and CSS defaults used by Incant renderers.

Small Ecto helpers for application-owned Incant resource queries.

Behaviour and dispatcher for Incant table filters.

Boolean filter implementation.

Date range filter implementation.

Multi-select filter implementation.

Single-select filter implementation.

Text filter implementation.

Metadata for resource create/edit forms.

Metadata for a resource form field.

Helpers for resolving resource form fields and changesets.

Generic LiveView renderer for an Incant admin surface.

Shared Incant LiveView components for admin surfaces.

Configurable naming for inferred Incant labels and titles.

Normalizes option declarations into portable label/value maps.

Behaviour for Incant admin authorization policies.

Normalized query request passed to Incant data sources.

Defines a code-first admin resource.

Compiled metadata for an Incant resource.

Normalized result returned by Incant data sources.

Router helpers for mounting Incant admin surfaces.

Helpers for secret/sensitive Incant metadata.

Behaviour for service-owned Incant admin surfaces.

Client-side handle for an Incant service exposed through SafeRPC.

Request to describe an Incant service.

A discovered Incant service endpoint and its loaded admin contract.

Request to index an Incant surface.

Request to read one item from an Incant surface.

Runtime registry for remotely discovered Incant services.

Supervised process for a central Incant service registry.

Request to run an Incant surface action.

Request to run an Incant dashboard widget query.

Admin UI session for one discovered Incant service entry.

Unified Incant admin session interface.

Local BEAM-backed Incant admin session.

Common envelope for top-level Incant admin surfaces.

Metadata for a resource table.

Metadata for a table action.

Metadata for a resource table column.

Metadata for a resource table filter.

Normalizes common tabular data shapes into rows, columns, and metadata.

Defines Tailwind 4 and CSS-variable-first theme metadata.

Compiled metadata for an Incant theme.

Semantic admin UI layer used by Incant render adapters.

Semantic user-triggered command.

Group of related UI actions.

Action menu model for adapters that render compact command surfaces.

Behaviour for Incant UI render adapters.

Default Incant UI adapter backed by Phoenix LiveView components.

Reads Incant UI configuration.

Builders for semantic Incant UI controls.

Semantic Boolean control.

Semantic Combobox control.

Semantic Date control.

Semantic DateRange control.

Semantic Hidden control.

Semantic MultiSelect control.

Semantic Number control.

Semantic Relation control.

Semantic Select control.

Semantic Text control.

A semantic description of the current Incant admin screen.

Runtime environment passed to UI adapters.

Normalized event envelope shared by Incant UI adapters.

Typed filter state normalized from portable URL and service filter values.

An applied filter condition.

A filter field available to the current surface.

Focus intent for adapters.

Semantic chart specification for dashboard widgets.

Search and filter controls for a resource or dashboard variables surface.

Resource form model.

Semantic header metadata for a surface.

Record detail/inspector model.

Admin navigation region.

Resource table model.

Dashboard widget grid model.

Dashboard surface model.

Dataset table surface.

Empty or unauthorized admin surface.

Resource index/list surface model.

Incant registry landing surface listing discovered services.

Display value helper for UI nodes.

Strict JSON HTTP API for the standalone Incant admin release.

Action invocation payload carried inside Incant.Web.API.ActionRunRequest.

Typed request contract for running Incant actions over the standalone HTTP API.

Typed request contract for standalone Incant resource queries.

Phoenix endpoint for standalone Incant deployments.

Minimal health endpoint for standalone Incant deployments.

HTTP router for the standalone Incant admin release.

Generates starter Incant admin files and patches Phoenix setup when possible.