Laravel Cloudflare Turnstile

https://github.com/ryangjchandler/laravel-cloudflare-turnstile
Admin
A simple Laravel package that provides helpers for setting up and validating Cloudflare Turnstile...
Tokens:29,729
Snippets:215
Trust Score:8.9
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install laravel-cloudflare-turnstile via Composer

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

Install the package via Composer.

```bash
composer require ryangjchandler/laravel-cloudflare-turnstile
```

--------------------------------

### Manual registration of LaravelCloudflareTurnstileServiceProvider

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/service-provider.md

Manual registration example for when Composer auto-discovery is not honored. Add the provider class to your application's provider list or testbench's getPackageProviders method.

```php
use RyanChandler\LaravelCloudflareTurnstile\LaravelCloudflareTurnstileServiceProvider;

// Provider list for your application/testbench:
getPackageProviders(app) {
    return [
        LaravelCloudflareTurnstileServiceProvider::class,
    ];
}
```

--------------------------------

### CSP nonce example for Scripts component

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/view-components.md

Example usage of the Scripts component with a CSP nonce attribute, and the resulting rendered HTML. The nonce attribute is forwarded to the script tag.

```blade
<x-turnstile.scripts nonce="{{ $nonce }}" />
```

```html
<script src="https://challenges.cloudflare.com/turnstile/v0/api.js" async defer nonce="..."></script>
```

--------------------------------

### Set Turnstile keys in .env

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

Add your Turnstile keys to the .env file. The values shown are example keys from Cloudflare.

```plaintext
TURNSTILE_SITE_KEY="1x00000000000000000000AA"
TURNSTILE_SECRET_KEY="2x0000000000000000000000000000000AA"
```

--------------------------------

### Verify through facade while faked

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/fake-client.md

Verify through the facade while the fake is installed. After calling `fail()`, `siteverify()` returns a response with `success` false and `errorCodes` containing `invalid-input-response`. Use `Turnstile::dummy()` to generate a dummy token for verification.

```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;

$fake = Turnstile::fake();
$fake->fail();

$response = Turnstile::siteverify(Turnstile::dummy());

if (! $response->success) {
    // ['invalid-input-response']
    $hasExpectedCode = in_array('invalid-input-response', $response->errorCodes);
}
```

--------------------------------

### Resolving manually from the container

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client-interface.md

Example of resolving the ClientInterface from the Laravel container and using it to verify a Turnstile token.

```php
use RyanChandler\LaravelCloudflareTurnstile\Contracts\ClientInterface;

// Inside an Illuminate/Laravel context:
$client = app(ClientInterface::class);

if ($client->siteverify($token)->success) {
    // verified
}
```

--------------------------------

### GET api.js

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/types.md

Documentation for the Cloudflare Turnstile asset endpoint that the package's Blade component loads.

```APIDOC
## [GET] https://challenges.cloudflare.com/turnstile/v0/api.js

### Description
Loads the Turnstile JavaScript asset for rendering the widget. The package's Blade component loads this script with `async defer` and forwards attributes.

### Method
GET

### Endpoint
https://challenges.cloudflare.com/turnstile/v0/api.js

### Response
#### Success Response (200)
- JavaScript file content (not specified in source).
```

--------------------------------

### Verify a Turnstile token with Turnstile::siteverify()

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/facade-turnstile.md

Example of using the Turnstile facade to verify a submitted Turnstile token. The response is a SiteverifyResponse object; check its success property to determine validity.

```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;

$result = Turnstile::siteverify($request->input('cf-turnstile-response'));

if ($result->success) {
    // token valid
}
```

--------------------------------

### Fake Turnstile with default passing behavior

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/facade-turnstile.md

Example of faking the Turnstile facade so that all subsequent verifications succeed. This is useful for tests where you want to simulate a valid token.

```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;
use RyanChandler\LaravelCloudflareTurnstile\Rules\Turnstile as TurnstileRule;

Turnstile::fake(); // every subsequent verification succeeds
```

--------------------------------

### Livewire binding with custom ID and error handling

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/view-components.md

Livewire binding with a custom ID. The Blade example shows a valid ID; the PHP example shows error handling for an invalid ID (with a space) that throws a ViewException.

```blade
{{-- id must match /^[a-zA-Z_][a-zA-Z0-9_]*$/ --}}
<x-turnstile id="contact_captcha" wire:model="turnstileToken" data-theme="light" />
```

```php
try {
    $html = Blade::render('<x-turnstile id="contact captcha" wire:model="turnstileToken" />');
} catch (ViewException $e) {
    // Message: "The Turnstile ID [contact captcha] must start with a
    // letter or underscore, and can only contain alphanumeric or
    // underscore characters."
    logError($e);
}
```

--------------------------------

### Submit a dummy token with Turnstile::dummy()

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/resources/boost/skills/turnstile-development/SKILL.md

Use Turnstile::dummy() to get a placeholder token for submitting a form in tests, allowing you to assert redirects without a real challenge.

```php
$this->post('/contact', [
    'name' => 'Jan',
    'cf-turnstile-response' => Turnstile::dummy(),
])->assertRedirect();
```

--------------------------------

### FakeClient class implementation

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/fake-client.md

Full class definition of FakeClient, an in-memory implementation of ClientInterface used to avoid real HTTP calls to Cloudflare during tests. Installed via Turnstile::fake() which swaps it into the container under the ClientInterface binding. Provides fail(), expired(), pass(), siteverify(), and dummy() methods to control test behavior.

