Compare commits

...
2 Commits
Author SHA1 Message Date
arvanitakis effbce195c Bump version to 0.26.0 2026-09-28 11:32:20 +03:00
arvanitakis dca6944153 Feat: Adding Store Details Page 2026-09-28 11:30:15 +03:00
11 changed files with 365 additions and 3 deletions
+22
View File
@@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
## [0.26.0] - 2026-09-28
### Added
- `Modules\Core\Store\` — a "Store Details" Filament settings page (under Settings) for a
shop's own contact/legal details: store name, address (both translatable), phone, tax
identifier (ΑΦΜ), company registration number (ΓΕΜΗ), and rich-text bank transfer
instructions (IBANs, formatted as a table if needed — `TranslatedText::optionRichtext()`,
which ships table insert/edit in its default toolbar). Backed by a single-row
`StoreDetails` model, read via `StoreDetailsService::current()` (forever-cached,
invalidated by the new `StoreDetailsUpdated` event whenever `StoreDetailsService::update()`
is the one write path used — never write to the model directly).
### Fixed
- `StoreDetailsService`'s singleton row was created with every translatable column
(`name`/`address`/`bank_transfer_instructions`) left `NULL`. Lunar's own `TranslatedText`
Filament component silently discards every keystroke on re-render when the field it edits
starts out `NULL` rather than an empty per-locale array — invisible for `PaymentMethod`'s
own translatable `name` (always created already-filled, through the same form), but exactly
the gap this brand-new singleton hits, since it's created blank and opened for editing in
the same visit. The row is now seeded with an empty string per configured language from
creation, so every translatable field is editable from the very first save.
## [0.25.2] - 2026-09-28 ## [0.25.2] - 2026-09-28
### Fixed ### Fixed
+3 -2
View File
@@ -2,7 +2,7 @@
"name": "boboko/core", "name": "boboko/core",
"description": "Core module — authentication and shared panel behaviour", "description": "Core module — authentication and shared panel behaviour",
"type": "library", "type": "library",
"version": "0.25.2", "version": "0.26.0",
"autoload": { "autoload": {
"psr-4": { "psr-4": {
"Modules\\Core\\": "src/" "Modules\\Core\\": "src/"
@@ -48,7 +48,8 @@
"Modules\\Core\\Providers\\ShippingServiceProvider", "Modules\\Core\\Providers\\ShippingServiceProvider",
"Modules\\Core\\Providers\\OrderServiceProvider", "Modules\\Core\\Providers\\OrderServiceProvider",
"Modules\\Core\\Providers\\PrivacyServiceProvider", "Modules\\Core\\Providers\\PrivacyServiceProvider",
"Modules\\Core\\Providers\\WishlistServiceProvider" "Modules\\Core\\Providers\\WishlistServiceProvider",
"Modules\\Core\\Providers\\StoreServiceProvider"
] ]
} }
}, },
@@ -0,0 +1,44 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
/**
* A single-row table for the store's own contact/legal details — edited via
* the Filament "Store Details" settings page (Modules\Core\Store\Filament\
* Pages\ManageStoreDetails) and read via Modules\Core\Store\Services\
* StoreDetailsService. Not config, since a shop owner needs to change these
* (e.g. a new IBAN, a new address) without a code deploy.
*
* name/address/bank_transfer_instructions are locale-keyed JSON — same
* shape/resolution as Modules\Core\Payment\Models\PaymentMethod::$name (see
* that model's own docblock): $storeDetails->translate('name'). tax_identifier
* (ΑΦΜ) and registration_number (ΓΕΜΗ) are legal identifiers, not
* locale-dependent text, so they stay plain strings — same for phone.
*
* No seeder inserting the singleton row — StoreDetailsService::current()
* lazily creates it (all-null) on first read, same shape as any other
* firstOrCreate()-backed singleton in this codebase.
*/
return new class extends Migration
{
public function up(): void
{
Schema::create('store_details', function (Blueprint $table) {
$table->id();
$table->json('name')->nullable();
$table->json('address')->nullable();
$table->string('phone')->nullable();
$table->string('tax_identifier')->nullable();
$table->string('registration_number')->nullable();
$table->json('bank_transfer_instructions')->nullable();
$table->timestamps();
});
}
public function down(): void
{
Schema::dropIfExists('store_details');
}
};
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@boboko/core", "name": "@boboko/core",
"version": "0.25.2", "version": "0.26.0",
"private": true, "private": true,
"type": "module", "type": "module",
"description": "Portable Stimulus controllers and styles for boboko-core's cart + checkout module. Installed as a real npm dependency (file:../boboko-core in dev, a tagged git install in prod) so a consuming app's `npm install` resolves this package's own dependencies (leaflet, @hotwired/stimulus) transitively, the same way `composer update boboko/*` does for PHP. See CONTRIBUTE.md's \"JS/CSS: a real npm package\" section.", "description": "Portable Stimulus controllers and styles for boboko-core's cart + checkout module. Installed as a real npm dependency (file:../boboko-core in dev, a tagged git install in prod) so a consuming app's `npm install` resolves this package's own dependencies (leaflet, @hotwired/stimulus) transitively, the same way `composer update boboko/*` does for PHP. See CONTRIBUTE.md's \"JS/CSS: a real npm package\" section.",
+4
View File
@@ -50,6 +50,7 @@ use Modules\Core\Shipping\Extensions\ShippingMethodListExtension;
use Modules\Core\Shipping\Extensions\ShippingMethodResourceExtension; use Modules\Core\Shipping\Extensions\ShippingMethodResourceExtension;
use Modules\Core\Shipping\Filament\Resources\ManifestResource; use Modules\Core\Shipping\Filament\Resources\ManifestResource;
use Modules\Core\Shipping\Filament\Resources\ShipmentResource; use Modules\Core\Shipping\Filament\Resources\ShipmentResource;
use Modules\Core\Store\Filament\Pages\ManageStoreDetails;
class CorePlugin implements Plugin class CorePlugin implements Plugin
{ {
@@ -74,6 +75,9 @@ class CorePlugin implements Plugin
ShipmentResource::class, ShipmentResource::class,
ManifestResource::class, ManifestResource::class,
]) ])
->pages([
ManageStoreDetails::class,
])
->plugin(ShippingPlugin::make()); ->plugin(ShippingPlugin::make());
LunarPanel::extensions([ LunarPanel::extensions([
+16
View File
@@ -0,0 +1,16 @@
<?php
namespace Modules\Core\Providers;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\ServiceProvider;
use Modules\Core\Store\Events\StoreDetailsUpdated;
use Modules\Core\Store\Listeners\FlushStoreDetailsCache;
class StoreServiceProvider extends ServiceProvider
{
public function boot(): void
{
Event::listen(StoreDetailsUpdated::class, FlushStoreDetailsCache::class);
}
}
+19
View File
@@ -0,0 +1,19 @@
<?php
namespace Modules\Core\Store\Events;
use Modules\Core\Store\Models\StoreDetails;
/**
* Dispatched by StoreDetailsService — the only place StoreDetails is ever
* created/updated, mirroring Modules\Core\Localization\Services\
* TranslationService's own create()/update() shape. Modules\Core\Store\
* Listeners\FlushStoreDetailsCache reacts to this to invalidate
* StoreDetailsService::current()'s forever-cache.
*/
class StoreDetailsUpdated
{
public function __construct(
public readonly StoreDetails $storeDetails,
) {}
}
@@ -0,0 +1,128 @@
<?php
namespace Modules\Core\Store\Filament\Pages;
use Filament\Actions\Action;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Concerns\InteractsWithForms;
use Filament\Forms\Contracts\HasForms;
use Filament\Notifications\Notification;
use Filament\Pages\Page;
use Filament\Schemas\Components\Actions;
use Filament\Schemas\Components\EmbeddedSchema;
use Filament\Schemas\Components\Form;
use Filament\Schemas\Components\Section;
use Filament\Schemas\Schema;
use Lunar\Admin\Support\Forms\Components\TranslatedText;
use Modules\Core\Store\Services\StoreDetailsService;
/**
* Singleton settings page — no resource, no record list, always edits the
* one StoreDetails row (see that model's own docblock). Filament ships no
* built-in "settings page" type; this follows the same shape Filament's own
* password-reset-request page uses (see Filament\Auth\Pages\PasswordReset\
* RequestPasswordReset): a content(Schema) composed of a Form(EmbeddedSchema)
* with the save action(s) in its own footer(), rather than a hand-written
* Blade view — Filament v4 has no `x-filament-panels::form.actions` Blade
* component to fall back on for a plain Page.
*/
class ManageStoreDetails extends Page implements HasForms
{
use InteractsWithForms;
protected static ?string $navigationLabel = 'Store Details';
protected static string|\BackedEnum|null $navigationIcon = 'heroicon-o-building-storefront';
protected static string|\UnitEnum|null $navigationGroup = 'Settings';
public ?array $data = [];
public function mount(): void
{
$this->form->fill(
app(StoreDetailsService::class)->current()->attributesToArray()
);
}
public function content(Schema $schema): Schema
{
return $schema->components([
Form::make([EmbeddedSchema::make('form')])
->id('form')
->livewireSubmitHandler('save')
->footer([
Actions::make($this->getFormActions())
->key('form-actions'),
]),
]);
}
public function form(Schema $schema): Schema
{
return $schema
->statePath('data')
->components([
Section::make('Store')
->schema([
// Deliberately not ->required(): TranslatedText's own
// state is the whole locale-keyed array, and its
// required-rule generation validates that array
// itself rather than deferring to its per-locale
// children — it fires "required" even when every
// locale sub-field is genuinely filled in. The
// column is nullable and nothing reads it yet, so
// there's no real need to enforce this here.
TranslatedText::make('name')
->label('Store name'),
TranslatedText::make('address')
->label('Address'),
TextInput::make('phone')
->label('Phone')
->tel(),
]),
Section::make('Legal')
->description('Shown on invoices and terms pages.')
->schema([
TextInput::make('tax_identifier')
->label('Tax ID (ΑΦΜ)'),
TextInput::make('registration_number')
->label('Company registration number (ΓΕΜΗ)'),
]),
Section::make('Bank transfer')
->description('Shown to a shopper on the order confirmation page when they chose to pay by bank transfer.')
->schema([
// Rich, not plain Textarea — a shop owner may want a
// formatted table (bank name / IBAN / BIC columns) or
// bold text, not just line breaks. RichEditor's
// 'table' toolbar button ships in its default toolbar
// (RichEditor::getDefaultToolbarButtons()), so this
// needs no extra config to get table insert/edit.
TranslatedText::make('bank_transfer_instructions')
->label('Instructions')
->optionRichtext(true),
]),
]);
}
protected function getFormActions(): array
{
return [
Action::make('save')
->label('Save')
->submit('save'),
];
}
public function save(): void
{
$state = $this->form->getState();
app(StoreDetailsService::class)->update($state);
Notification::make()
->title('Store details saved')
->success()
->send();
}
}
@@ -0,0 +1,26 @@
<?php
namespace Modules\Core\Store\Listeners;
use Illuminate\Support\Facades\Cache;
use Modules\Core\Store\Events\StoreDetailsUpdated;
use Modules\Core\Store\Services\StoreDetailsService;
/**
* Same shape as Modules\Core\Localization\Listeners\FlushTranslationCache —
* StoreDetailsService::current() caches forever (this is read on every
* storefront request that shows store details, e.g. the checkout
* confirmation page's bank transfer instructions), so the only way it ever
* becomes stale is a write through this same service. Not queued: unlike
* FlushTranslationCache (which only affects a LATER storefront request),
* StoreDetailsUpdated fires from the staff member's own save action, and
* StoreDetailsService::current() may be called again within that same
* request/response cycle.
*/
class FlushStoreDetailsCache
{
public function handle(StoreDetailsUpdated $event): void
{
Cache::forget(StoreDetailsService::CACHE_KEY);
}
}
+25
View File
@@ -0,0 +1,25 @@
<?php
namespace Modules\Core\Store\Models;
use Illuminate\Database\Eloquent\Model;
use Lunar\Base\Traits\HasTranslations;
/**
* Singleton — always exactly one row, fetched/created via
* Modules\Core\Store\Services\StoreDetailsService::current(). See that
* table's own migration docblock for why name/address/
* bank_transfer_instructions are locale-keyed JSON and the rest are plain.
*/
class StoreDetails extends Model
{
use HasTranslations;
protected $guarded = [];
protected $casts = [
'name' => 'array',
'address' => 'array',
'bank_transfer_instructions' => 'array',
];
}
@@ -0,0 +1,77 @@
<?php
namespace Modules\Core\Store\Services;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Event;
use Lunar\Models\Language;
use Modules\Core\Store\Events\StoreDetailsUpdated;
use Modules\Core\Store\Models\StoreDetails;
/**
* The only entrypoint that creates/updates the StoreDetails singleton — same
* shape as Modules\Core\Localization\Services\TranslationService: every
* write goes through here so it can dispatch StoreDetailsUpdated, which
* Modules\Core\Store\Listeners\FlushStoreDetailsCache reacts to. Never call
* StoreDetails::query()->update(...) or $storeDetails->save() directly — a
* write bypassing this service leaves current()'s forever-cache stale.
*/
class StoreDetailsService
{
public const CACHE_KEY = 'store-details';
/**
* Forever-cached — read on every storefront request that shows store
* details (e.g. the checkout confirmation page's bank transfer
* instructions), so this should never re-query the database on a normal
* request. Only ever invalidated by update() below, via
* FlushStoreDetailsCache reacting to StoreDetailsUpdated.
*/
public function current(): StoreDetails
{
return Cache::rememberForever(
self::CACHE_KEY,
fn () => $this->firstOrCreate(),
);
}
public function update(array $attributes): StoreDetails
{
$storeDetails = $this->firstOrCreate();
$storeDetails->update($attributes);
Event::dispatch(new StoreDetailsUpdated($storeDetails));
return $storeDetails;
}
/**
* A freshly-created row must never leave a translatable column
* genuinely NULL — Lunar's own TranslatedText component (Modules\Core\
* Store\Filament\Pages\ManageStoreDetails's `name`/`address`/
* `bank_transfer_instructions` fields) silently drops every keystroke
* on re-render when the field it's editing starts out NULL rather than
* an empty per-locale array. Real-world precedent (PaymentMethod's own
* translatable `name` column) never hits this, because every
* PaymentMethod row is created THROUGH the same Filament form that
* immediately fills `name` — this singleton is instead created blank
* and opened for editing in the same visit, which is exactly the gap
* that surfaces the bug. Caught and fixed after the fact, verified via
* tinker: seeding a real (non-null) array made typing into the field
* persist correctly, confirming NULL was the trigger.
*/
private function firstOrCreate(): StoreDetails
{
return StoreDetails::query()->firstOrCreate([], [
'name' => $this->emptyPerLocale(),
'address' => $this->emptyPerLocale(),
'bank_transfer_instructions' => $this->emptyPerLocale(),
]);
}
private function emptyPerLocale(): array
{
return Language::query()->pluck('code')->mapWithKeys(fn (string $code) => [$code => ''])->all();
}
}