StateSet Embedded Commerce for PHP

Local-first commerce engine for PHP. Provides a complete commerce API with embedded SQLite storage.

Installation

Via Composer

composer require stateset/embedded

Installing the Native Extension

The native extension provides significant performance benefits. Install pre-built binaries:

composer install-extension

Or manually download from GitHub Releases.

Then add to your php.ini:

extension=stateset_embedded

Quick Start

<?php
require_once 'vendor/autoload.php';

use StateSet\Commerce;

// Create commerce instance (uses SQLite)
$commerce = new Commerce('commerce.db');
// Or use in-memory database
$commerce = new Commerce(':memory:');

// Create a customer
$customer = $commerce->customers()->create(
    email: 'john@example.com',
    firstName: 'John',
    lastName: 'Doe'
);

// Create a product
$product = $commerce->products()->create(
    name: 'Widget Pro',
    description: 'The best widget ever'
);

// Create an order
$order = $commerce->orders()->create(
    customerId: $customer->getId(),
    items: [
        ['sku' => 'WIDGET-001', 'name' => 'Widget Pro', 'quantity' => 2, 'unit_price' => 29.99]
    ]
);

// Process the order
$commerce->orders()->confirm($order->getId());
$commerce->orders()->ship($order->getId(), trackingNumber: '1Z999AA10123456784');
$commerce->orders()->deliver($order->getId());

// Get sales analytics
$summary = $commerce->analytics()->salesSummary(days: 30);
echo "Total Revenue: $" . $summary->getTotalRevenue();

Available APIs

Laravel Integration

// config/services.php
return [
    'stateset' => [
        'database' => storage_path('stateset/commerce.db'),
    ],
];

// app/Providers/StateSetServiceProvider.php
use StateSet\Commerce;

public function register()
{
    $this->app->singleton(Commerce::class, function ($app) {
        return new Commerce(config('services.stateset.database'));
    });
}

// Usage in controllers
public function store(Request $request, Commerce $commerce)
{
    $order = $commerce->orders()->create(
        customerId: $request->customer_id,
        items: $request->items
    );

    return response()->json($order);
}

Building from Source

Requirements:

• PHP 8.1+
• Rust toolchain
• PHP development headers (php-dev / php-devel)

cd bindings/php
cargo build --release

# The extension will be at:
# target/release/libstateset_embedded.so (Linux)
# target/release/libstateset_embedded.dylib (macOS)
# target/release/stateset_embedded.dll (Windows)

Running Tests

composer test

Platform Support

License

MIT