```php
namespace RyanChandler\LaravelCloudflareTurnstile\Testing;

use Illuminate\Support\Testing\Fakes\Fake;
use RyanChandler\LaravelCloudflareTurnstile\Contracts\ClientInterface;
use RyanChandler\LaravelCloudflareTurnstile\Responses\SiteverifyResponse;

class FakeClient implements ClientInterface, Fake
{
    protected bool $shouldPass = true;

    protected bool $isExpired = false;

    public function fail(): self
    {
        $this->shouldPass = false;

        return $this;
    }

    public function expired(): self
    {
        $this->isExpired = true;

        return $this;
    }

    public function pass(): self
    {
        $this->shouldPass = true;

        return $this;
    }

    public function siteverify(string $response): SiteverifyResponse
    {
        if ($this->isExpired) {
            return SiteverifyResponse::failure(['timeout-or-duplicate']);
        }

        if (! $this->shouldPass) {
            return SiteverifyResponse::failure(['invalid-input-response']);
        }

        return SiteverifyResponse::success();
    }

    public function dummy(): string
    {
        return self::RESPONSE_DUMMY_TOKEN;
    }
}
```

--------------------------------

### Plain Turnstile widget example

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/view-components.md

Plain widget usage without wire:model. Passes through user attributes like data-action, data-theme, data-tabindex, and data-error-callback to the rendered <div>.

```blade
<form action="/" method="POST">
    <x-turnstile
        data-action="login"
        data-theme="dark"
        data-tabindex="1"
        data-error-callback="errorCallback"
    />
    <button>Submit</button>
</form>
```

--------------------------------

### Force failure modes with Turnstile::fake()->fail() and expired()

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/facade-turnstile.md

Example of forcing specific failure modes on the fake client: fail() for 'invalid-input-response', expired() for 'timeout-or-duplicate', and pass() to reset. Then verify and inspect error codes.

```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;

// Fail with 'invalid-input-response':
Turnstile::fake()->fail();

// Or fail with 'timeout-or-duplicate':
$fake = Turnstile::fake();
$fake->expired();

// Reset a previously-failing fake back to passing:
$fake->pass();

// Now verify and inspect the outcome:
$result = Turnstile::siteverify(Turnstile::dummy());

if (! $result->success) {
    foreach ($result->errorCodes as $code) {
        // 'timeout-or-duplicate' or 'invalid-input-response' here
    }
}
```

--------------------------------

### Handling timeout-or-duplicate error code

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/rule-turnstile.md

Example of distinguishing error codes by calling the Turnstile facade directly, useful in a Livewire property. It checks for the 'timeout-or-duplicate' error code to detect a used or expired token and resets the widget. The token is single-use; a second validation of the same token fails with that error.

```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile as TurnstileFacade;
use RyanChandler\LaravelCloudflareTurnstile\Rules\Turnstile;

$response = TurnstileFacade::siteverify($this->turnstileToken);

if (! $response->success && in_array('timeout-or-duplicate', $response->errorCodes)) {
    // Token already used or expired — reset the widget for a retry.
    $this->reset('turnstileToken');
}
```

--------------------------------

### Cloudflare siteverify response JSON

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/types.md

Example JSON response body from the Cloudflare Turnstile siteverify endpoint. The `success` field is compared with a strict `=== true` check, and `error-codes` is cast to an array and stored in `SiteverifyResponse::$errorCodes`.

```json
{
    "success": true,
    "error-codes": []
}
```

--------------------------------

### dummy(): string

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client.md

Documentation for the dummy() method of the Client class.

```APIDOC
## `dummy(): string`

### Description
Returns the constant `self::RESPONSE_DUMMY_TOKEN` — the sentinel value `'XXXX.DUMMY.TOKEN.XXXX'`. Used to fabricate a token for tests or other plumbing; it is **not** a valid Cloudflare token.

### Method
`dummy()`

### Parameters
No parameters.

### Returns
`string` — `'XXXX.DUMMY.TOKEN.XXXX'`.

### Example
```php
use RyanChandler\LaravelCloudflareTurnstile\Client;

$payload = ['cf-turnstile-response' => (new Client('secret'))->dummy()];
```
```

--------------------------------

### Generate dummy token with Client::dummy()

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client.md

Creates a dummy token for testing or plumbing purposes. The dummy token is not a valid Cloudflare token and should not be used in production.

```php
use RyanChandler\LaravelCloudflareTurnstile\Client;

$payload = ['cf-turnstile-response' => (new Client('secret'))->dummy()];
```

--------------------------------

### Basic construction and reads with SiteverifyResponse

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/siteverify-response.md

Shows basic construction and reads: SiteverifyResponse::success() yields success=true and empty errorCodes; SiteverifyResponse::failure(['invalid-input-response']) yields success=false and the given error codes. Both properties are public readonly.

```php
use RyanChandler\LaravelCloudflareTurnstile\Responses\SiteverifyResponse;

$ok = SiteverifyResponse::success();
if ($ok->success && $ok->errorCodes === []) {
    // verified
}

$failed = SiteverifyResponse::failure(['invalid-input-response']);
if (! $failed->success) {
    foreach ($failed->errorCodes as $code) {
        handleError($code);
    }
}
```

--------------------------------

### ClientInterface

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client-interface.md

Documentation for the ClientInterface contract, including its constant, method contract, implementors, and usage as a container binding key.

