PHPackages                             serri/alchemist - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Templating & Views](/categories/templating)
4. /
5. serri/alchemist

ActiveLibrary[Templating & Views](/categories/templating)

serri/alchemist
===============

The JSON Revolution for Laravel, a simple, fast, and elegant alternative to Laravel JSON Resource.

v1.5.0(1mo ago)8191[1 PRs](https://github.com/AdnanSerri/Alchemist/pulls)MITPHPPHP ^8.2CI passing

Since May 21Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/AdnanSerri/Alchemist)[ Packagist](https://packagist.org/packages/serri/alchemist)[ RSS](/packages/serri-alchemist/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (5)Dependencies (9)Versions (23)Used By (0)

🧙🏻‍♂️ Laravel Alchemist ⚗️
==========================

[](#‍️-laravel-alchemist-️)

[![Latest Version](https://camo.githubusercontent.com/991af4a99dcf6d40939922624234969fb9f45727fa77a14d76f56c96e019b3a1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73657272692f616c6368656d6973742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/serri/alchemist)[![Tests](https://camo.githubusercontent.com/607e802f08974099998bc3d3fd7d0d45c91487561b9ec375f5a262d74511ddb3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f41646e616e53657272692f416c6368656d6973742f74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/AdnanSerri/Alchemist/actions/workflows/tests.yml)[![License](https://camo.githubusercontent.com/961ce4a924242ef9f248523168b654e85b04215ca283c15e39c4f08de796c250/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f73657272692f616c6368656d6973742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/serri/alchemist)[![Total Downloads](https://camo.githubusercontent.com/e6f5e94594dd17db71b73a85ea5bd56dea5e4e30d902c95d0219e1dfb5bd736e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73657272692f616c6368656d6973742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/serri/alchemist)

### The JSON Revolution for Laravel, a simple, fast, and elegant alternative to Laravel JSON Resource.

[](#the-json-revolution-for-laravel-a-simple-fast-and-elegant-alternative-to-laravel-json-resource)

---

📖 Table of Contents
-------------------

[](#-table-of-contents)

1. [Philosophy](#philosophy)
2. [Requirements](#requirements)
3. [Installation](#installation)
4. [Fundamentals](#fundamentals)
5. [Quick Start](#quick-start)
6. [Usage & Examples](#usage-examples)
7. [Custom Ingredients](#custom-ingredients)
8. [Error Handling](#error-handling)
9. [Testing](#testing)
10. [Changelog](#changelog)
11. [License](#license)

---

 🔮 Philosophy - The Problem with Traditional Laravel Resources
--------------------------------------------------------------------------------------------------

[](#--philosophy---the-problem-with-traditional-laravel-resources)

We've all been there:

- Creating endless resource classes that mostly repeat the same boilerplate.
- Duplicating code across multiple API responses.
- Drowning in maintenance when frontend requirements change.
- Wrestling with nested relationships that bloat your codebase.

The breaking point comes when:

- Your API evolves and resources multiply.
- Frontend devs request constant field changes.
- Your models grow, but your resource classes don't scale.
- Nested relationships turn into unmaintainable spaghetti.

The Solution: Laravel Alchemist - Formula Approach

**One File to Rule Them All**

Each model gets a single `SomeModelFormula.php` where you:

✅ Define all fields as simple strings in arrays.
✅ Manage every API variation in one place.
✅ Update database changes with a single edit.

**Relationship Handling Made Simple**

- Reference nested resources by their name only.
- Each relation maintains its own `Formula::class`.
- No more recursive resource nightmares.

**Frontend-Friendly Flexibility**

- Instantly modify fields without resource class hopping.
- Track all API variations through clear formula methods.
- Never miss a field update again.

**Why This Works**

- **Less Code:** Eliminates 80%+ of resource boilerplate.
- **True Maintainability:** All changes flow through controlled formulas.
- **Team Friendly:** Frontend can request changes without breaking your flow.

> *“Laravel Resources grant you the illusion of control – meticulous yet maddening. Laravel Alchemist surrenders this false dominion... and in its place conjures true magic.„*

---

 📋 Requirements
-----------------------------------------------------

[](#--requirements)

LaravelPHPAlchemist12.x≥ 8.2≥ 1.113.x≥ 8.3≥ 1.1> Laravel 11 is supported by Alchemist 1.0.x only: it reached end of security support in March 2026 and is no longer maintained.

---

 🔧 Installation
-----------------------------------------------------

[](#--installation)

You may install Alchemist using the Composer package manager:

```
composer require serri/alchemist
```

You can publish the Alchemist configuration file `config/alchemist.php` and the default `Formulas/Formula.php` using the `vendor:publish` Artisan command:

```
php artisan vendor:publish --provider="Serri\Alchemist\Providers\AlchemistServiceProvider"
```

Or for the configuration file only:

```
php artisan vendor:publish --tag=alchemist-config
```

For the default formula class only:

```
php artisan vendor:publish --tag=alchemist-formula
```

---

 📖 Fundamentals
-----------------------------------------------------

[](#--fundamentals)

To wield this package's magic effectively, you must understand these arcane principles:

### **The Formulas Directory**

[](#the-formulas-directory)

- Your **sacred workshop** where all model formulas reside
- Created automatically at `app/Formulas/Formula.php` when you publish the default formula class as we did in the [Installation](#installation) section:

```
namespace App\Formulas;

class Formula
{
    const BlankParchment = ['id']; # Default formula.
}
```

### Crafting Your Formulas

[](#crafting-your-formulas)

Summon a formula class with the generator:

```
php artisan make:formula PostFormula

# Or scan a model: pre-fills BlankParchment with its exposed fields and
# lists its #[Mutagen] / #[Relation] methods as hints.
php artisan make:formula PostFormula --model=Post
```

The generator writes to your configured `formulas_folder_path` (default `app/Formulas/`), creates the base `Formula` class if it is missing, and refuses to overwrite an existing formula unless you pass `--force`.

### Linting Your Formulas

[](#linting-your-formulas)

Formulas are strings resolved at runtime — so let CI catch the typos before production does:

```
php artisan formula:lint
```

Every constant of every formula class is validated against its model using the exact same discovery the brew pipeline uses, **including nested specs** (validated against the related model, no database needed). Unknown fields fail with a "did you mean" suggestion; the command exits non-zero, so add it next to your test step in CI. Models are matched by convention (`PostFormula` → `App\Models\Post`) or explicitly:

```
class WeirdlyNamedFormula extends Formula
{
    protected static string $model = \App\Models\Post::class;
}
```

Use `--json` for machine-readable output.

Or craft one by hand in `app/Formulas/` like so:

```
namespace App\Formulas;

class UserFormula extends Formula
{
    # Define your transformations here.
    # ex:

    const UserLogin = ['id', 'username', /*...etc.*/];

    // ... other formulas.
}
```

> #### Key Laws:
>
> [](#key-laws)
>
> - #### Each model deserves its own formula class `ModelNameFormula.php`
>
>
>     [](#each-model-deserves-its-own-formula-class-modelnameformulaphp-)
> - #### The `BlankParchment` remains your fallback option.
>
>     [](#the-blankparchment-remains-your-fallback-option)

### Modular Codebases

[](#modular-codebases)

Fallback resolution searches `App\Formulas` by convention. Modular / DDD apps can add their own namespaces (searched in order — the first entry is also where `make:formula` generates classes):

```
// config/alchemist.php
'formula_namespaces' => [
    'Modules\\Blog\\Formulas',
    'App\\Formulas',
],
```

### Using the package's default Formula

[](#using-the-packages-default-formula)

If you did not publish `app/Formulas/Formula.php`, you can still extend the default `Formula` provided by the package like this:

```
namespace App\Formulas;

use Serri\Alchemist\Formulas\Formula;

class UserFormula extends Formula
{
    // Define your transformations here.
}
```

---

 🪄 Quick Start
---------------------------------------------------

[](#--quick-start)

### 1. Model Configuration

[](#1-model-configuration)

To enable formula support, models must use the `HasAlchemyFormulas` concern.

```
use Serri\Alchemist\Concerns\HasAlchemyFormulas;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use HasAlchemyFormulas;

    //
}
```

### 2. Exposing Fields

[](#2-exposing-fields)

By default, everything included in the `$fillable` array and the `$guarded` array is automatically available to formulas.

```
use Serri\Alchemist\Concerns\HasAlchemyFormulas;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use HasAlchemyFormulas;

    # Automatically exposed to formulas.
    protected $guarded = ['id'];

    # Automatically exposed to formulas.
    protected $fillable = [
        'title',
        'description',
        'published_at',
    ];
}
```

> **Note:** Eloquent's default `$guarded = ['*']` wildcard is never treated as a field. If you rely on the default, expose your columns through `$fillable`.

> **`$hidden` is respected:** fields in a model's `$hidden` property are never exposed to formulas — matching Eloquent's serialisation contract. A formula referencing one throws with a clear message. Deliberately brewing hidden attributes requires setting `alchemist.respect_hidden` to `false`.

### 3. Exposing Relationships

[](#3-exposing-relationships)

Relationships must be explicitly marked with the `#[Relation]` decorator to be available in formulas:

```
use Serri\Alchemist\Decorators\Relation;

#[Relation] # Exposed to formulas as 'comments'
public function comments(): HasMany
{
    return $this->hasMany(Comment::class);
}

#[Relation(name: 'author_profile')] # Exposed to formulas as 'author_profile'
public function profile(): HasOne
{
    return $this->hasOne(Profile::class);
}
```

### 4. Exposing Custom Methods

[](#4-exposing-custom-methods)

Model methods require the `#[Mutagen]` decorator to be accessible in formulas:

```
use Serri\Alchemist\Decorators\Mutagen;

#[Mutagen] # Exposed to formulas as 'fullName'
public function fullName(): string
{
    return "{$this->first_name} {$this->last_name}";
}

#[Mutagen(name: 'is_verified')] # Exposed to formulas as 'is_verified'
public function isVerified(): bool
{
    return $this->email_verified_at !== null;
}
```

> #### Keynotes
>
> [](#keynotes)
>
> - #### `$fillable` / `$guarded` fields are available in formulas by default.
>
>     [](#fillable--guarded-fields-are-available-in-formulas-by-default)
> - #### **Decorators:** Only `#[Relation]` and `#[Mutagen]` methods are exposed to formulas.
>
>     [](#decorators-only-relation-and-mutagen-methods-are-exposed-to-formulas)
> - #### The `name` argument works positionally too: `#[Mutagen('is_verified')]`.
>
>     [](#the-name-argument-works-positionally-too-mutagenis_verified)

### 5. Crafting Formulas

[](#5-crafting-formulas)

Once your models are properly configured, you can define formulas to transform your data. Formulas are defined in classes within the `app/Formulas/` directory.

Here is an example:

```
namespace App\Formulas;

class PostFormula extends Formula
{
    const Author = ['id', 'title', 'author_profile'];

    const WithComments = ['id', 'title', 'comments'];

    const Detailed = ['id', 'title', 'description', 'comments', 'author_profile'];
}
```

For the profile formula:

```
namespace App\Formulas;

class ProfileFormula extends Formula
{
    const OnlyName = ['fullName'];

    const AnyOther = ['id', 'username', 'fullName'];
}
```

---

 🛠️ Usage & Examples
----------------------------------------------------------------

[](#-️-usage--examples)

### Basic Data Transformation

[](#basic-data-transformation)

Pass a formula straight into the brew — no global state, no sequencing:

```
use App\Models\Post;
use App\Formulas\PostFormula;
use Serri\Alchemist\Facades\Alchemist;

// Eager-load the relations your formula uses!
$posts = Post::with('author.profile')->get();

$transformedData = Alchemist::brew($posts, PostFormula::Author);
```

...where the formula pins the whole response shape, nested relations included:

```
class PostFormula extends Formula
{
    const Author = [
        'id',
        'title',
        'author_profile' => ProfileFormula::OnlyName, # Nested spec: shapes the relation inline.
    ];
}
```

Nested specs recurse to any depth, and any relation listed as a plain string keeps resolving through the related model's own formula.

The classic stateful style remains fully supported — set formulas up front, brew later:

```
Post::setFormula(PostFormula::Author);
Profile::setFormula(ProfileFormula::OnlyName);

$transformedData = Alchemist::brew($posts);
```

A per-call formula always wins over `setFormula()` for that call, so the two styles mix safely.

Results:

```
[
  [
    'id' => 1,
    'title' => "Post 1",
    'author_profile' => [
      'fullName' => "some author name"
    ]
  ],
  [
    'id' => 2,
    'title' => 'Post 2',
    'author_profile' => [
      'fullName' => "some author name"
    ]
  ],
  [
    'id' => 3,
    'title' => 'Post 3',
    'author_profile' => [
      'fullName' => "some author name"
    ]
  ]
]
```

> **Eager loading:** brewing a `#[Relation]` field accesses the relation on each model. Always eager-load (`Post::with('comments')`) the relations your formula references, or you will trigger N+1 queries.

### Key Methods

[](#key-methods)

MethodPurposeExample`brew()`Transforms a model or collection into an array`Alchemist::brew($posts, PostFormula::Author)``brewBatch()`Transforms a paginator's items, keeping its metadata`Alchemist::brewBatch($paginator, $formula)``brewMixed()`Brews a mixed-class collection, per-class formulas`Alchemist::brewMixed($feed, $formulaMap)``response()`Brews anything straight into a `JsonResponse``Alchemist::response($paginator, $formula)``setFormula()`Assigns the model's active (fallback) formula`Post::setFormula(PostFormula::DetailedView)``unsetFormula()`Clears it, falling back to `BlankParchment``Post::unsetFormula()`The `$formula` argument is optional everywhere: omit it and the model's active formula (or `BlankParchment`) applies.

> **Laravel Octane:** formulas set via `setFormula()` are flushed automatically at every request boundary, so state can never leak between requests in long-lived workers. Per-call formulas never touch shared state at all.

### Patterns

[](#patterns)

#### 1. Context-Aware Formulas

[](#1-context-aware-formulas)

```
$formula = auth()->user()->isAdmin()
    ? PostFormula::AdminView
    : PostFormula::PublicView;

Post::setFormula($formula);
```

#### 2. Direct Model Transformation

[](#2-direct-model-transformation)

```
$post = Post::find(1);

return Alchemist::brew($post); // Auto-detects single model
```

#### 3. Pagination Support

[](#3-pagination-support)

```
$paginated = Post::paginate(15);

return Alchemist::brewBatch($paginated); // Preserves pagination structure
```

`brewBatch()` accepts length-aware, simple (`simplePaginate`), and cursor (`cursorPaginate`) paginators alike.

#### 4. Mixed Collections

[](#4-mixed-collections)

Feeds, search results, and morph queries mix model classes — `brewMixed()` brews each element with its own class's formula, order preserved:

```
$feed = collect([$post, $comment, $anotherPost]);

$brewed = Alchemist::brewMixed($feed, [
    Post::class    => PostFormula::Summary,
    Comment::class => CommentFormula::BodyOnly,
]);
// Classes omitted from the map fall back to their active formula / BlankParchment.
```

Plain `brew()` requires a homogeneous collection and now fails fast (pointing at `brewMixed()`) when given a mixed one.

#### 5. One-Line Controllers

[](#5-one-line-controllers)

`response()` brews anything — model, collection, or paginator — straight into a `JsonResponse`:

```
public function index()
{
    return Alchemist::response(
        Post::with('comments')->paginate(15),
        PostFormula::WithComments,
    );
}

// Optional status and headers:
return Alchemist::response($post, PostFormula::Detailed, 201, ['X-Custom' => 'header']);
```

Paginators keep their pagination envelope (`data`, `total`, `links`, ...); everything else returns the brewed array.

#### 6. Sparse Fieldsets from the Request

[](#6-sparse-fieldsets-from-the-request)

Let clients narrow the response — with your formula as the ceiling they can never exceed:

```
use Serri\Alchemist\Support\Sieve;

// GET /posts?fields=id,title&include=comments&fields[comments]=body
public function index(Request $request)
{
    return Alchemist::response(
        Post::with('comments')->paginate(15),
        Sieve::from($request, PostFormula::Detailed),   // Detailed is the allow-list
    );
}
```

- `fields=id,title` narrows top-level fields (`fields[self]=...` when combined with relation fields).
- `include=comments,comments.post` chooses which nested-spec relations survive (dot paths for depth).
- `fields[comments]=body` narrows a relation's nested spec, at any depth (`fields[comments.post]=id`).
- No parameters → the allow-list verbatim, so it is a drop-in wrapper.
- Requests outside the allow-list are silently dropped; use `Sieve::strict()` to throw an `InvalidSieveRequestException` instead (map it to a 4xx in your exception handler).

### Syntax Variations

[](#syntax-variations)

#### 1. Helper Function (Simplest)

[](#1-helper-function-simplest)

```
$posts = Post::all();
$transformed = alchemist()->brew($posts);
```

#### 2. Facade (For static contexts)

[](#2-facade-for-static-contexts)

```
use Serri\Alchemist\Facades\Alchemist;

$data = Alchemist::brew($models);
```

#### 3. Dependency Injection (Recommended for controllers)

[](#3-dependency-injection-recommended-for-controllers)

```
use Serri\Alchemist\Services\Alchemist;

class PostController
{
    public function __construct(
        protected Alchemist $alchemist,
    ) {}

    public function index()
    {
        return $this->alchemist->brew(Post::all());
    }
}
```

All three resolve the same container singleton.

---

 🧪 Custom Ingredients
-----------------------------------------------------------------

[](#--custom-ingredients)

Ingredients are the strategies the Alchemist uses to resolve each formula field. The built-ins cover `$fillable`, `$guarded`, `#[Mutagen]`, and `#[Relation]` — but you can brew your own.

An ingredient implements `Serri\Alchemist\Contracts\IngredientContract`:

```
namespace App\Ingredients;

use Serri\Alchemist\Contracts\IngredientContract;

final class UppercaseIngredient implements IngredientContract
{
    /**
     * The model property that lists the fields this ingredient resolves.
     */
    public static function ingredientName(): string
    {
        return 'shoutable';
    }

    /**
     * Resolve one field on one model.
     */
    public static function infuse(string $ingredient, mixed $brewing): array
    {
        return [
            $ingredient => strtoupper($brewing[$ingredient]),
        ];
    }
}
```

Register it in `config/alchemist.php`:

```
'ingredients' => [
    \Serri\Alchemist\Ingredients\FillableIngredient::class,
    \Serri\Alchemist\Ingredients\GuardedIngredient::class,
    \Serri\Alchemist\Ingredients\MutagenIngredient::class,
    \Serri\Alchemist\Ingredients\RelationIngredient::class,

    \App\Ingredients\UppercaseIngredient::class,
],
```

Then list the fields on your model:

```
class Post extends Model
{
    use HasAlchemyFormulas;

    protected array $shoutable = ['title'];
}
```

Rules of the craft:

- **Order matters:** when two ingredients expose the same field name, the one registered **later** wins.
- Models without the ingredient's property simply contribute no fields for it — no error.
- Decorator-driven ingredients (like the built-in Mutagen/Relation) additionally implement a static `usesDecorator(): bool` returning `true`, and `ingredientName()` returns the attribute class to scan for.

---

 🚨 Error Handling
---------------------------------------------------------

[](#--error-handling)

Everything the Alchemist throws extends `Serri\Alchemist\Exceptions\AlchemistException`, so one catch covers all:

ExceptionThrown when`UnknownFormulaFieldException`A formula references a field the model does not expose (typo, or forgotten decorator).`UnbrewableInputException`The input collection contains non-models, or the model lacks the `HasAlchemyFormulas` trait.`InvalidConfigurationException`The `alchemist` config is missing or malformed.`InvalidIngredientException`A configured ingredient class does not exist or lacks `infuse()`.---

 🧬 Testing
-------------------------------------------

[](#--testing)

```
composer test       # PHPUnit (unit + feature suites)
composer lint       # Pint code style check
composer analyse    # PHPStan level 6
```

The CI matrix runs the suite on PHP 8.2–8.4 across Laravel 12 and 13.

---

 📆 Changelog
-----------------------------------------------

[](#--changelog)

See [CHANGELOG.md](CHANGELOG.md) for release history and upgrade notes.

---

 📜 License
-------------------------------------------

[](#--license)

This project is open-source and available under the **MIT License**.

###  Health Score

46

—

FairBetter than 92% of packages

Maintenance91

Actively maintained with recent releases

Popularity13

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 64.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~59 days

Recently: every ~0 days

Total

8

Last Release

41d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/58080657?v=4)[AdnanSerri](/maintainers/AdnanSerri)[@AdnanSerri](https://github.com/AdnanSerri)

---

Top Contributors

[![lumbermj](https://avatars.githubusercontent.com/u/110980468?v=4)](https://github.com/lumbermj "lumbermj (37 commits)")[![AdnanSerri](https://avatars.githubusercontent.com/u/58080657?v=4)](https://github.com/AdnanSerri "AdnanSerri (20 commits)")

---

Tags

arrayarray-manipulationsexportjsonjson-apijson-resourceslaravellaravel-packagephp-libraryphp8resource

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/serri-alchemist/health.svg)

```
[![Health](https://phpackages.com/badges/serri-alchemist/health.svg)](https://phpackages.com/packages/serri-alchemist)
```

###  Alternatives

[pressbooks/pressbooks

Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS.

45844.8k1](/packages/pressbooks-pressbooks)[api-platform/laravel

API Platform support for Laravel

58190.1k21](/packages/api-platform-laravel)[psalm/plugin-laravel

Psalm plugin for Laravel

3345.4M354](/packages/psalm-plugin-laravel)[tallstackui/tallstackui

TallStackUI is a powerful suite of Blade components that elevate your workflow of Livewire applications.

731189.9k16](/packages/tallstackui-tallstackui)[laravel/cashier

Laravel Cashier provides an expressive, fluent interface to Stripe's subscription billing services.

2.6k31.8M160](/packages/laravel-cashier)[laravel/scout

Laravel Scout provides a driver based solution to searching your Eloquent models.

1.7k57.2M682](/packages/laravel-scout)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)