API reference

The Wizard facade

Inject Invelity\WizardPackage\Contracts\Factory instead of using the facade if you prefer contracts.

A wizard instance

State

Flow

Changes

Navigation items

foreach ($wizard->navigation('summary')->items as $item) {
    $item->id;            // "calculator"
    $item->title;         // "Calculator"
    $item->position;      // 1
    $item->status;        // StepStatus::Pending | Completed | Skipped
    $item->current;       // true for the step the navigation is seen from
    $item->accessible;
    $item->optional;
    $item->displayOnly;
    $item->url;           // see "Step URLs"
}

Navigation and progress also implement Arrayable and JsonSerializable.

HTTP API

The package registers no routes. Register the JSON API of a wizard where you want it:

Route::middleware(['web', 'auth'])->group(function () {
    Route::wizard('order', OrderWizard::class);
});

How the routes are registered:

• Names follow the URI, like resource routes (shops/{shop}/checkout → shops.checkout.*), and pick up the group’s prefix, name and middleware.
• Constraints: {step} only matches the wizard’s steps. process leaves out display-only steps, and skip exists only for optional steps.
• Session: the session store needs the web middleware group.

Every endpoint returns the same shape:

{
  "data": {
    "wizard": "order",
    "step": {
      "id": "personal-data",
      "title": "Personal Data",
      "is_optional": false,
      "is_display_only": false,
      "data": {}
    },
    "previous_step": "calculator",
    "next_step": "newsletter",
    "is_completed": false,
    "progress": { "completed_steps": 1, "total_steps": 5, "percentage": 20 },
    "navigation": [
      {
        "id": "calculator",
        "title": "Calculator",
        "position": 1,
        "status": "completed",
        "is_current": false,
        "is_accessible": true,
        "is_optional": false,
        "is_display_only": false,
        "url": "https://example.com/order/calculator"
      }
    ]
  }
}

Errors use Laravel’s own responses:

Middleware

For steps served from your own routes, EnsureStepIsAccessible redirects visitors to the step they should be on, or answers 403 to JSON requests:

use Invelity\WizardPackage\Http\Middleware\EnsureStepIsAccessible;

Route::get('/checkout/{step}', ShowCheckoutStep::class)
    ->middleware(EnsureStepIsAccessible::using(OrderWizard::class));

Route::get('/flow/{page}', ShowPage::class)
    ->middleware('wizard.step:'.OrderWizard::class.',page');   // custom route parameter

The default redirect is the same route with the step parameter replaced. Send visitors elsewhere with:

EnsureStepIsAccessible::redirectUsing(
    fn (Request $request, Wizard $wizard, Step $step) => route('checkout.start'),
);

Exceptions

Commands