```APIDOC
## ClientInterface

### Description
Container contract implemented by both the production `Client` and the testing `FakeClient`. It is also used as the container binding key for the scoped singleton registered by the service provider.

### Import Path
`RyanChandler\LaravelCloudflareTurnstile\Contracts\ClientInterface`

### Source File
`src/Contracts/ClientInterface.php` — interface declared at line 7

### Interface Signature
```php
namespace RyanChandler\LaravelCloudflareTurnstile\Contracts;

use RyanChandler\LaravelCloudflareTurnstile\Responses\SiteverifyResponse;

interface ClientInterface
{
    const RESPONSE_DUMMY_TOKEN = 'XXXX.DUMMY.TOKEN.XXXX';

    public function siteverify(string $response): SiteverifyResponse;
}
```

### Constant

#### `RESPONSE_DUMMY_TOKEN`

| Constant | Type | Value |
|----------|------|-------|
| `RESPONSE_DUMMY_TOKEN` | `string` | `'XXXX.DUMMY.TOKEN.XXXX'` |

A sentinel token value returned by `Client::dummy()` and `FakeClient::dummy()` via `self::RESPONSE_DUMMY_TOKEN`. It exists to allow tests to submit a non-empty placeholder value; it carries no meaning for Cloudflare.

### Method Contract

#### `siteverify(string $response): SiteverifyResponse`

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `response` | `string` | Yes | — | The submitted Turnstile token (the `cf-turnstile-response` form field). |

**Returns:** `SiteverifyResponse` — the verification outcome. See [siteverify-response.md](siteverify-response.md).

The interface declares **no `dummy()` method**; both implementors provide it independently. The `Turnstile` facade exposes `dummy()` statically via its `@method` docblock, but `dummy()` is not part of the `ClientInterface` contract.

### Implementors

| Class | Source | Notes |
|-------|--------|-------|
| `Client` | `src/Client.php:9` | Production implementation; performs the real HTTP round trip to `https://challenges.cloudflare.com/turnstile/v0/siteverify`. |
| `FakeClient` | `src/Testing/FakeClient.php:9` | In-memory fake; also implements `Illuminate\Support\Testing\Fakes\Fake`. Returned by `Turnstile::fake()`. |

### Role as Container Binding Key

The service provider binds this interface as a scoped singleton:

```php
$this->app->scoped(ClientInterface::class, static function (Application $app): Client {
    return new Client($app['config']->get('services.turnstile.secret'));
});
```

Because the facade's `getFacadeAccessor()` returns `ClientInterface::class`, every static facade call (`Turnstile::siteverify()`, `Turnstile::dummy()`) resolves through this binding. `Turnstile::fake()` swaps the binding to a `FakeClient` instance.

### Example — Resolving Manually from the Container

```php
use RyanChandler\LaravelCloudflareTurnstile\Contracts\ClientInterface;

// Inside an Illuminate/Laravel context:
$client = app(ClientInterface::class);

if ($client->siteverify($token)->success) {
    // verified
}
```

### Related

- [client.md](client.md) — production implementation
- [fake-client.md](fake-client.md) — test implementation
- [facade-turnstile.md](facade-turnstile.md) — static accessor bound to this interface
```

--------------------------------

### SiteverifyResponse

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/types.md

Documentation for the SiteverifyResponse class, including its constructor, properties, methods, and usage context.

```APIDOC
## SiteverifyResponse

### Description
Represents the result of a Cloudflare Turnstile siteverify request. It exposes the success flag and any error codes returned by Cloudflare, and can be converted to an array mirroring Cloudflare's JSON body.

### Constructor
`__construct(bool $success, array $errorCodes)`

### Properties
- `success` (bool) - readonly - Whether Cloudflare accepted the token.
- `errorCodes` (array) - readonly - Cloudflare error-code strings when `success` is false; `[]` on success.

### Methods
- `toArray(): array` - Returns array representation with keys `success` and `error-codes`.
- `success(): self` - Static factory returning a successful response.
- `failure(array $errorCodes = []): self` - Static factory returning a failure response with optional error codes.

### Returned By
- `Client::siteverify()`
- `FakeClient::siteverify()`
- `ClientInterface::siteverify()`
- Facade-forwarded `Turnstile::siteverify()`

### Accepted By
- `Rules\Turnstile::validate()` (reads `->success`, `->errorCodes`)
```

--------------------------------

### Run tests with composer test

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

Runs the project's test suite via Composer. Use this command to execute all tests defined in the project.

```bash
composer test
```

--------------------------------

### ClientInterface interface signature

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client-interface.md

The exact interface signature from the source file, declaring the RESPONSE_DUMMY_TOKEN constant and the siteverify method contract.

```php
namespace RyanChandler\LaravelCloudflareTurnstile\Contracts;

use RyanChandler\LaravelCloudflareTurnstile\Responses\SiteverifyResponse;

interface ClientInterface
{
    const RESPONSE_DUMMY_TOKEN = 'XXXX.DUMMY.TOKEN.XXXX';

