Enum LaravelUi5\Core\Enums\ArtifactType

A UI5 module providing a logical container for artifacts such as applications, cards, KPIs, actions, or libraries. Modules define the namespace scope and slug used for routing and access control, and typically correspond to a PHP package or subdirectory within the ui5/ structure.

Modules themselves are not directly routable or versioned as standalone resources, but serve as the root context for all included artifacts.

A standalone UI5 application with its own routing, Component.js, and entry point. Typically served as a separate HTML page.

A reusable UI5 library containing controls, formatters, helpers, or shared logic. Can be imported by multiple applications.

A UI5 Integration Card, such as ObjectCard, ListCard, or TableCard. Usually configured via a manifest and rendered inside a dashboard or shell.

A backend-powered report providing structured tabular or aggregated data. Typically supports parameterization and optional export (e.g., CSV, Excel).

A Tile definition, representing a lightweight but versioned UI5 artifact.

Tiles act as UI composition units within dashboards, launchpads, or other shell containers. Each tile provides metadata such as title, description, icon, and target, and may reference other artifacts (e.g., KPI, Report, App).

Unlike Cards, Tiles are not intended for complex rendering or configuration. They primarily serve as entry points or compact visual summaries, often embedding KPIs or linking to other routable artifacts.

Characteristics:

• Routable: No. Tiles are embedded only, never accessed via URL directly.
• Versionable: Yes. Tile layout, label, or KPI binding may change over time.
• Discoverable: Yes. Tiles are registered in the Ui5Registry.

A KPI (Key Performance Indicator) definition, representing a reusable and versioned data artifac within the system.

KPIs encapsulate metadata such as ID, title, unit, aggregation logic, thresholds, and applicable contexts. They provide the data basis for visualization in Tiles, Cards, or Dashboards.

Characteristics:

• Routable: No. KPIs are data definitions, not standalone UI routes.
• Versionable: Yes. Thresholds, aggregation rules, or calculation logic may evolve over time.
• Reusable: Yes. The same KPI can appear in multiple Tiles, Cards, or Dashboards.
• Discoverable: Yes. KPIs are registered in the Ui5Registry.

A dashboard aggregating multiple Cards or Tiles in a layout. May be statically defined (via manifest) or assembled dynamically.

A backend-bound action that can be triggered via direct API route. UI5 Actions are invokable controller classes designed for stateless interaction, such as toggling flags, triggering workflows, or executing custom business logic.

Actions are uniquely addressable within their module via an HTTP method and route segment.

A Resource is a lightweight, read-only UI5 artifact that exposes structured data for consumption by the client (e.g., cards, dashboards, lists).

A Ui5Dialog represents a globale invokable View/Controller pair bound to a named URI segment.

Returns a human-readable label for the artifact type.

Returns the composed URL key (slug path) for a given artifact.

The URL key determines the routing path used by the UI5 frontend and Laravel backend to locate and invoke this artifact. It forms the core part of the dynamic route segment that appears in URLs like:

/ui5/app/{slug}/{version} /ui5/card/{module}/{slug} /ui5/api/{module}/{action}

This method mirrors the routing conventions defined in routes/ui5.php and must remain in sync with the corresponding Route::pattern definitions.

In cases where no slug is required (e.g., Applications or Libraries), the returned path includes only the module-level key (e.g. "app/core").

In cases where the artifact is not addressable via URL (e.g., abstract types), this method returns null.

Resolve a UI5 artifact urlKey from a request path.

This method inspects the path relative to the configured UI5 route prefix and attempts to construct a valid urlKey suitable for Ui5Registry lookup.

Expected formats:

• app/{module}
• lib/{module}
• card/{module}/{slug}
• dashboard/{slug}
• report/{module}.{slug}
• api/{module}/{slug}
• resource/{module}/{slug}

Behavior:

• Returns the normalized urlKey string (e.g. "card/foo/bar").
• Aborts with HTTP 400 if the path matches a UI5 artifact type but is incomplete or malformed.
• Aborts with HTTP 400 if the path has fewer than two parts or does not map to a known artifact type.