    public function siteverify(string $response): SiteverifyResponse;
}
```

--------------------------------

### SiteverifyResponse factory methods success() and failure()

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/types.md

Factory methods for creating SiteverifyResponse instances. success() returns a response with success true and empty error codes; failure() accepts an optional array of error codes and sets success false. These are used internally by the client and fake client.

```php
public static function success(): self
public static function failure(array $errorCodes = []): self
```

--------------------------------

### Publish translations and views

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/configuration.md

Publishes package translations and views to the application. Run the first command to copy language files (e.g., resources/lang/**) to lang/vendor, and the second to publish the Blade view templates. These commands are needed to override views or translations without editing the vendored package.

```bash
php artisan vendor:publish --tag=cloudflare-turnstile-translations
```

```bash
php artisan vendor:publish --tag=cloudflare-turnstile-views
```

--------------------------------

### ClientInterface contract with siteverify() and RESPONSE_DUMMY_TOKEN

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/types.md

Defines the contract for token verification. Includes the RESPONSE_DUMMY_TOKEN constant used as a sentinel placeholder in tests. Implemented by Client and FakeClient; the dummy() method is not part of this interface.

```php
interface ClientInterface
{
    const RESPONSE_DUMMY_TOKEN = 'XXXX.DUMMY.TOKEN.XXXX';

    public function siteverify(string $response): SiteverifyResponse;
}

```

--------------------------------

### Client Class Methods

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client.md

Code snippets for the Client class methods.

```APIDOC
## `__construct(string $secret)`

### Description
Creates a new `Client` instance with the provided Cloudflare Turnstile secret key. The secret is stored in the protected `$secret` property.

### Method
Constructor

### Parameters
- `secret` (string) - Required - Cloudflare Turnstile secret key.

### Notes
- The constructor accepts and stores the secret, but the `siteverify()` method uses `config('services.turnstile.secret')` for the outbound request, not the constructor argument.
```

```APIDOC
## `siteverify(string $response): SiteverifyResponse`

### Description
Verifies a Turnstile token against Cloudflare's `siteverify` endpoint. Returns a `SiteverifyResponse` object.

### Method
siteverify

### Parameters
- `response` (string) - Required - The Turnstile token to verify.

### Returns
- `SiteverifyResponse` - The verification result.
```

```APIDOC
## `dummy(): string`

### Description
Returns the dummy token constant `RESPONSE_DUMMY_TOKEN`.

### Method
dummy

### Returns
- `string` - The dummy token.
```

--------------------------------

### Configure Turnstile in config/services.php

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

Add the Turnstile configuration to config/services.php, using environment variables for the site key and secret.

```php
return [

    // ...,

    'turnstile' => [
        'key' => env('TURNSTILE_SITE_KEY'),
        'secret' => env('TURNSTILE_SECRET_KEY'),
    ],

];
```

--------------------------------

### Direct instantiation of FakeClient

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/fake-client.md

Instantiate the `FakeClient` directly for testing without the facade. After calling `expired()`, `siteverify()` returns a result with `errorCodes` equal to `['timeout-or-duplicate']`. The fake's `siteverify()` never throws and never touches the network.

```php
use RyanChandler\LaravelCloudflareTurnstile\Testing\FakeClient;

$client = new FakeClient;
$client->expired();

$result = $client->siteverify('anything');
// $result->errorCodes === ['timeout-or-duplicate']
```

--------------------------------

### SiteverifyResponse

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/siteverify-response.md

Documentation for the SiteverifyResponse value object, including its constructor, static factories, and toArray method.

```APIDOC
## `SiteverifyResponse`

### Description
Immutable value object describing the outcome of a `siteverify` call. Returned by every verification path: `Client::siteverify()`, `FakeClient::siteverify()`, and the `Turnstile` facade's forwarded `siteverify()`. Consumed by `Rules\Turnstile::validate()`.

### Constructor

`__construct(bool $success, array $errorCodes)`

#### Parameters
- **success** (bool) - Required - Verification outcome; promoted to `readonly` property `$this->success`.
- **errorCodes** (array) - Required - Cloudflare error-code strings (e.g. `'invalid-input-response'`); promoted to `readonly` property `$this->errorCodes`.

Both properties are `public readonly` — readable, not reassignable.

### Static Factories

#### `success(): self`

Returns `new self(true, [])` — a successful result with an empty error-code array.

#### `failure(array $errorCodes = []): self`

##### Parameters
- **errorCodes** (array) - Optional - Default: `[]` - Error-code strings describing why verification failed.

Returns `new self(false, $errorCodes)`.

### Methods

#### `toArray(): array`

Satisfies `Arrayable`. Returns the associative array (same keys as Cloudflare's `siteverify` JSON body):

| Key | Type | Description |
|-----|------|-------------|
| `success` | `bool` | The verification outcome |
| `error-codes` | `array` | The error codes |

### Example — basic construction and reads

```php
use RyanChandler\LaravelCloudflareTurnstile\Responses\SiteverifyResponse;

$ok = SiteverifyResponse::success();
if ($ok->success && $ok->errorCodes === []) {
    // verified
}

$failed = SiteverifyResponse::failure(['invalid-input-response']);
if (! $failed->success) {
    foreach ($failed->errorCodes as $code) {
        handleError($code);
    }
}
```

### Example — serializing with `toArray()`

```php
use RyanChandler\LaravelCloudflareTurnstile\Responses\SiteverifyResponse;

$response = SiteverifyResponse::failure(['timeout-or-duplicate', 'internal-error']);

$payload = $response->toArray();
// => ['success' => false, 'error-codes' => ['timeout-or-duplicate', 'internal-error']]

response()->json($payload);
```

### Where this type is accepted or returned

| Symbol | Direction | Source |
|--------|-----------|--------|
| `Client::siteverify()` | returns | `src/Client.php:15` |
| `ClientInterface::siteverify()` | returns | `src/Contracts/ClientInterface.php:11` |
| `FakeClient::siteverify()` | returns | `src/Testing/FakeClient.php:36` |
| `Turnstile::siteverify()` (facade dispatch) | returns | declared `src/Facades/Turnstile.php:11` |
| `Rules\Turnstile::validate()` | reads `->success`, `->errorCodes` | `src/Rules/Turnstile.php:15-21` |
```

--------------------------------

### Basic siteverify() verification

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client.md

Basic verification of a Turnstile token. Creates a Client with the configured secret, calls siteverify() with the cf-turnstile-response token, then branches on $result->success; on failure it iterates $result->errorCodes and reports each code.

```php
use RyanChandler\LaravelCloudflareTurnstile\Client;

$client = new Client(config('services.turnstile.secret'));

$result = $client->siteverify($request->input('cf-turnstile-response'));

if ($result->success) {
    // Token accepted by Cloudflare — proceed with the submission.
} else {
    // $result->errorCodes contains Cloudflare error-code strings.
    foreach ($result->errorCodes as $code) {
        report($code);
    }
}
```

--------------------------------

### Turnstile::fake(): FakeClient

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/facade-turnstile.md

Creates a new FakeClient, swaps it into the container for the ClientInterface binding, and returns the instance for chaining. After this call, facade calls such as siteverify() and validation through Rules\Turnstile resolve to the fake, making no HTTP requests.

```APIDOC
## Turnstile::fake(): FakeClient

### Description
Creates a new FakeClient, swaps it into the container for the ClientInterface binding, and returns the instance for chaining. After this call, facade calls such as siteverify() and validation through Rules\Turnstile resolve to the fake, making no HTTP requests.

### Method
Static method

### Parameters
None

### Returns
`FakeClient` - The newly created instance, for immediate chaining (`->fail()`, `->expired()`, `->pass()`).

### Example — default (all tokens pass)
```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;
use RyanChandler\LaravelCloudflareTurnstile\Rules\Turnstile as TurnstileRule;

Turnstile::fake(); // every subsequent verification succeeds
```

### Example — forcing specific failure modes
```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;

// Fail with 'invalid-input-response':
Turnstile::fake()->fail();

// Or fail with 'timeout-or-duplicate':
$fake = Turnstile::fake();
$fake->expired();

// Reset a previously-failing fake back to passing:
$fake->pass();

// Now verify and inspect the outcome:
$result = Turnstile::siteverify(Turnstile::dummy());

if (! $result->success) {
    foreach ($result->errorCodes as $code) {
        // 'timeout-or-duplicate' or 'invalid-input-response' here
    }
}
```
```

--------------------------------

### Use Turnstile::fake() to simulate token validation

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/resources/boost/skills/turnstile-development/SKILL.md

Swap the real client for a fake so tests never call Cloudflare. Use fail() to simulate invalid-input-response and expired() for timeout-or-duplicate.

```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;

Turnstile::fake();             // every token passes
Turnstile::fake()->fail();     // invalid-input-response
Turnstile::fake()->expired();  // timeout-or-duplicate
```

--------------------------------

### POST siteverify

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/types.md

Documentation for the Cloudflare Turnstile siteverify endpoint that the package's Client calls to verify tokens.

```APIDOC
## [POST] https://challenges.cloudflare.com/turnstile/v0/siteverify

### Description
Verifies a Turnstile token by sending a form-encoded request to the Cloudflare siteverify endpoint. The response body indicates whether the token is valid.

### Method
POST

### Endpoint
https://challenges.cloudflare.com/turnstile/v0/siteverify

### Parameters
#### Request Body (form-encoded)
- **secret** (string) - Required - The Turnstile secret key from `config('services.turnstile.secret')`.
- **response** (string) - Required - The token passed to `siteverify()`.

### Request Example
```
secret=your_secret&response=your_token
```

### Response
#### Success Response (200)
- **success** (bool) - Indicates whether the token is valid.
- **error-codes** (array) - List of error codes, if any.

#### Response Example
```json
{
    "success": true,
    "error-codes": []
}
```
```

--------------------------------

### RESPONSE_DUMMY_TOKEN

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/types.md

Documentation for the RESPONSE_DUMMY_TOKEN constant, including its value and usage.

```APIDOC
## RESPONSE_DUMMY_TOKEN

### Description
A constant representing a dummy token used as a placeholder. It is never a real Cloudflare token.

### Value
`'XXXX.DUMMY.TOKEN.XXXX'`

### Source
`src/Contracts/ClientInterface.php:9`

### Returned By
- `Client::dummy()`
- `FakeClient::dummy()`
```

--------------------------------

### Publish translation files with artisan vendor:publish

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/resources/boost/skills/turnstile-development/SKILL.md

Run this artisan command to publish the translation files for the cloudflare-turnstile package, allowing you to override error messages in lang/vendor/cloudflare-turnstile/{locale}/errors.php.

```bash
php artisan vendor:publish --tag=cloudflare-turnstile-translations
```

--------------------------------

### LaravelCloudflareTurnstileServiceProvider class

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/service-provider.md

The full service provider class that configures the package, registers a scoped ClientInterface binding, and registers two Blade components. Extends Spatie's PackageServiceProvider and is auto-discovered by Laravel.

```php
namespace RyanChandler\LaravelCloudflareTurnstile;

use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\Blade;
use RyanChandler\LaravelCloudflareTurnstile\Contracts\ClientInterface;
use RyanChandler\LaravelCloudflareTurnstile\View\Components\Scripts;
use RyanChandler\LaravelCloudflareTurnstile\View\Components\Turnstile as TurnstileComponent;
use Spatie\LaravelPackageTools\Package;
use Spatie\LaravelPackageTools\PackageServiceProvider;

class LaravelCloudflareTurnstileServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package
            ->name('laravel-cloudflare-turnstile')
            ->hasTranslations()
            ->hasViews();
    }

    public function packageRegistered(): void
    {
        $this->app->scoped(ClientInterface::class, static function (Application $app): Client {
            return new Client($app['config']->get('services.turnstile.secret'));
        });
    }

    public function packageBooted(): void
    {
        $this->bootBlade();
    }

    private function bootBlade(): void
    {
        Blade::component('turnstile.scripts', Scripts::class);
        Blade::component('turnstile', TurnstileComponent::class);
    }
}
```

--------------------------------

### Client class signature with constructor and siteverify()

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client.md

Exact class signature for the production Client implementation. The constructor promotes the secret to a protected property, but the siteverify() method sends config('services.turnstile.secret') instead of $this->secret, so the constructor argument has no effect on the outbound request as of v3.0.4.

```php
namespace RyanChandler\LaravelCloudflareTurnstile;

use Illuminate\Support\Facades\Http;
use RyanChandler\LaravelCloudflareTurnstile\Contracts\ClientInterface;
use RyanChandler\LaravelCloudflareTurnstile\Responses\SiteverifyResponse;

class Client implements ClientInterface
{
    public function __construct(
        protected string $secret,
    ) {}

    public function siteverify(string $response): SiteverifyResponse
    {
        // ...
    }

    public function dummy(): string
    {
        return self::RESPONSE_DUMMY_TOKEN;
    }
}
```

--------------------------------

### Generate dummy Turnstile token for tests

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

Generate a dummy token with Turnstile::dummy() to avoid hardcoding a submitted Turnstile token in tests.

```php
post('/my-form', [
    'cf-turnstile-response' => Turnstile::dummy(),
])
```

--------------------------------

### Service provider scoped binding

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client-interface.md

The service provider binds this interface as a scoped singleton, creating a new Client instance with the configured secret.

```php
$this->app->scoped(ClientInterface::class, static function (Application $app): Client {
    return new Client($app['config']->get('services.turnstile.secret'));
});
```

--------------------------------

### SiteverifyResponse class with readonly success and errorCodes

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/types.md

Defines the response object returned by siteverify calls. The constructor requires a boolean success flag and an array of error codes; both properties are readonly. The class implements Arrayable, and its toArray() method mirrors Cloudflare's JSON body with keys 'success' and 'error-codes'.

```php
class SiteverifyResponse implements Arrayable
{
    public function __construct(
        public readonly bool $success,
        public readonly array $errorCodes,
    ) {}
}
```

--------------------------------

### Turnstile facade class signature

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/facade-turnstile.md

The full class signature of the Turnstile facade, including the @method docblock for static analysis and the implementation of getFacadeAccessor() and fake().

```php
namespace RyanChandler\LaravelCloudflareTurnstile\Facades;

use Illuminate\Support\Facades\Facade;
use RyanChandler\LaravelCloudflareTurnstile\Contracts\ClientInterface;
use RyanChandler\LaravelCloudflareTurnstile\Testing\FakeClient;

/**
 * @method static string dummy()
 * @method static \RyanChandler\LaravelCloudflareTurnstile\Responses\SiteverifyResponse siteverify(string $response)
 */
class Turnstile extends Facade
{
    protected static function getFacadeAccessor(): string
    {
        return ClientInterface::class;
    }

    public static function fake(): FakeClient
    {
        static::swap($fake = new FakeClient);

        return $fake;
    }
}
```

--------------------------------

### siteverify(string $response): SiteverifyResponse

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/client.md

Documentation for the siteverify method of the Laravel Cloudflare Turnstile client.

```APIDOC
## `siteverify(string $response): SiteverifyResponse`

### Description
Verifies a Cloudflare Turnstile token by sending it to the Cloudflare siteverify endpoint. Returns a `SiteverifyResponse` snapshot indicating success or failure, and never throws exceptions for transport failures.

### Method
POST

### Endpoint
`https://challenges.cloudflare.com/turnstile/v0/siteverify`

### Parameters
#### Request Body
- `secret` (string) - Required - The Turnstile secret key from `config('services.turnstile.secret')`.
- `response` (string) - Required - The `cf-turnstile-response` token submitted with the form.

### Request Example
```
secret=your_secret_key&response=cf-turnstile-response-token
```

### Response
#### Success Response (200)
- `success` (boolean) - Indicates whether the token is valid.
- `error-codes` (array) - List of error codes if the token is invalid.

#### Response Example
```json
{
  "success": true,
  "error-codes": []
}
```

### Behavior
- Retries up to 3 times with 100 ms delay on failure.
- If the HTTP request throws an exception or returns a non-2xx status, returns a failed `SiteverifyResponse` with `errorCodes` containing `['internal-error']`.
- The endpoint always returns HTTP 200; the `success` field in the body indicates the outcome.
- A strict `===` check is used for `success`; only `true` passes.

### Returns
`SiteverifyResponse` - A snapshot with `success: bool` and `errorCodes: array`.

### Throws
None. All exceptions are caught and converted to a failed response.

### Example - Basic Verification
```php
use RyanChandler\LaravelCloudflareTurnstile\Client;

$client = new Client(config('services.turnstile.secret'));

$result = $client->siteverify($request->input('cf-turnstile-response'));

if ($result->success) {
    // Token accepted by Cloudflare - proceed with the submission.
} else {
    // $result->errorCodes contains Cloudflare error-code strings.
    foreach ($result->errorCodes as $code) {
        report($code);
    }
}
```

### Example - Distinguishing an Unreachable Endpoint from a Rejected Token
```php
use RyanChandler\LaravelCloudflareTurnstile\Client;

$result = (new Client(config('services.turnstile.secret')))->siteverify($token);

if ($result->success) {
    // verified
} elseif (in_array('internal-error', $result->errorCodes)) {
    // Cloudflare was unreachable, returned a non-2xx status, or the
    // config lookup failed - the package failed CLOSED on your behalf.
    // Override the ClientInterface binding if you need fail-open behavior.
} else {
    // A genuine rejection from Cloudflare, e.g. 'invalid-input-response'.
}
```
```

--------------------------------

### Configure Laravel package discovery in composer.json

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/README.md

Composer manifest configuration for Laravel package discovery. Registers the service provider and defines an alias that points to a non-existent facade class; use the actual `Turnstile` facade instead.

```json
"extra": {
    "laravel": {
        "providers": [
            "RyanChandler\LaravelCloudflareTurnstile\LaravelCloudflareTurnstileServiceProvider"
        ],
        "aliases": {
            "LaravelCloudflareTurnstile": "RyanChandler\LaravelCloudflareTurnstile\Facades\LaravelCloudflareTurnstile"
        }
    }
}
```

--------------------------------

### Turnstile::dummy(): string

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/facade-turnstile.md

Returns a dummy Turnstile token string ('XXXX.DUMMY.TOKEN.XXXX') by forwarding to the bound client's dummy() method. Useful for testing or generating placeholder tokens.

```APIDOC
## Turnstile::dummy(): string

### Description
Returns a dummy Turnstile token string ('XXXX.DUMMY.TOKEN.XXXX') by forwarding to the bound client's dummy() method. Useful for testing or generating placeholder tokens.

### Method
Static method via facade dispatch

### Parameters
None

### Returns
`string` - The dummy token 'XXXX.DUMMY.TOKEN.XXXX'

### Example
```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;

$payload = [
    'cf-turnstile-response' => Turnstile::dummy(),
    // ... other form fields
];
```
```

--------------------------------

### Link to fresh request after success screen

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/resources/boost/skills/turnstile-development/SKILL.md

A success screen that replaces the form cannot be toggled back with wire:click. Use a link to a fresh request to allow sending another message.

```blade
<a href="{{ route('contact') }}" class="btn">Send another message</a>
```

--------------------------------

### Use unique ID for multiple Livewire widgets

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

For multiple Livewire widgets on the same page, each requires a unique id. The id must match the RegEx /^[a-zA-Z_][a-zA-Z0-9_-]*$/; otherwise an exception is triggered.

```blade
<x-turnstile id="my_widget" wire:model="captcha" />
```

--------------------------------

### Rename TurnstileClient import to Client

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/UPGRADE.md

Updates the import statement to reflect the renaming of TurnstileClient to Client.

```diff
- use RyanChandler\LaravelCloudflareTurnstile\TurnstileClient;
+ use RyanChandler\LaravelCloudflareTurnstile\Client;
```

--------------------------------

### Fake Turnstile via facade with failure modes

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/fake-client.md

Use the facade to fake the Turnstile client. Calling `Turnstile::fake()` makes every subsequent verification pass. Chain `fail()` or `expired()` to simulate failure modes, producing the error codes `invalid-input-response` and `timeout-or-duplicate` respectively.

```php
use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;

// Every subsequent verification passes.
Turnstile::fake();

// Failure modes, all chainable:
Turnstile::fake()->fail();     // -> invalid-input-response
Turnstile::fake()->expired();  // -> timeout-or-duplicate
```

--------------------------------

### Laravel Turnstile configuration in config/services.php

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/configuration.md

Configuration array for the Laravel Cloudflare Turnstile service, defining the site key and secret key from environment variables.

```php
// config/services.php
return [

    // ...,

    'turnstile' => [
        'key' => env('TURNSTILE_SITE_KEY'),
        'secret' => env('TURNSTILE_SECRET_KEY'),
    ],

];
```

--------------------------------

### Laravel Turnstile composer.json auto-discovery manifest

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/configuration.md

Laravel package auto-discovery manifest fragment in composer.json. It registers the service provider and defines an alias that is documented as stale because the target facade class does not exist; the actual facade is RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile.

```json
{
    "providers": [
        "RyanChandler\\LaravelCloudflareTurnstile\\LaravelCloudflareTurnstileServiceProvider"
    ],
    "aliases": {
        "LaravelCloudflareTurnstile": "RyanChandler\\LaravelCloudflareTurnstile\\Facades\\LaravelCloudflareTurnstile"
    }
}
```

--------------------------------

### Scripts component class (View\Components\Scripts)

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/view-components.md

The Scripts component class, extending Illuminate\View\Component, returns the view 'cloudflare-turnstile::components.scripts' from its render() method. The @phpstan-ignore-next-line comment suppresses a static analysis warning about the argument type.

```php
namespace RyanChandler\LaravelCloudflareTurnstile\View\Components;

use Illuminate\View\Component;

class Scripts extends Component
{
    public function render()
    {
        // @phpstan-ignore-next-line argument.type
        return view('cloudflare-turnstile::components.scripts');
    }
}
```

--------------------------------

### Render Turnstile widget in form

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

Place the <x-turnstile /> component inside a form to output the widget markup with your configured site key. The form must be submitted via POST.

```blade
<form action="/" method="POST">
    <x-turnstile />

    <button>
        Submit
    </button>
</form>
```

--------------------------------

### Pass client-side rendering options to widget

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/resources/boost/skills/turnstile-development/SKILL.md

All client-side rendering parameters pass through as attributes on the <x-turnstile> component. The 'class' attribute is merged, not replaced, so 'cf-turnstile' is preserved.

```blade
<x-turnstile
    data-theme="light"      {{-- light | dark | auto (default) --}}
    data-language="nl"      {{-- widget copy; defaults to the visitor's browser --}}
    data-size="flexible"    {{-- normal | flexible | compact --}}
    data-appearance="interaction-only"
    data-action="contact"   {{-- shows up in Cloudflare's analytics --}}
    data-cdata="user-42"
    data-error-callback="onTurnstileError"
/>
```

--------------------------------

### Include Turnstile scripts in layout

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

Include the Turnstile scripts in the <head> of your layout file using the <x-turnstile.scripts> component. This is required before using the <x-turnstile /> component.

```blade
<html>
    <head>
        <x-turnstile.scripts />
    </head>
    <body>
        {{ $slot }}
    </body>
</html>
```

--------------------------------

### SiteverifyResponse class signature

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/siteverify-response.md

Exact class signature of SiteverifyResponse from src/Responses/SiteverifyResponse.php. It implements Arrayable, has public readonly properties $success and $errorCodes, static factories success() and failure(), and a toArray() method returning the Cloudflare siteverify JSON shape.

```php
namespace RyanChandler\LaravelCloudflareTurnstile\Responses;

use Illuminate\Contracts\Support\Arrayable;

class SiteverifyResponse implements Arrayable
{
    public function __construct(
        public readonly bool $success,
        public readonly array $errorCodes,
    ) {}

    public static function success(): self
    {
        return new self(true, []);
    }

    public static function failure(array $errorCodes = []): self
    {
        return new self(false, $errorCodes);
    }

    public function toArray(): array
    {
        return [
            'success' => $this->success,
            'error-codes' => $this->errorCodes,
        ];
    }
}
```

--------------------------------

### Load Turnstile script in layout head

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/resources/boost/skills/turnstile-development/SKILL.md

Place this Blade component in the <head> of your layout to load the Turnstile script once. The component passes attributes to the <script> tag, so you can add a CSP nonce or onload handler.

```blade
<html>
    <head>
        <x-turnstile.scripts />
    </head>
```

--------------------------------

### Serializing with toArray()

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/_autodocs/api-reference/siteverify-response.md

Serializes a failure response with toArray(), producing the associative array with keys 'success' and 'error-codes' matching Cloudflare's siteverify JSON body. The comment shows the expected output.

```php
use RyanChandler\LaravelCloudflareTurnstile\Responses\SiteverifyResponse;

$response = SiteverifyResponse::failure(['timeout-or-duplicate', 'internal-error']);

$payload = $response->toArray();
// => ['success' => false, 'error-codes' => ['timeout-or-duplicate', 'internal-error']]

response()->json($payload);
```

--------------------------------

### Bind Turnstile response with Livewire wire:model

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

Use wire:model to bind the Turnstile response to a Livewire property directly. Requires Livewire integration.

```blade
<x-turnstile wire:model="yourModel" />
```

--------------------------------

### Replace Rule::turnstile() macro with Turnstile object

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/UPGRADE.md

Migrates from the removed Rule::turnstile() macro to the Turnstile rule object. The new rule is instantiated with 'new Turnstile'.

```diff
use RyanChandler\LaravelCloudflareTurnstile\Rules\Turnstile;

$request->validate([
    'cf-turnstile-response' => [
        'required',
-       Rule::turnstile(),
+       new Turnstile, 
    ]
]);
```

--------------------------------

### Bind Turnstile token with Livewire wire:model

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/resources/boost/skills/turnstile-development/SKILL.md

Use wire:model to bind the token to a property. The component switches to Livewire mode, marking the container wire:ignore and registering callback globals. The id must match /^[a-zA-Z_][a-zA-Z0-9_]*$/ and be unique per widget.

```blade
<x-turnstile id="contact_captcha" wire:model="turnstileToken" data-theme="light" />
```

--------------------------------

### Customize Turnstile widget with attributes

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/README.md

Customize the widget by passing attributes to the <x-turnstile /> component. Refer to the official Cloudflare documentation for configuration options.

```blade
<form action="/" method="POST">
    <x-turnstile
        data-action="login"
        data-cdata="sessionid-123456789"
        data-callback="callback"
        data-expired-callback="expiredCallback"
        data-error-callback="errorCallback"
        data-theme="dark"
        data-tabindex="1"
    />

    <button>
        Submit
    </button>
</form>
```

--------------------------------

### Add nonce or onload to Turnstile script

Source: https://github.com/ryangjchandler/laravel-cloudflare-turnstile/blob/main/resources/boost/skills/turnstile-development/SKILL.md

Pass attributes like nonce or onload to the <x-turnstile.scripts> component; they are forwarded to the underlying <script> tag.

```blade
<x-turnstile.scripts nonce="{{ $nonce }}" />
```
Tokens:
Raw