diff --git a/CHANGELOG.md b/CHANGELOG.md index 4fd79e2..9e665f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,9 +4,912 @@ 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/). +## [0.18.0] - 2026-09-16 + +### Added + +Customer-portal backend groundwork — no routes/controllers/views yet (a storefront-facing UI is +3dealer's job once a frontend designer picks it up), but the boboko-owned services it needs to +call now exist: + +- `Modules\Core\Auth\Services\UserOtpService::validate()` now actually logs the shopper in + (`Auth::login()`, `web` guard) — previously it only returned the `User` model with no session + established and no route/controller anywhere ever called it (the checkout page's "Login" tab + was a disabled placeholder). `Auth::login()` alone is enough to merge/associate any active + guest cart too — it fires `Illuminate\Auth\Events\Login`, which Lunar's own + `Lunar\Listeners\CartSessionAuthListener` (registered unconditionally in core, no opt-in + needed) already reacts to, honoring `config('lunar.cart.auth_policy')` (`'merge'` by default). + An earlier draft of this also called `Cart::associate()` directly from this service — removed + as redundant and actually wrong: it ran a second, separate association with a hardcoded + `'merge'` policy that ignored whatever a consumer had actually set `auth_policy` to. Also fixed + an unbounded brute-force window: a 6-digit code (1M combinations, was guessable for its full + 10-minute expiry with no attempt cap) now invalidates itself after 5 wrong guesses + (`users.otp_attempts`, new column), forcing a fresh code request rather than leaving a live one + guessable indefinitely. +- `Modules\Core\Auth\Events\CustomerLoggedIn` — dispatched on every successful OTP login (new + user or returning), for a storefront to hook into (e.g. post-login redirect, analytics). +- `Modules\Core\Customer\Services\CustomerAccountService` — the storefront-facing "My Account" + API (mirrors `CartService`/`CheckoutService`'s shape): `orders()` (paginated, placed orders + only), `order()`, `addresses()`, `createAddress()`/`updateAddress()`/`deleteAddress()`, + `updateProfile()`. Every method is scoped to the given user's own `latestCustomer()` — there + is no method that accepts a bare order/address id without also requiring the owning user, so a + controller built on top of this can't leak one customer's data to another by trusting a + client-supplied id alone (verified live: a second customer attempting to read/edit the first's + address or order gets `AddressNotFoundException`/`OrderNotFoundException`, not the record). + +### Fixed +- `Modules\Core\Auth\Services\UserOtpService::validate()`'s wrong-guess counter (`otp_attempts`) + was read-check-increment-saved with no locking — two guesses fired in parallel for the same + user could each read the same pre-increment value and both save past `max_attempts`, letting an + attacker exceed the 5-guess lockout by parallelizing requests instead of sending them serially. + Now wrapped in a `DB::transaction()` with `lockForUpdate()` on the user row, so concurrent + guesses serialize correctly against the shared counter. +- The OTP code comparison used a plain `!=` rather than a timing-safe comparison. Now + `hash_equals()`. + +## [0.17.5] - 2026-09-15 + +### Added + +- Greek translations for `Lunar\Models\Country`/`State` reference data (`lang/el/countries.php`, + `lang/el/states.php`), keyed by the exact English spellings Lunar's own installer seeds for + Greece (fetched from `data.lunarphp.io/countries+states.json`). Loaded via + `loadTranslationsFrom()` under the `core::` namespace — a plain lang file, not + `Modules\Core\Localization`'s DB-backed `TranslationService`, since this is fixed reference + data, not admin-editable UI copy. A consuming app's storefront looks these up itself (e.g. + `__('core::countries.'.$country->name)`) — core has no storefront UI of its own to wire this + into. +- `Modules\Core\Order\Filament\Extensions\OrderActionsExtension::fixCaptureAction()` — reroutes + the backoffice "Capture" header action through `Modules\Core\Payment\Support\ +TransactionDriverAdapter::capture()`, the same app-level payment pipeline checkout-time captures + use, instead of vendor Lunar's `Lunar\Models\Transaction::capture()` (which resolved + `Lunar\Facades\Payments`, an entirely separate, unused driver registry, and never dispatched + `Modules\Core\Payment\Events\PaymentCaptured`). +- `Modules\Core\Payment\Drivers\StripePaymentDriver::cardMetaFromIntent()` — extracts card + brand/last-four digits from the Stripe PaymentIntent's `latest_charge`, populated into + `PaymentResult::$meta` and mapped onto `Transaction.card_type`/`last_four` by + `Modules\Core\Order\Services\TransactionRecorder`. Fixes the admin activity log's "Payment of + :amount on card ending :last_four" line rendering with no digits, on both checkout-time and + manual captures. Only applies to transactions recorded after this change. +- `PaymentMethod.name` and `Lunar\Shipping\Models\ShippingMethod.name` are now locale-keyed JSON + columns, rendered in Filament via Lunar's own `Lunar\Admin\Support\Forms\Components\ +TranslatedText` — one input per configured `Language` row, same shape/resolution as + Product/Collection names. Existing plain-string rows are preserved under the store's default + language on migration. `ShippingMethod` has no model cast/`ModelManifest` extension point + available (vendor table, `Contracts\ShippingMethod` exists but is never bound by the package), + so its translation is decoded/encoded at the Filament field boundary and via the new + `Modules\Core\Shipping\Support\ShippingMethodName::resolve()` helper, rather than a model cast. +- `Modules\Core\Shipping\Contracts\DeclaresFulfillmentType` — lets a shipping rate driver declare + whether it fulfils via carrier delivery or in-store pickup as a hardcoded fact about the driver + (`AcsRateDriver`, `BoxNowRateDriver` both declare `'carrier'`), instead of asking a merchant to + also pick "Carrier delivery" on every row regardless of driver. The merchant-facing "Fulfillment + type" Select (`ShippingMethod.data['fulfillment_type']`) now only appears for + table-rate-shipping's generic drivers (flat-rate, ship-by, free-shipping), which are genuinely + ambiguous, and moved next to `charge_by` instead of trailing at the end of the form, + disconnected from the decisions it relates to. `Modules\Core\Shipping\Support\ +FulfillmentType::resolve()`/`isStorePickup()` is the new single source of truth, replacing a + direct `data['fulfillment_type']` read in `Order::isStorePickupOrder()`. + +### Fixed + +- `Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus` never advanced `Order::status` past + `awaiting_payment` on a capture — only `paid`/`paid_at` were written, so a fully captured order + could sit indefinitely at "awaiting payment" until a staff member manually clicked "Update + Status". Now, on `PaymentCaptured` (not `PaymentAuthorized`), `status` advances to the next step + in the order's flow, but only when it's still exactly `awaiting_payment`, so a duplicate/delayed + capture event never regresses an order staff already moved further. +- `Lunar\DataTypes\ShippingOption::$collect` (the flag `docs/checkout.md` documents as the + mechanism for detecting a pickup option at checkout) was never actually set by any shipping rate + driver — `Modules\Core\Shipping\Concerns\ResolvesFixedPricing` now populates it from the same + `FulfillmentType` resolution `Order::isStorePickupOrder()` uses, closing a real gap between + documented and actual behavior. + +### Changed + +- `Modules\Core\Order\Filament\Extensions\OrderRefundActionsExtension` renamed to + `OrderActionsExtension` — the class now fixes both the refund and capture header actions on the + order page, not just refund. +- Removed the `lunarphp/stripe` dependency in favour of depending on `stripe/stripe-php` directly. + `Modules\Core\Payment\Drivers\StripePaymentDriver` had already replaced every bit of Lunar's own + Stripe payment flow (checkout, webhook processing) with its own — all that remained load-bearing + from the package was raw API-client access, amount conversion, and a correlation table, none of + which are Lunar-specific. Added first-party replacements: `Modules\Core\Payment\Support\ +StripeManager`, `Modules\Core\Payment\Models\StripePaymentIntent`, `Modules\Core\Payment\Http\ +Middleware\StripeWebhookMiddleware`, and a first-party copy of the vendor's + `create_stripe_payment_intents_table` migration (guarded with `Schema::hasTable()`). No behavior + change for consuming apps. + +## [0.17.4] - 2026-09-15 + +### Added + +- `boboko:catalog:backfill-skus` — one-off Artisan command to generate a SKU + (`SKU-P{product_id}-V{variant_id}`) for every `Lunar\Models\ProductVariant` left with a `null` + SKU by the earlier Shopify import (the source export's `Variant SKU` column was genuinely blank + for these rows, not an importer mapping bug — see `Modules\MigrateImport\Shopify\ +ShopifyExportImporter`). Only touches variants missing a SKU; `--dry-run` lists what would + change without writing. + +## [0.17.3] - 2026-09-15 + +### Changed + +- Removed the `lunarphp/stripe` dependency in favour of depending on `stripe/stripe-php` directly. + `Modules\Core\Payment\Drivers\StripePaymentDriver` had already replaced every bit of Lunar's own + Stripe payment flow (checkout, webhook processing) with its own — all that remained load-bearing + from the package was raw API-client access, amount conversion, and a correlation table, none of + which are Lunar-specific. Added first-party replacements: `Modules\Core\Payment\Support\ +StripeManager` (API client + `toStripeAmount()`/`fromStripeAmount()`), `Modules\Core\Payment\ +Models\StripePaymentIntent` (now with a proper `context` array cast, replacing manual + `json_encode`/`json_decode`), and `Modules\Core\Payment\Http\Middleware\ +StripeWebhookMiddleware`. Added `database/migrations/..._create_stripe_payment_intents_table.php`, + a first-party copy of the vendor migration (guarded with `Schema::hasTable()` so it's a no-op on + any environment that already has the table from the vendor package's own earlier migration run, + and only actually creates it on a genuinely fresh install). No behavior change for consuming + apps — same table, same driver contract, same webhook endpoint. + +## [0.17.2] - 2026-09-15 + +### Fixed + +- `Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus` never advanced `Order::status` past + `awaiting_payment` on a capture — only `paid`/`paid_at` were written, so a fully captured order + could sit indefinitely at "awaiting payment" until a staff member manually clicked "Update + Status". Now, on `PaymentCaptured` (not `PaymentAuthorized` — an authorization isn't yet + captured funds), `status` advances to the next step in the order's flow + (`Modules\Core\Order\Services\OrderStatusFlow::nextOptions()`) — but only when it's still + exactly `awaiting_payment`, so a duplicate/delayed capture event never regresses an order staff + already moved further. +- The backoffice "Capture" action on the order page (Filament) called vendor Lunar's + `Lunar\Models\Transaction::capture()` directly, which resolves `Lunar\Facades\Payments` — an + entirely separate, unused driver registry — and never dispatched `Modules\Core\Payment\Events\ +PaymentCaptured`. This meant a manual capture from the admin panel never ran this app's own + payment pipeline at all (including the status-advance fix above). `Modules\Core\Order\Filament\ +Extensions\OrderActionsExtension` (renamed from `OrderRefundActionsExtension`, since it now + fixes both the refund and capture header actions — see below) now routes capture through + `Modules\Core\Payment\Support\TransactionDriverAdapter::capture()`, the same app-level path + checkout-time captures use. +- `Modules\Core\Payment\Drivers\StripePaymentDriver` never extracted a card's brand/last four + digits from Stripe's response, so `Lunar\Models\Transaction::card_type`/`last_four` were always + empty and the admin's "Payment of :amount on card ending :last_four" activity-log line rendered + with no digits — reproduced on both checkout-time and manual captures. Added + `cardMetaFromIntent()`, reading `payment_method_details` off the PaymentIntent's `latest_charge` + (same source `lunarphp/stripe`'s own `StoreCharges` uses), populated into `PaymentResult::$meta` + from `resultFromIntent()` and `capture()`. `Modules\Core\Order\Services\TransactionRecorder` + now maps `meta['card_type']`/`meta['last_four']` onto the `Transaction` row. Only applies to + transactions recorded after this change — existing rows are not backfilled. + +### Changed + +- `Modules\Core\Order\Filament\Extensions\OrderRefundActionsExtension` renamed to + `OrderActionsExtension` — the class now fixes both the refund and capture header actions on the + order page, not just refund, so the old name undersold its scope. + +## [0.17.1] - 2026-09-15 + +### Fixed + +- `Modules\Core\Payment\Drivers\StripePaymentDriver::createAndConfirm()` only set + `automatic_payment_methods` when no `payment_method` was given — the actual checkout flow always + sends one, so it was omitted, and Stripe fell back to whatever payment methods are enabled in the + Dashboard and demanded a `return_url` on confirm. Fixed by setting `automatic_payment_methods` + unconditionally with `allow_redirects: never` — the storefront's Payment Element already restricts + itself to `paymentMethodTypes: ['card']`, so this just tells Stripe the same thing server-side, + which drops the `return_url` requirement. + +## [0.17.0] - 2026-09-14 + +### Added + +- `Modules\Core\Order\Notifications\OrderPlacedNotification` — an order confirmation email, + registered against `Modules\Core\Checkout\Events\OrderPlaced` (fires exactly once per order, + regardless of `capture_mode`/driver). Previously only a Stripe (auto-captured) order triggered + any placement email at all, via `OrderCapturedNotification` — a different concern (payment + confirmation) that happened to fire at the same moment for that one driver; an offline or + bank-transfer order got no confirmation whatsoever. Verified live via Mailpit. +- `Modules\Core\Order\Listeners\DecrementStockOnOrderPlaced` — also wired to `OrderPlaced`, the + first stock decrement anywhere in this codebase (previously nothing wrote to + `ProductVariant::stock` as a result of an order at all — overselling was possible). A single + atomic `UPDATE ... SET stock = GREATEST(stock - qty, 0)` per variant, not a read-then-write on + the Eloquent model, to avoid a lost-update race between two orders decrementing the same variant + concurrently. Only touches `purchasable === 'in_stock'` variants on `physical` order lines — + `always`/`backorder` variants are deliberately left alone (their stock has no purchasing + consequence, decrementing it would just make the column an inaccurate negative number). Also + re-triggers Scout reindexing for every affected product, closing the gap `Modules\Core\Catalog\ +Services\ProductIndexer`'s own docblock flagged ("nothing currently reindexes a product when an + order decrements its stock") — the search index's `in_stock` filter now reflects the change + immediately rather than only on the next scheduled reindex. +- `Modules\Core\Cart\Services\CartLifecycleService` — the single source of truth for the four + cart lifecycle states (Ongoing, Abandoned Cart, Abandoned Checkout, Completed) documented in + `docs/cart.md`. Previously `Modules\Core\Cart\Filament\Resources\CartResource\Pages\ListCarts` + and `Modules\Core\Cart\Commands\DetectAbandonedCarts` each reimplemented the same query split + independently, which is exactly the kind of drift that lets the admin panel and the + recovery-email pipeline quietly disagree about what "abandoned" means. Both now build on the + same `ongoing()`/`abandonedCarts()`/`abandonedCheckouts()`/`completed()` methods, each taking a + `Builder` so callers compose the scope onto whatever base query they already have — Filament's + own tab query (search/sort/pagination intact) for `ListCarts`, a bare `Cart::query()` for the + command. +- `core.cart.unrecoverable_after` config (default `90 days`) — beyond this age, a stale cart + stops being treated as an active "Abandoned Cart"/"Abandoned Checkout" at all (excluded from + both `CartLifecycleService` methods), rather than staying flagged as an actionable abandonment + forever. A 90-day-old (or older) cart's pricing/stock/tax have very likely moved on, so it's not + a realistic recovery target — this is about the abandoned-cart pipeline only, not data + retention; no rows are deleted or pruned. +- `Modules\Core\Cart\Filament\Resources\CartResource\Pages\ViewCart`'s Lines section now shows + each line's product thumbnail, name (linking to the product's edit page), and variant options — + not just SKU/quantity/price — mirroring Lunar's own order line item display + (`OrderItemsTable`). Also added a new Shipping section: the resolved shipping method name (not + the bare `acs`-style identifier), destination country, shipping total, and each + `shippingBreakdown` line item individually (carrier rate, plus any payment-method fee — see + 0.16.3's `ApplyPaymentMethodFee`) so staff can see what makes up the total, not just the sum. + Guards around `Lunar\Models\ProductVariant::getDescription()`/`getOption()`: both are typed to + return `string` but internally read `translateAttribute()`/`translate()`, which return `null` + for a product/option with no attribute data set for the active locale — a real `TypeError` hit + live against an existing test-fixture product. Reads the underlying relations directly instead + of calling through those methods, falling back to "—" rather than crashing the page. + +- `Modules\Core\Payment\Drivers\CashOnDeliveryPaymentDriver` — cash-on-delivery/cash-on-pickup was + previously wired to `OfflinePaymentDriver`, the same immediate-capture driver as cash-in-hand, + which meant a COD order was marked paid the instant it was placed even though no money had + actually changed hands. The new driver's `pay()` returns `PaymentResultStatus::Pending` and + dispatches nothing, so payment stays unresolved until staff explicitly confirm cash was received + (see `Order::paid`/`paid_at` below). A data migration repoints the already-seeded + `cash-on-delivery` `PaymentMethod` row to the new driver key. +- `Order::paid`/`paid_at` — an entirely independent boolean/timestamp pair tracking payment, + settable at any point in an order's lifecycle regardless of fulfillment progress. Exists because + cash-on-delivery payment timing has no relationship to the fulfillment sequence at all — a + courier might not reconcile cash for weeks after an order is already marked completed. + +### Changed + +- **Order status model, redesigned from scratch.** `Order.status` is a single column again + (a same-session 3-axis `payment_status`/`fulfillment_status`/`return_status` design was built, + then abandoned before shipping — three independent selects let staff set any combination with no + cross-field validation, and didn't map onto how staff actually think about an order: one linear + journey, not three simultaneous dials). Now driven by `Modules\Core\Order\Services\ +OrderStatusFlow`, a pure transition-table service offering exactly two sequences — carrier and + store-pickup (`Order::isStorePickupOrder()`) — never four; payment method (prepaid vs. COD) + affects `Order::paid` only, not which sequence an order follows or where it sits in it. The + Filament order page's several guided buttons are replaced by three header actions: "Update + Status" offers every status in the order's own branch (`OrderStatusFlow::allOptions()`) — not + just the guided next step — so staff can also revert to an earlier status (e.g. undoing a + mistaken click); it also replaces vendor `ManageOrder`'s own built-in "Update Status" (same + action name, previously left in place unintentionally, producing two duplicate buttons), since + vendor's writes `status` directly with no audit trail or branch validation. It is a PLAIN status + write with no side effects — picking 'dispatched' there does not create a real shipment. "Create + Shipment" is its own separate action, visible only for a carrier order at 'ready_for_dispatch' + (`OrderFulfillmentService::canCreateShipment()`) — the one action that talks to a real carrier + API, so its weight/locker inputs only ever appear for that specific real-world action rather than + inside the general-purpose status select for every manual override of 'dispatched'. "Mark Paid" + is a third, separate header action — `Order::paid` is independent of `status`, so it doesn't + belong bundled into the status select either — visible only when the order's payment method + doesn't auto-capture at checkout (currently only cash-on-delivery). New status vocabulary + (`awaiting_payment`, `processing`, `ready_for_dispatch`/`ready_for_pickup`, `dispatched`, + `delivery_failed`, `picked_up`, `delivered`, `completed`, `return_requested`, `returned`, + `partially_refunded`, `refunded`) replaces the old hyphenated 7-value list in + `config/lunar/orders.php` — a breaking rename backed by a one-time data migration that maps every + existing order onto the new vocabulary (preferring axis-system data where an order was actually + moved through it during this session's testing, falling back to the legacy flat status otherwise) + and derives `paid` from historical transaction data. (The carrier branch's post-delivery status + was initially named `return_window_open`; renamed to `delivered` — same one combined moment, + parcel arrived and return window open — via a follow-up migration once the internal name turned + out to be a confusing thing for staff to see on an order.) A new "Payment Method" entry on the + order summary sidebar (`Order.meta['payment_method']`, falling back to the latest transaction's + driver) surfaces which method a shopper actually used, previously shown nowhere on the order + page. The order list topbar's tabs (Lunar's own `favourite` config flag) are trimmed to the + main-journey statuses only, rather than all twelve — the exception/branch statuses stay reachable + via the table's own filter. +- "Create Shipment"'s form now branches by carrier (`OrderFulfillmentService::carrierFor()`): + - A weight-billed carrier (ACS) gets its weight field pre-filled from the order's own line + weights via the new `Modules\Core\Shipping\Support\WeightCalculator` (the same unit-conversion + table `AcsRateDriver::totalWeightInKg()` already used for live rate quoting, now shared rather + than duplicated) — still staff-editable, not forced. + - Box Now ships by compartment size, not weight, so it gets a repeatable list of boxes (one row + per physical parcel, each with its own S/M/L size — `ShipmentRequest::$boxes`) instead of the + weight field. `BoxNowFulfillmentService::createShipment()` sends one `items` entry per box in a + single delivery request and now creates one `Shipment` row per parcel returned (was hardcoded to + exactly one box/compartmentSize=1, silently ignoring anything beyond the first parcel) — each row + independently trackable/printable/cancellable, linked to its siblings via a shared + `meta['delivery_request_id']`. + - Box Now's locker field is locked read-only once the shopper's own checkout selection + (`$order->shippingAddress->meta['box_now_locker']`) is present — staff can no longer silently + redirect a parcel to a different locker than the one the customer picked at checkout; it's only + editable for the (current, checkout-UI-less) case where nothing set it yet. +- New "Shipments" section on the order page (`Modules\Core\Shipping\Extensions\ +OrderShipmentsExtension`, between Transactions and Timeline) — "Create Shipment" previously had no + counterpart anywhere to actually see what it created. One entry per `Shipment` record (a multi-box + Box Now order shows one entry per parcel), rendered as two inline-labelled lines — carrier + + tracking reference, then status + a "Created … · Locker …" helper line — rather than a grid of + individually stacked label/value blocks, which reads as a wall of repeated labels once the admin's + main content area narrows below Filament's own grid breakpoint (1024px, common with the sidebar + open). Two actions per shipment: "Print Label" and "Cancel". Also added `Modules\Core\Shipping\ +Http\Controllers\DownloadShipmentLabelController` (short-lived signed URL, same auth model as + Lunar's own vendor order-PDF download) — the only other place that called + `CarrierFulfillmentInterface::printLabel()` (`ManagePickupManifests`' bulk "Print" action) + discarded the returned bytes entirely; this is the first place in the codebase that actually + delivers a label to staff. Hit and fixed two bugs while wiring this up: a `TextEntry` with a blank + `state('')` skips rendering its `suffixActions()` entirely (Filament's own empty-state branch + returns before reaching the actions markup), so the label-download entry needed a real, + non-blank value; and the label-download route, registered via `loadRoutesFrom()` with no + middleware group, had `SubstituteBindings` never run, so a type-hinted `Shipment $shipment` + parameter silently resolved to an empty, non-existent model instead of 404ing — fixed by taking a + plain `int $shipment` and looking the record up directly in the controller. +- `Modules\Core\Shipping\Enums\TrackingStatus::Failed` — previously unused — is now wired to the + new `delivery_failed` status via `Modules\Core\Order\Listeners\ +MarkDeliveryFailedOnCarrierCheckpoint`, from which staff can retry dispatch or convert to a + return. +- Fixed a separate, unrelated bug hit while testing the above: `Lunar\Shipping\Models\ +ShippingMethod::macro('isStorePickup', ...)` silently never registered — `Lunar\Base\Traits\ +HasModelExtending::__callStatic()` (used by every `Lunar\Base\BaseModel` subclass that doesn't + declare its own `macro()`, `ShippingMethod` included) intercepts _every_ unmatched static call + and dispatches it as an instance call instead of forwarding to `Macroable`, so `hasMacro()` always + returned `false` and every order was silently treated as carrier-fulfilled — including store-pickup + ones. `Order::isStorePickupOrder()` (the only caller) now reads `ShippingMethod.data +['fulfillment_type']` directly instead of going through the broken macro. +- `CartResource::getEloquentQuery()` no longer filters to carts with a known `user_id`/ + `customer_id` — every cart is now listed, guest carts included. Reverses an earlier deliberate + exclusion (an anonymous cart has nothing a staff member could click into — no name, no email), + which held for that specific concern but not for the resource's other real use: seeing how many + carts are ongoing/abandoned right now. Most real storefront traffic never reaches an identified + user/customer, so excluding it silently undercounted exactly what `CartLifecycleService` exists + to report on. A guest row's Customer/User columns just render "—" (no link) rather than the row + being hidden. +- `CartLifecycleService::abandonedCarts()` now requires `whereHas('lines')` — an empty cart + (created but nothing ever added, e.g. a bot, or a session that never shopped) is no longer + counted as "abandoned." There's nothing to recover, so it was a false positive: 9 of 16 carts in + the "Abandoned Cart" tab during testing were empty. Removed the now-redundant post-hoc + `lines->isEmpty()` skip (and its `with('lines')` eager load) from `DetectAbandonedCarts`, since + the query itself excludes them now. +- `Modules\Core\Shipping\Models\Manifest` — a real record of "a manifest was issued", replacing the + loose `shipments.manifest_reference` string. ACS's own `ACS_Issue_Pickup_List` call returns + nothing beyond a `PickupList_No`, so there was previously no way to see which shipments were on a + given manifest, or when it was issued, once the moment passed — only per-shipment breadcrumbs. + `shipments.manifest_id` (FK, replacing `manifest_reference`) now links each shipment to the + `Manifest` row `AcsFulfillmentService::issueManifest()` creates; `ManifestResult::success()` + carries the created `Manifest` instead of a bare reference string. A one-time data migration + backfills a `Manifest` row per distinct existing `(carrier, manifest_reference)` pair, using the + earliest `label_printed_at` (or `updated_at`) among that group as a best-effort `issued_at`, since + the real issue time was never recorded anywhere. +- Split the standalone `Modules\Core\Shipping\Filament\Pages\ManagePickupManifests` page into two + real Filament resources — a bare `Page` has no access to Filament's resource-level pill-tab UI + (`HasTabs` is scoped to `ListRecords`), which carrier-by-carrier separation needed: + - `Modules\Core\Shipping\Filament\Resources\ShipmentResource` ("Pending Vouchers") — shipments not + yet on an issued manifest, one tab per carrier that implements `SupportsManifestBatching` (ACS + today; Box Now has no manifest concept at all — courier pickup is booked at shipment-creation + time — so it gets no tab). Adding a future carrier with its own manifest endpoints (e.g. + Speedex) needs zero UI changes here — tabs are derived from `Shipping::getSupportedDrivers()`, + not hardcoded. + - `Modules\Core\Shipping\Filament\Resources\ManifestResource` ("Issued Manifests") — lists issued + `Manifest` rows (also tabbed by carrier), with a view page and a `ShipmentsRelationManager` + showing which shipments a manifest included, each individually reprintable. + - Both bulk actions ("Print selected", "Issue Manifest") now catch `Throwable` around the actual + carrier API call and surface a Filament notification instead of an unhandled 500 — previously + neither had any error handling at all, so an `AcsApiException` (routine against a voucher/pickup + date the carrier no longer recognizes) crashed the whole page. + - Fixed a bug introduced while building this: `ViewManifest` initially overrode + `getRelationManagers()` directly instead of registering `ShipmentsRelationManager` via + `ManifestResource::getRelations()` (the actual wiring point — + `HasRelationManagers::getAllRelationManagers()` reads from `Resource::getRelations()`, not a + page-level override). The override bypassed the trait's own record-check/caching logic and + broke the relation manager's Livewire component mount, surfacing as a CSRF-token 419 redirect + loop specifically on `/boboko/manifests/{id}`. +- "Create Shipment"'s ACS branch gained a "Number of packages" field (`ShipmentRequest:: +$packageCount`, already plumbed through to ACS's `Item_Quantity`/`persistMultipartVouchers()` but + never exposed in the form) — more than 1 issues a main voucher plus a multi-part sub-voucher per + extra package, each its own `Shipment` row sharing the same total weight. The existing weight + field was relabeled "Total weight (kg)" to make explicit that ACS bills by one total shipment + weight, not per package. + +## [0.16.3] - 2026-09-10 + +### Fixed + +- Stripe `createAndConfirm()` built its `PaymentIntent` params with + `'automatic_payment_methods' => isset($data['payment_method']) ? null : ['enabled' => true]`. The + Stripe PHP SDK does not omit `null`-valued params from `create()` — it serializes them to an empty + string (`ApiRequestor::_encodeObjects()` → `Util::utf8(null)`), and Stripe's API rejects an empty + `automatic_payment_methods`. Every Stripe charge failed before it started whenever a + `payment_method` was supplied (i.e. every real charge in this flow). Fixed by building `$params` + conditionally so the key is either omitted entirely or set to `['enabled' => true]`, never `null`. +- `Modules\Core\Payment\Filament\Resources\PaymentMethodResource`'s "Driver status" column only + flagged a payment method whose driver _class_ no longer resolves (`driver_missing_at`) — it gave + no indication when a driver resolves fine but fails `Configurable::isConfigured()` (e.g. Stripe + enabled in the DB with no `services.stripe.key` set), which `CheckoutService::getPaymentMethods()` + filters out identically. An admin had no way to tell "this method is silently absent at checkout + because of missing config" from "everything's fine" at a glance. The same icon column now also + reflects `isConfigured()`, with a tooltip distinguishing "driver not found" from "missing required + configuration" from "fully configured." +- `Modules\Core\Payment\Pipelines\Cart\ApplyCashOnDeliveryFee` (now `ApplyPaymentMethodFee`) had two + stacked bugs that together meant a configured payment-method fee (e.g. €5 on Cash on Delivery) + never actually reached the cart total: + - `PaymentMethod::where(...)->value('data->fee')` silently returned `null` on Postgres — Laravel's + query builder does not translate the `->` JSON-path column-selector syntax in `value()`/`pluck()` + the way it does inside `where()` clauses, so this resolved to a discarded + `stdClass::$data->fee` property access instead of the actual fee. Fixed by loading the model and + reading the cast `->data['fee']` attribute instead. + - Even with the fee correctly read, adding it directly to `$cart->shippingTotal` didn't survive: + `Lunar\Pipelines\Cart\CalculateTax`, which runs later in the same cart-calculation pipeline, + unconditionally recomputes `shippingTotal` (and shipping tax) from `$cart->shippingBreakdown`'s + item sum — silently discarding anything set only on the plain property. Fixed by adding the fee + as its own `Lunar\Base\ValueObjects\Cart\ShippingBreakdownItem` on `shippingBreakdown` instead, + so it survives `CalculateTax`'s recompute and is correctly included in shipping tax too. + - Also generalized while fixing: the pipeline was hardcoded to the literal type string + `cash-on-delivery`. Renamed to `ApplyPaymentMethodFee` and changed it to look up whichever + `PaymentMethod` row matches `Cart::meta['payment_method']` and apply its own `data.fee` if + present — works for any payment method configured with a fee, not just one specific slug. +- `Modules\Core\Checkout\Services\CheckoutService::selectPaymentMethod()` called `$cart->calculate()` + after saving the new payment method, but `Lunar\Models\Cart::calculate()` no-ops if the cart + instance was already calculated earlier in the same request (`Cart::isCalculated()`) — + `Lunar\Managers\CartSessionManager` memoizes one `Cart` instance per request, so this was true on + every request where the checkout page's initial render had already calculated the cart. The + result: after switching payment methods, the just-saved `meta['payment_method']` change was + persisted, but the cart's totals silently kept reflecting whichever method was calculated _first_ + in the request — a shopper switching from Cash in Hand to Cash on Delivery would keep seeing Cash + in Hand's total, with no COD fee applied, until something else forced a fresh calculation. Fixed + by calling `$cart->recalculate()` instead, which forces the pipeline to re-run. + +## [0.16.2] - 2026-09-09 + +### Fixed + +- `Lunar\Base\ShippingManifest` is a request-lifetime singleton whose `getOptions()` re-runs the + shipping modifier pipeline without ever clearing its `$options` collection first, and whose + `addOption()` keeps the first entry per `getIdentifier()` and silently drops any later one. In + practice, an option resolved for an earlier shipping address (or cart state) shadowed the + correct one after the address/region changed within the same request — e.g. a carrier priced + differently across two zones that both match an address would keep quoting the stale zone's + price, and `ApplyShipping` would price the cart total off that same stale option. Renamed + `Modules\Core\Shipping\Listeners\FlushLivePricingCache` to + `Modules\Core\Shipping\Listeners\InvalidateShippingOptions` and had it additionally call + `ShippingManifest::clearOptions()`, merged in because both invalidations fire on the exact same + event set (`CartLineAdded`, `CartLineUpdated`, `CartLineRemoved`, `CartCleared`, + `ShippingAddressSet`) — the only inputs the shipping modifier pipeline depends on. + +## [0.16.1] - 2026-09-09 + +### Fixed + +- OTP login page (`resources/views/auth/filament/pages/login.blade.php`) had no visible spacing + between the email/OTP input, error text, and buttons following the Filament v3 → v4 upgrade. + The view relied on a bare `grid gap-y-4` Tailwind utility class, but since this view ships from + the `boboko-core` package rather than a consuming app, that class was never present in any + host app's compiled Tailwind output. Replaced with an inline `style` (flex column, `row-gap: +1rem`) so the layout no longer depends on the consuming app's Tailwind content scanning. + +## [0.16.0] - 2026-09-08 + +### Added + +- `Modules\Core\Checkout\Services\CheckoutService::setRecoveryConsent(bool $consent): Cart` — the + shopper's promotional/abandoned-cart-recovery opt-in, given once during guest checkout and + deliberately independent of `setShippingAddress()`/`setBillingAddress()`: consent is a + cart-level decision, not tied to any one `CartAddress` — changing which address is on the cart + later never resets or re-asks for it. Only an explicit call to this method (the checkbox itself + being submitted) ever changes it; calling it again with `false` is how a later opt-out is + recorded, per the legal requirement that consent be provable and withdrawable. Stored on + `Cart::meta` (interim, per the design this implements — a real column/consent record is the + eventual target, tracked as follow-up) as `recovery_consent` (bool), `recovery_consent_at` + (ISO 8601, `null` when `false`), and `recovery_consent_policy_version` + (`config('legal.privacy_policy_version')` at the moment of consent, so a later dispute is + answered from what was actually agreed to). Dispatches new + `Modules\Core\Checkout\Events\RecoveryConsentSet`. Newsletter opt-in is explicitly a separate + scope — never merged into this flag. +- `Modules\Core\Checkout\Services\CheckoutService::initiatePayment()` now requires `bool +$termsAccepted` and `string $policyVersion` as mandatory parameters (not optional data a caller + might omit) — throws the new `Modules\Core\Checkout\Exceptions\TermsNotAcceptedException` + _before_ `Cart::createOrder()` is ever called if `$termsAccepted` is `false`, so an order can + never exist without a recorded acceptance (refused, not created-then-flagged). On success, + writes `terms_accepted` (`true`), `terms_accepted_at` (ISO 8601), and + `terms_accepted_policy_version` onto the created `Order`'s own `meta` — the durable, + order-level audit trail for a consumer-contract acceptance dispute, written directly (not via + an event/listener) since the `Order` row doesn't exist until `createOrder()` returns. +- `Modules\Core\Cart\Commands\DetectAbandonedCarts` — both its `CartAbandoned` and + `CheckoutAbandoned` detection queries now require `meta->recovery_consent = true`. A + non-consenting cart's abandonment is never dispatched at all (not merely filtered later at + whatever future recovery-email send step reads it) — the correct enforcement point per the + legal requirement that recovery/marketing sends only ever reach carts that opted in. +- `config/legal.php` (merged by a new `Modules\Core\Providers\CheckoutServiceProvider`) — + `privacy_policy_version`/`terms_version`, plain `env()`-backed strings bumped by whoever edits + the corresponding legal page. Recorded alongside every consent/acceptance rather than read live + at dispute time, so what a shopper actually agreed to is answered from the cart/order itself. + `CheckoutServiceProvider` itself is new — `Checkout` previously had no dedicated service + provider at all (its service/events were resolved/dispatched without one). + +## [0.15.0] - 2026-09-07 + +### Changed + +- **Breaking:** `Modules\Core\Payment\Models\PaymentMethod` is now the full DB-instance layer for + Payment, same three-layer split (registry / DB instance / cross-cutting config) `Shipping` + already has via `ShippingMethod` — see `docs/payments.md`. Every value that used to live in + `config('lunar.payments.types.{type}.*')` (`payment_driver`, `capture_mode`, `captured_status`) + moves onto the `PaymentMethod` row itself as real columns: `driver` (the new + `PaymentDriverRegistry` key — NOT the same as `type`; two rows can share one driver), `name` + (admin-facing label, nothing played this role before), `capture_mode`, `captured_status`, + `authorized_status`, `position` (admin-controlled ordering, new — reorderable in the Filament + table), `driver_missing_at`. `config('lunar.payments.types')` is gone entirely; `config/ +payment.php` now holds only `cart_pipeline` (genuinely cross-cutting — every store gets the + same pipeline wiring regardless of how many payment methods it configures). +- **Breaking:** `Modules\Core\Payment\Services\PaymentDriverResolver` is deleted, replaced by + `Modules\Core\Payment\Services\PaymentDriverRegistry` — `register(string $key, string +$driverClass)`/`resolve(string $key): ?object`/`all(): array`. Deliberately + knows nothing about `PaymentMethod` or the database (mirrors `Lunar\Shipping\Managers\ +ShippingManager`'s built-in-methods + `Manager::extend()` split, purpose-built rather than + extending `Illuminate\Support\Manager` — Payment's drivers implement several independent + capability interfaces at once, not one uniform contract). Built-ins (`OfflinePaymentDriver` + as `'offline'`, `StripePaymentDriver` as `'stripe'`) registered in + `PaymentServiceProvider::boot()`, exactly how `Shipping::extend('acs', ...)` already works. +- **Breaking:** `Modules\Core\Checkout\Services\CheckoutService::getPaymentMethods()` now returns + `Illuminate\Support\Collection` (ordered by `position`), not + `array`. A method is offered only once three independent checks all pass — `enabled` + (admin turned it on), `driver_missing_at` is null (the driver class still exists), and the + resolved driver's own `Configurable::isConfigured()` (its runtime requirements are met) — each + failure meaning something different to an admin diagnosing why a method isn't showing up. + `initiatePayment()` resolves the driver via the selected row's own `driver` column, not `type`. +- `Modules\Core\Payment\Filament\Resources\PaymentMethodResource` — `canCreate()`/`canDelete()` + now both `true` (previously hardcoded `false`, since a row could only ever be a config-defined + type before this release). New create/edit form (`name`, `type`, `driver` — a `Select` + populated live from `PaymentDriverRegistry::all()`, `capture_mode`, `captured_status`, + `authorized_status`); reorderable table (`->reorderable('position')`); a distinct "Driver + status" icon column (separate from the `enabled` toggle) showing whether `driver_missing_at` + is set. +- `Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus` reads `captured_status`/ + `authorized_status` off the `PaymentMethod` row (`where('type', $event->type)`) instead of + `config(...)`. +- `Modules\Core\Command\InstallLunarCommand::seedPaymentMethods()` no longer iterates + `config('lunar.payments.types')` — it seeds exactly one opinionated `cash-on-delivery` starter + row, every value a plain literal in the command itself (not sourced from config or the + registry — a driver has no business carrying opinions about what its captured order status + should be called; that's a merchant decision). Skip-if-exists, same as before. + +### Added + +- `php artisan boboko:payment:sync-drivers` — reconciles every `PaymentMethod` row's `driver` + against `PaymentDriverRegistry`, setting `driver_missing_at` when a driver no longer resolves + (a package removed, a custom `register()` call deleted) and clearing it automatically if that + driver is registered again in a later deploy. Deliberately its own standalone command, meant to + run unconditionally on every container start/deploy (Dockerfile entrypoint, alongside + `migrate`) — "did the set of registered drivers change" is a deploy-time event, cheap enough to + check every time regardless of whether anything actually changed. Verified live: flags a row + whose `driver` was manually corrupted, and auto-clears the flag once the driver resolves again. +- `docs/payments.md` — new "Registry, DB instance, and cross-cutting config" section: the + three-layer split researched against `Shipping`'s own already-existing pattern and three real + e-commerce platforms (Shopify, WooCommerce, Medusa.js), the "would a store ever plausibly want + two different answers to this" test for deciding config vs. DB-column placement, and the + three-check availability chain. + +- `Modules\Core\Payment\Services\PaymentMethodCache` (`Cache::rememberForever`, same pattern as + `Localization\Services\LanguageCache`) + `Modules\Core\Payment\Services\PaymentMethodService` + (`create`/`update`/`delete`/`list`) — the single read/write gateway for `PaymentMethod` now used + by every Filament resource action (create, edit, edit-fee, delete, the inline `enabled` toggle) + instead of the Eloquent model directly, so the cache is invalidated and + `PaymentMethodCreated`/`PaymentMethodUpdated`/`PaymentMethodDeleted`/`PaymentMethodsReordered` + dispatch on every write, with no exceptions other than Filament's own drag-to-reorder (which + does a raw bulk SQL `UPDATE` on the position column directly via + `CanReorderRecords`/`reorderTable()`, before `afterReordering()` fires — a confirmed, unavoidable + Filament limitation; the reorder hook only clears the cache and dispatches + `PaymentMethodsReordered` afterward). `CheckoutService::getPaymentMethods()` and + `ApplyResolvedPaymentStatus` both now read through the cache instead of querying `PaymentMethod` + directly. +- `Modules\Core\Payment\Models\CoreTransaction` (a `Lunar\Models\Transaction` subclass) + + `Modules\Core\Payment\Support\TransactionDriverAdapter`, registered via + `Lunar\Facades\ModelManifest::replace(Lunar\Models\Contracts\Transaction::class, +CoreTransaction::class)` — the same contract-swap mechanism already used elsewhere for + `Customer`/`Staff`. Fixes a real crash (`InvalidArgumentException: Driver [cash-on-delivery] not +supported`) the first time anything called `$transaction->refund()`/`->capture()`: + `Lunar\Models\Transaction::driver()` calls Lunar's own, entirely separate + `Lunar\Facades\Payments::driver()` manager, which had never heard of any of this codebase's + driver keys. `CoreTransaction::driver()` returns `TransactionDriverAdapter` instead, which + resolves the transaction's real `PaymentMethod`/`PaymentDriverRegistry` driver and calls it — + Lunar's own admin panel "Refund"/"Capture" buttons now transparently reach the real payment + system underneath, including correctly reporting failure (not a silently-faked success) when + the resolved driver doesn't implement `SupportsRefunds`/`SupportsCaptures`. +- `TransactionDriverAdapter::refundVia(Transaction $transaction, ?string $driverKey, int $amount, +?string $notes = null)` — refund through an explicitly chosen driver, independent of the one + the original payment went through (e.g. a cash-on-delivery order refunded via Bank Transfer, + which has no notion of the original offline payment at all). The order page's refund action + gained a "Refund via" `Select` (every `PaymentDriverRegistry` driver implementing + `SupportsRefunds`, defaulting to the transaction's own driver) that routes through this method + instead of `Lunar\Models\Transaction::refund()`, whose fixed signature has no room for a driver + override. +- `Modules\Core\Payment\Drivers\BankTransferPaymentDriver` (registered as `'bank-transfer'`) — + manual/attested, same trust model as `OfflinePaymentDriver`: no gateway call, `pay()`/`refund()` + decide success immediately on a staff member's say-so. Implements both `SupportsPay` and + `SupportsRefunds`; exists specifically so a payment taken through a different method can still + be refunded via bank transfer. The admin UI for receiving a payment this way (bank reference, + notes, proof-of-transfer upload) is a follow-up — the driver itself is complete and usable via + the registry today. +- `Modules\Core\Order\Filament\Infolists\TransactionEntry` (swapped in for Lunar's own + `Lunar\Admin\Support\Infolists\Components\Transaction` via a new + `OrderTransactionsExtension::extendTransactionsRepeatableEntry()` hook) — the order page's + transaction cards now also show a note recorded in `Transaction.meta['notes']` when the `notes` + column itself is empty. `Order\Services\TransactionRecorder` only ever wrote `notes` from + `PaymentResult::$failureReason`, which is never set on a successful result — a manual driver's + staff-entered note (e.g. `BankTransferPaymentDriver`'s) was being recorded but had nowhere to + render. +- `Modules\Core\Payment\Listeners\LogPaymentMethodActivity` — `PaymentMethod` now has an admin + activity trail, unlike `Order`/`Transaction`/`Staff` it previously had none. Routes + `PaymentMethodCreated`/`Updated`/`Deleted` through the existing `Logging\ActivityLogService` + (the same one `Localization\Listeners\LogTranslationActivity` already uses) rather than adding + `PaymentMethod` to `Lunar\Base\Traits\LogsActivity`'s generic model-observer logging — + `PaymentMethodUpdated::$old`/`PaymentMethodDeleted::$method`'s snapshot already carry more + deliberate before/after context than Eloquent's own dirty-attribute diffing would reconstruct. + `PaymentMethodsReordered` is deliberately NOT logged — a multi-row position change doesn't fit + `ActivityLogService`'s one-`Model`-subject shape, and isn't worth a new method for a low-stakes, + purely-cosmetic setting. +- New `payment_methods.refunded_status` column + form field (same `Select` pattern as + `captured_status`/`authorized_status`) — `ApplyResolvedPaymentStatus` now also reacts to + `PaymentRefunded`, so `Order.status` actually changes on a refund; before this, only the + _derived_ `Order::paymentStatus()` reflected a refund (reading `transactions` live), while the + stored `status` column — what admin filtering, customer emails, etc. actually key off — never + moved. Resolves the ORIGINAL payment method for this lookup, not the refund event's own + `$type`: a refund routed through a different driver via `refundVia()` (e.g. cash-on-delivery + refunded through Bank Transfer) carries the REFUND driver's registry key as `$event->type`, + which usually isn't even a real `PaymentMethod.type` — the listener now finds the order's + earliest successful `capture`/`intent` transaction instead and reads `refunded_status` off + _that_ transaction's own `PaymentMethod` row, since that's the payment the refund is actually + reversing. Deliberately no `void_status` yet — a void never moved money, so it doesn't carry + the same "the customer needs to see this changed" weight a refund does. + +### Fixed + +- Existing `PaymentMethod` rows seeded before this release (`cash-on-delivery`, `cash-in-hand`) + had `driver`/`capture_mode`/`captured_status` all `NULL` after the migration ran — a data + backfill was required (not automated by the migration itself) to restore them to a resolvable + state; flagged here since a consuming app upgrading past this release needs the same backfill + for its own pre-existing rows before `getPaymentMethods()` will offer them again. +- `Lunar\Admin\Filament\Resources\OrderResource\Pages\ManageOrder::getRefundAction()`/ + `getCaptureAction()` and `OrderItemsTable::getBulkRefundAction()` report a failed refund/capture + by calling `$action->failureNotification(...)`, `$action->failure()`, then `$action->halt()` — + but `Filament\Actions\Concerns\InteractsWithActions::callMountedAction()` only ever sends that + notification from a code path that runs after the action's closure returns normally; `halt()` + throws `Filament\Support\Exceptions\Halt`, caught by an earlier `catch` block that rolls back and + returns, so the notification was built but never sent — clicking "Refund" on a payment method + that genuinely can't be refunded looked like nothing happened at all, no error, no toast. Real, + pre-existing Filament/Lunar bug, invisible until this release's `TransactionDriverAdapter` made + an honest failure (rather than a hard crash or a silently-faked success) actually reachable. + Fixed via new `Modules\Core\Order\Filament\Extensions\OrderRefundActionsExtension`/ + `OrderItemsTableExtension`, which wrap the affected actions' closures to send the queued failure + notification themselves before re-throwing `Halt`. +- `TransactionDriverAdapter::refund()`/`capture()` never included `order_id` in the `$context` + passed to the driver, so `Order\Listeners\RecordPaymentTransaction`/`ApplyResolvedPaymentStatus` + (both requiring `$context['order_id']`) silently no-op'd for every admin-initiated refund/capture + through any driver — no audit `Transaction` row was ever created, regardless of whether the + refund/capture itself succeeded. Fixed by passing `$transaction->order_id` through. + +## [0.14.0] - 2026-09-03 + +### Changed + +- **Breaking:** `Modules\Core\Catalog\Services\ProductSearchService::search()` now returns `Modules\Core\Catalog\DTOs\ProductListingResult` — the exact same shape `ProductService::list()` already returns — instead of a bare `Illuminate\Database\Eloquent\Collection` of hydrated models with no pagination at all. New signature: `search(string $query, ?ProductFilters $filters = null, ?ProductSort $sort = null, int $perPage = 24, int $page = 1): ProductListingResult`. `->products` is a real `LengthAwarePaginator` of plain, localized indexed-document arrays (not Eloquent models, not Scout's raw response) — a search results page and a category listing page are now interchangeable from a controller's perspective: same DTO, same `ProductCard::fromIndexed()` mapping, same pagination/sort/tag/price-slider handling. `->priceBounds`/`->availableTags` are scoped to the search query itself (delegated to `ProductService::priceSliderBounds()`/`availableTags()`, both of which already accepted a `$query` param for this). +- `Modules\Core\Catalog\Services\ProductService::availableTags()` is now `public` (was `private`) and takes an optional `$query` parameter, so `ProductSearchService::search()` can reuse it directly instead of reimplementing the same facet call. + +### Added + +- `Modules\Core\Catalog\Support\ProductDocumentLocalizer` — the per-locale field resolution and raw-Meilisearch-response unwrapping (`withLocalizedFields()`, `hitsFrom()`) extracted out of `ProductService` into its own class, since `ProductSearchService` needed the exact same logic against the exact same kind of document. Both services now depend on this one class instead of `ProductService` owning logic a second service also needed. + +## [0.13.0] - 2026-09-03 + +### Changed + +- **Breaking:** `Payment` is now a genuinely standalone module — no direct calls into `Checkout`/`Order`, no reaching into their Eloquent models, communication only via events. The entire old `confirm()`-based flow is gone: `Modules\Core\Payment\Contracts\PaymentDriver` (and the already-stale `Modules\Core\Checkout\Contracts\PaymentDriver` duplicate), `Checkout\Events\PaymentConfirmed`, `Payment\Contracts\InitiatesPayment`, `Payment\DataTransferObjects\PaymentInitiation`, `Payment\Enums\PaymentInitiationMode`, `Payment\Events\PaymentSucceeded`/`PaymentFailed`, `Payment\Events\OrderPaymentStatusResolved`, and `Payment\Exceptions\PaymentNotConfirmedException` are all deleted. This flow was non-functional on `master` before this release — `CheckoutService::confirmPayment()` dispatched an event nothing listened for, so no order was ever placed after payment. +- **Breaking:** Every payment operation is now its own explicit, opt-in contract, modeled on how real gateways (Stripe, Mastercard's own gateway, Nexi) actually split these operations — see `docs/payments.md`: `Modules\Core\Payment\Contracts\SupportsPay` (atomic authorize+capture), `SupportsAuthorization` (hold only), `SupportsCaptures` (settle a prior hold), `SupportsVoids` (release a prior hold without settling), `SupportsRefunds` (reverse settled funds), `HandlesPaymentCallback` (resolve an async pay()/authorize() later, from a webhook), and `Configurable` (`isConfigured()`, split out of the old single `PaymentDriver` interface). A driver implements only the operations its gateway actually supports. +- **Breaking:** Every amount flowing through these contracts is `Lunar\DataTypes\Price` (Lunar's own bundled minor-unit-value + `Currency` type) — never a bare `int` paired separately with a `Currency`. Each driver converts at its own boundary (e.g. `StripeManager::toStripeAmount()`/`fromStripeAmount()`); `Payment` itself only ever speaks Lunar's `Price`. +- **Breaking:** `Modules\Core\Checkout\Services\CheckoutService::placeOrder()` and `confirmPayment()` are both replaced by a single `initiatePayment(string $fingerprint, array $data = []): Modules\Core\Payment\DTOs\PaymentResult`. It creates the draft `Order` (`Cart::createOrder()`, idempotent against an existing draft) and hands off directly to the resolved driver's `pay()`/`authorize()`, per that type's new `config('lunar.payments.types.{type}.capture_mode')` key. `Checkout\Events\OrderPlaced` no longer dispatches from `CheckoutService` — it now fires from `Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus` once a `PaymentCaptured`/`PaymentAuthorized` event actually transitions the order's `placed_at`, since a draft order can now exist well before payment resolves (an async gateway). +- `Modules\Core\Payment\Services\PaymentDriverResolver::resolve()` now returns `?object` instead of the deleted `PaymentDriver` interface — a driver implements several independent capability interfaces at once, so a caller does its own `instanceof SupportsPay`/`instanceof SupportsAuthorization` check, the same pattern the capability interfaces themselves are designed around. +- `config/payment.php`'s `cash-on-delivery` entry gains `capture_mode` (`'pay'`, since `OfflinePaymentDriver` only implements `SupportsPay`) and `captured_status` (`'payment-offline'`, replacing the previously dead `'authorized' => 'awaiting-payment'` key, which nothing ever read). + +### Added + +- `Modules\Core\Payment\DTOs\PaymentResult` — the one return shape every operation (`pay`, `authorize`, `capture`, `void`, `refund`, `handleCallback`) produces, regardless of gateway: `status` (`Modules\Core\Payment\Enums\PaymentResultStatus`: `Succeeded`/`Failed`/`Pending`), `reference`, `amount` (a `Price`), `failureReason`, `retriable` (real on Stripe/Mastercard's own soft-decline classification, always `false` on Nexi — it has no such signal), `raw` (the untouched gateway response, for audit), `meta`, and `continuation` (see below). +- `Modules\Core\Payment\DTOs\PaymentContinuation` / `Modules\Core\Payment\Enums\PaymentContinuationType` — what a caller does next with a `Pending` `PaymentResult`, gateway-agnostically (`Redirect` or `ClientSecret`), so a storefront controller never needs gateway-specific knowledge of e.g. Stripe's own `PaymentIntent` fields to drive a 3-D Secure/redirect continuation. +- Eight new events, one terminal pair per operation, replacing the old single `PaymentSucceeded`/`PaymentFailed`: `PaymentAuthorized`/`PaymentAuthorizationFailed`, `PaymentCaptured`/`PaymentCaptureFailed`, `PaymentVoided`/`PaymentVoidFailed`, `PaymentRefunded`/`PaymentRefundFailed`. `PaymentCaptured` is deliberately the same event whether money was taken via `pay()` (one gateway call) or `authorize()`→`capture()` (two calls) — "a payment has been captured" is the same business fact either way. Every event carries `{type, result: PaymentResult, context}` — `context` is an opaque bag the caller hands in and gets back untouched, so `Payment` never needs to know what a `Cart` or `Order` is. +- `Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus` (rewired, not new — previously listened to the now-deleted `OrderPaymentStatusResolved`) is the only place an `Order`'s `status` column is written in reaction to a payment outcome: it listens to `PaymentCaptured`/`PaymentAuthorized` directly, reads `$event->context['order_id']`, and resolves the new status from `config('lunar.payments.types.{type}.captured_status')`/`authorized_status`. +- `Modules\Core\Payment\Drivers\StripePaymentDriver` rewritten onto the new contracts — implements all six capability interfaces plus `Configurable`. Solves `handleCallback()`'s async-correlation problem (a webhook is a separate HTTP request from the `pay()`/`authorize()` call that started it) the same way `lunarphp/stripe`'s own `StripePaymentType`/`ProcessStripeWebhook` do: real `cart_id`/`order_id` columns on `Lunar\Stripe\Models\StripePaymentIntent`, plus two new columns this driver needs (`context`, `payment_type`) added by a new migration — `database/migrations/2026_09_03_000002_add_context_to_stripe_payment_intents.php`. +- `Modules\Core\Payment\Http\Controllers\StripeWebhookController` + `src/Payment/routes/webhooks.php` (`POST /payments/stripe/webhook`, loaded by `PaymentServiceProvider`) — a boboko-owned webhook endpoint, deliberately not `lunarphp/stripe`'s own route (which dispatches into Lunar's own `Payments::driver('stripe')` flow, the flow this driver replaces). Reuses `Lunar\Stripe\Http\Middleware\StripeWebhookMiddleware` and `Stripe\Webhook::constructEvent()` directly — both are genuine Stripe SDK signature verification, safe to reuse without touching the rest of that vendor package's flow. Requires `config('services.stripe.webhooks.lunar')` set in a consuming app; no `stripe` config type entry is added to `config/payment.php` in this release — enabling Stripe for real is a follow-up. +- `docs/payments.md` — full design notes: the operation/contract table cross-referenced against Mastercard/Stripe/Nexi's real APIs, why `PaymentResult` normalizes only what every gateway can always provide, the async-correlation pattern, and what's explicitly out of scope (a `Transaction`-writing listener, the `stripe` config entry, frontend Stripe Elements integration). + +### Fixed + +- `Modules\Core\Checkout\Services\CheckoutService::selectPaymentMethod()` crashed (`Call to a member function toArray() on null`) the first time it ran against a cart whose `meta` column was still a genuine SQL `NULL` (any freshly-created cart) — `Cart::$meta`'s `AsArrayObject` cast returns `null`, not an empty array-like object, for a `null` column. Fixed with a null-safe fallback. +- `Modules\Core\Shipping\Carriers\Acs\AcsRateDriver`/`BoxNowRateDriver` referenced `Lunar\Shipping\DTOs\ShippingOptionRequest`, a namespace that doesn't exist in the installed `lunarphp/table-rate-shipping` version (the real class is `Lunar\Shipping\DataTransferObjects\ShippingOptionRequest`) — crashed `Illuminate\Support\Manager`'s interface-compatibility check the moment anything touched `ShippingManager::getSupportedDrivers()`, including simply adding a line to a cart (via `Modules\Core\Shipping\Listeners\FlushLivePricingCache`). + +## [0.13.1] - 2026-09-03 + +### Added + +- `Modules\Core\Order\Listeners\RecordPaymentTransaction` — writes the `lunar_transactions` row for a successful `PaymentCaptured`/`PaymentAuthorized`/`PaymentVoided`/`PaymentRefunded` event, via a new `Modules\Core\Order\Services\TransactionRecorder` (moved here from `Payment\Services`, and rewritten to take a `PaymentResult` directly instead of the deleted `CaptureResult`/`RefundResult` DTOs — `Payment` never writes to `Order`'s models, `Transaction.order_id` being required is exactly why this lives in `Order`, same reasoning as `ApplyResolvedPaymentStatus`). Closes a real gap introduced in `0.13.0`: `Order::paymentStatus()` (which derives its answer entirely from `$order->transactions`) always resolved to `PaymentStatus::Offline` — its "no transactions at all" fallback — regardless of what actually happened, since nothing had ever written a row. Verified live: a captured offline payment now produces a `type: capture` transaction and `Order::paymentStatus()` correctly resolves to `captured`. + +## [0.12.1] - 2026-09-03 + +### Fixed + +- `Modules\Core\MigrateImport\Shopify\ShopifyExportImporter` now attaches a variant's `Variant Image` CSV column to that `ProductVariant`'s own `images()` media pivot (`media_product_variant`, `primary`/`position`). Previously the variant image was never read at all — every image from the CSV, including ones the export clearly scopes to one specific variant, went only into the product's own top-level gallery, so a variant swatch/option change had no way to show its own photo. +- `Modules\Core\MigrateImport\Shopify\Resolvers\ProductOptionResolver::resolveOption()` now sets `label` (same value as `name`) when creating a `Lunar\Models\ProductOption`, not just `name`. A `ProductOption` with a null `label` crashes Lunar's own `ProductOptionIndexer::toSearchableArray()` (`foreach()` on `null`) the moment that option gets reindexed — every option created by the importer before this fix has a null `label` and needs a wipe-and-reimport (see `docs/shopify-reimport.md`, new in this release) to pick up the fix, since `firstOrCreate()` never revisits an already-existing row. +- `product_reviews.product_id`'s foreign key had no `ON DELETE` clause, so deleting a reviewed `Product` threw a constraint violation instead of the review going with it, unlike every other product-dependent table. New migration adds `cascadeOnDelete()`. + +### Added + +- `Modules\Core\Catalog\Services\ProductIndexer::mapVariant()` now embeds `gtin`, `mpn`, `ean`, `backorder`, `unit_quantity`, `shippable`, `tax_ref`, and `dimensions` (length/width/height/weight/volume, each with `value`+`unit`) on every indexed variant — previously only `id`/`sku`/`stock`/`purchasable`/`options`/`prices`/`media` were embedded, so a search result or filter needing any of these had no way to get at them without a separate Postgres query per variant. +- `ProductIndexer::toSearchableArray()` adds a top-level, filterable `skus` field (every variant's SKU, deduplicated) — filtering/matching by SKU no longer requires reaching into the nested `variants` array. +- `docs/shopify-reimport.md` — runbook for wiping every imported product (cascading through Lunar so Meilisearch documents go too) and re-running the importer from scratch, needed whenever a fix like the two above only takes effect on newly-created rows. + +## [0.12.0] - 2026-09-03 + +### Changed + +- **Breaking:** `Modules\Core\Catalog\Services\ProductService::list()` now returns `Modules\Core\Catalog\DTOs\ProductListingResult` (`->products`: the same `Illuminate\Pagination\LengthAwarePaginator` as before, `->priceBounds`: a new `Modules\Core\Catalog\DTOs\PriceSliderBounds`) instead of returning the paginator directly. A caller doing `$service->list(...)->items()`/`->through(...)` must update to `$service->list(...)->products->items()`/`->through(...)`. This collapses what used to be two separate calls a controller had to orchestrate itself (`list()` for products, `priceRange()` + manual floor/ceil/"is this actually filtered" math for the slider) into one. +- **Breaking:** `Modules\Core\Catalog\Services\ProductSearchService::search()`'s signature changed from `search(string $query, ?string $locale = null)` to `search(string $query, ?ProductFilters $filters = null, ?ProductSort $sort = null)` — the `$locale` parameter is gone (see "every configured language, always" below); `$filters`/`$sort` apply the same `Modules\Core\Catalog\Support\ProductFilterBuilder`/`ProductSort::toMeilisearchSort()` semantics `ProductService::list()` already used, so a text search can now be narrowed by price/brand/stock and sorted the same way a category listing can. +- `ProductSearchService` now targets every configured store language's fields on every search (`Lunar\Models\Language::all()`), not just the current request locale plus the store's default language. The old `{current, default}` pairing silently stopped catching anything outside those two locales whenever they were equal (a single-language store, or a shopper browsing in the default language) — always searching every configured language closes that gap in both directions. See `docs/product-search.md`. +- Extracted `Modules\Core\Catalog\Services\ProductService`'s private `buildFilter()` into a new standalone `Modules\Core\Catalog\Support\ProductFilterBuilder`, so `ProductSearchService` can apply the exact same Meilisearch filter-clause semantics to a text query, instead of reimplementing filter-building a second time. + +### Added + +- `Modules\Core\Catalog\Services\ProductService::priceSliderBounds()` — `priceRange()` rounded to whole currency units (floor/ceil) plus whether the given selected min/max actually narrows it, returned as a `PriceSliderBounds` DTO. Used internally by `list()` now; also callable directly for a caller (e.g. a text-search results page) that needs slider bounds without a full `list()` call. +- `Modules\Core\Catalog\Services\ProductService::priceRange()` gained an optional `string $query = ''` parameter, so a caller can scope the price range to a text search's own matches (pass the shopper's search text) instead of always spanning the whole catalog. +- `Modules\Core\Catalog\Services\ProductService::random(int $limit)` — random products still scoped to the Meilisearch index's own channel/status visibility, unlike a raw `Product::inRandomOrder()` (which has no notion of that filtering). Meilisearch has no `ORDER BY RANDOM()` equivalent, so this fetches every matching id only (`attributesToRetrieve: ['id']`), shuffles in PHP, then fetches the full localized documents for just the ids picked, restoring the shuffled order afterward (Meilisearch's `id IN [...]` filter doesn't preserve list order on its own). +- `Modules\Core\Catalog\Services\ProductService::variantSummaries(array $product)` — the id/price/image of every variant on a product document, for a variant picker/swatch list, without a caller reaching into `$product['variants'][n]['prices'][0]`/`['media'][0]` itself. +- `Modules\Core\Catalog\Services\ProductSearchService::search()` now also targets `variants.options.value` — a variant's own option value (e.g. "Κάπτεν Γαμέρικα" on a "Name" option) is matchable by search even when that text never appears in the product's own name or description. +- `php artisan lunar:meilisearch:tune-product-search` (`Modules\Core\Command\TuneProductSearchCommand`) — tightens `minWordSizeForTypos` (1 typo only at 8+ characters, 2 typos only at 12+) and disables Meilisearch's `prefixSearch` on the product index. Meilisearch's defaults for both were loose enough to produce bad matches on short Greek words (confirmed the specific case was `prefixSearch`'s default `indexingTime` behavior on a shared word-start, not typo tolerance, via `showMatchesPosition`). Consuming apps should run this after `lunar:meilisearch:setup` whenever the product index needs (re)provisioning — **requires Meilisearch v1.12+** (`prefixSearch` didn't exist as a configurable setting before then). + +## [0.11.1] - 2026-09-01 + +### Fixed + +- `Modules\Core\Catalog\Services\RecommendationService::recommend()` built its result with the base `Illuminate\Support\Collection` (`collect()`) instead of `Illuminate\Database\Eloquent\Collection`, even though every element is a `Product` model. `ProductIndexer::toSearchableArray()` calling `->load(['media', 'variants.prices'])` on that result threw `BadMethodCallException: Method Illuminate\Support\Collection::load does not exist` — silently failing every `MakeSearchable` queue job for a saved product (visible only as `FAIL` in the queue log, with the real exception in `storage/logs/laravel.log`). Fixed by having `RecommendationService` accumulate into a real `Eloquent\Collection` from the start. + +## [0.11.0] - 2026-09-01 + +### Added + +- `Modules\Core\Catalog\Services\RecommendationService` — computes "related products" for a given product as a configurable, ordered chain of strategies (`config('catalog.recommendation_rules')`), not one hardcoded rule. Tops up from each successive rule until the limit (default 4) is reached or every rule is exhausted — e.g. 3 products from a same-category rule plus 1 from a random fallback — deduplicated across rules so the same product is never returned twice. Ships with `Modules\Core\Catalog\Recommendations\SameCategoryRule` (other products sharing the source product's first collection) and `RandomRule` (the universal fallback, placed last in the default chain). A new rule is just a class implementing `Modules\Core\Catalog\Contracts\RecommendationRule`. Documented in `docs/product-recommendations.md`. +- `Modules\Core\Catalog\Services\ProductIndexer` embeds the result directly into each product's own Meilisearch document as `recommendations: [{id, name, price, image}, ...]` (`recommendations.id` filterable) — a product detail page renders its "related products" section with zero extra queries, same reasoning as the existing `collections` field. Deliberately embeds an `id` for the view to build a locale-correct URL from, not a resolved `href` — `product.show` is locale-prefixed, so a URL baked in at index time would only be correct for whichever locale happened to be active during that index run. +- `Modules\Core\Catalog\Events\ProductSaved`/`ProductDeleted`, dispatched from `Product::saved()`/`Product::deleted()` in `CatalogServiceProvider` (the latter fires for both a soft delete and a force delete, matching Scout's own `unsearchable()` trigger point) — feed `Modules\Core\Catalog\Listeners\ReindexProductsRecommendingProduct`, which reverse-searches Meilisearch for every product currently recommending the changed/deleted one (`recommendations.id = "..."` — there's no Postgres relation for this, a recommendation only exists inside the index) and re-indexes them via Scout's own `->searchable()`. Product creation is deliberately not hooked into this: a new product not yet appearing as a recommendation elsewhere is an accepted staleness window, the same tradeoff already documented for `in_stock`/`price` — see `docs/product-recommendations.md`. +- `CatalogServiceProvider` schedules `lunar:search:index "Lunar\Models\Product" --refresh` daily at 03:00 — a safety net on top of the event-driven reindexing above, covering a newly-created product not yet appearing as a recommendation and any other drift already accepted between reindexes. `--refresh` also re-syncs filterable/sortable index settings, not just documents. + +## [0.10.1] - 2026-09-01 + +### Added + +- `Modules\Core\Localization\Services\StorefrontLabels::all()` gains three keys found missing from `3dealer`'s actual `storefront.*` translation usage: `shop.price_min`, `shop.price_max`, `shop.reset` (the price-filter sidebar's min/max labels and its reset link). Picked up by `InstallLunarCommand`'s existing per-key upsert — re-running `lunar:install` on an already-installed store adds only these three rows, leaving everything already seeded or admin-edited untouched. + +## [0.10.0] - 2026-08-31 + +### Changed + +- **Breaking:** Upgraded `lunarphp/lunar`, `lunarphp/core`, `lunarphp/stripe`, `lunarphp/table-rate-shipping`, and `lunarphp/search` to `1.5.0`, and `filament/filament` to `v4.12.6` — the first Filament v4 admin panel on this codebase. `lunarphp/filament3-2fa` and `kalnoy/nestedset` are gone, replaced by Filament v4's native two-factor auth and `lunarphp/nestedset`. Ran Filament's automated `filament-v4` migration tool across `src/`, then hand-fixed three bugs it introduced or left behind: a stale `$infolist` variable reference in `CartResource`'s `ViewCart` page (the parameter had been renamed to `$schema` but the body wasn't updated), `ShippingMethodResourceExtension` rewritten to call `getDefaultChildComponents()` (returns `array|Schema`) instead of the type-safe `getChildComponents()` (always `array`), and — unrelated to the tool, but surfaced by the same PHP version bump — `InvalidCouponException`'s `readonly $code` property illegally shadowing the built-in `Exception::$code`, renamed to `$couponCode`. `LunarStaff::addActivitylogExcept()` updated for the renamed `two_factor_secret`/`two_factor_recovery_codes` staff columns (now `app_authentication_secret`/`app_authentication_recovery_codes`; `two_factor_confirmed_at` removed). Consuming apps must run `composer update boboko/core --with-all-dependencies` and `php artisan migrate`. + +### Added + +- `Modules\Core\Checkout\Contracts\PaymentDriver` — the abstraction every payment provider implements: `confirm(Cart $cart, string $type, string $fingerprint, array $data): Order` and `isConfigured(): bool`. A driver only ever calls `CheckoutService::placeOrder()` once it has, by whatever mechanism is native to that gateway, independently confirmed payment — never Lunar's raw `Cart::createOrder()`. This is what lets the storefront checkout sequence stay uniform regardless of which provider is active: set addresses, select shipping, hand off to whichever driver is configured, and the driver decides when (or whether) the order gets created. +- `Modules\Core\Payment\Drivers\OfflinePaymentDriver` — shared by every payment type with no real gateway to confirm against (`cash-in-hand`, `cash-on-delivery`): places the order immediately via `CheckoutService::placeOrder()`, then sets the order status from `config("lunar.payments.types.{$type}.authorized")` using the type actually confirmed, not a hardcoded key, since one driver instance serves multiple types. +- `Modules\Core\Payment\Drivers\StripePaymentDriver` — a fork, not a decoration, of `lunarphp/stripe`'s `StripePaymentType::authorize()`: that method is `final` and calls `Cart::createOrder()` directly with no seam to redirect into our fingerprint-checked `placeOrder()`, so this class reimplements its logic (intent retrieval, capture-on-policy, status mapping via `UpdateOrderFromIntent`) with that one substitution. Throws the new `Modules\Core\Payment\Exceptions\PaymentNotConfirmedException` on anything short of a genuinely confirmed payment intent — never falls through to placing an order on ambiguity. +- `CheckoutService::getPaymentMethods(): array` — every payment type currently offered to the storefront: every key in `config('lunar.payments.types')` that is both administratively enabled (`Modules\Core\Payment\Models\PaymentMethod::enabled`) and whose driver reports `isConfigured()` (e.g. Stripe with no API key set is never offered, regardless of the enabled toggle). `selectPaymentMethod(string $type)` and `confirmPayment(string $type, array $data)` both validate against this list, throwing the new `UnknownPaymentTypeException` for a type that isn't currently offered — re-checked in `confirmPayment()` too, since a type could be disabled between selection and confirmation. +- `CheckoutService::selectPaymentMethod()` snapshots `Cart::fingerprint()` into `cart->meta['checkout_fingerprint']` _after_ saving the chosen type and recalculating — the fingerprint has to reflect the final total including any payment-type-specific adjustment (e.g. a COD surcharge), which only exists once `payment_method` is set. `confirmPayment()` reads this stored fingerprint internally rather than taking one as a parameter: a storefront should never need to know `Cart::fingerprint()` exists or capture it at exactly the right moment itself. +- `Modules\Core\Payment\Models\PaymentMethod` — one DB row per payment type key (matching `config('lunar.payments.types')`), `enabled` boolean plus a `data` jsonb column (starting with `fee`, the flat cash-on-delivery surcharge) — mirrors Lunar's own `Discount` model (a single jsonb column of keyed settings, not a fixed column per setting or a separate conditions table). Seeded idempotently by `InstallLunarCommand` (skip-if-exists per type, safe to re-run after installing a new payment-provider package), always `enabled: false` — a newly-seeded type shouldn't go live for shoppers before staff have configured and reviewed it. Admin-editable via the new `PaymentMethodResource` (inline enabled toggle, modal fee editor) under Settings. +- `ApplyCashOnDeliveryFee` now reads its surcharge from `PaymentMethod` instead of static config, so it's admin-editable without a deploy. + +### Fixed + +- `CashOnDeliveryPaymentDriver` renamed to `OfflinePaymentDriver` and generalized to work for any offline-style type — it previously hardcoded `'cash-on-delivery'` when reading the post-placement order status from config, which would have silently read the wrong type's status the moment a second offline type (`cash-in-hand`) used it. + +## [0.9.0] - 2026-08-29 + +### Added + +- `Modules\Core\Cart\Services\CartService` — the boboko-owned API for all cart mutation, wrapping Lunar's `CartSession`/`Cart` primitives: `addLine()`, `updateLine()`, `removeLine()`, `clear()`, `applyCoupon()`/`removeCoupon()` (throws `InvalidCouponException` on an invalid code), and save-for-later (`saveForLater()`/`moveToCart()`/`activeLines()`/`savedLines()`, backed by a `meta.saved_for_later` flag and a new `Modules\Core\Cart\Pipelines\ZeroSavedForLaterPrice` cart-line pipeline step that zeroes a saved line's price so it's excluded from cart totals without being removed). Dispatches 8 real domain events (`CartLineAdded`/`Updated`/`Removed`/`Saved`/`MovedToCart`, `CartCleared`, `CartCouponApplied`/`Removed`) — none have a listener yet, built so a future concern (analytics, recovery) has something to attach to. Documented in `docs/cart.md`. +- `Modules\Core\Checkout\Services\CheckoutService` — the boboko-owned API for the checkout stage (address → shipping selection → order placement), sitting between `CartService` and `Order`: `setShippingAddress()`/`setBillingAddress()`, `getShippingOptions()`/`selectShippingOption()` (throws the new `InvalidShippingOptionException` on an identifier that doesn't resolve — previously a silent no-op), and `placeOrder(string $fingerprint)` (the fingerprint is mandatory, not optional — forces re-confirmation via Lunar's own `FingerprintMismatchException` if the cart changed since the shopper last saw its total). Dispatches `ShippingAddressSet`/`BillingAddressSet`/`ShippingOptionSelected`/`OrderPlaced`, each carrying richer, already-resolved payload (e.g. the resolved `ShippingOption`, not just its identifier) than `CartService`'s events. No exception wrapping otherwise — Lunar's own `CartException`/`FingerprintMismatchException` are already the right shape for a storefront to render as form errors. Documented in `docs/checkout.md`. +- `Modules\Core\Cart\Filament\Resources\CartResource`'s list view now classifies every cart into one of four states — **Ongoing**, **Abandoned Cart**, **Abandoned Checkout**, **Completed** — instead of the previous two-tab Abandoned/Completed split, distinguishing a cart that never reached checkout from one that has a started-but-unplaced order (mirrors the real distinction in Lunar's own `Cart::scopeActive()`). Abandonment threshold is a fixed, configurable cutoff (`config('core.cart.abandoned_after')`, default 1 hour). Added a customer hyperlink (list column + a "View Customer" header action on the view page, both pointing straight at `customers/{id}` via the plain `customer_id` column, no extra query via the `customer` relation). +- `Modules\Core\Cart\Commands\DetectAbandonedCarts` (`boboko:cart:detect-abandoned`, scheduled hourly) dispatches `Modules\Core\Recovery\Events\CartAbandoned`/`CheckoutAbandoned` for carts/checkouts past the abandonment cutoff — detection only, no persistence; a real tracking table is left for when `Recovery` is built as its own concern. Fixed a self-defeating bug from an earlier draft: marking a cart as notified by writing to it bumped `updated_at`, which immediately un-staled it for the next run's own cutoff check. +- Merged the `Shipping-Carriers` branch: live carrier rate quoting and fulfillment for **ACS Courier** and **Box Now** (`Modules\Core\Shipping\Carriers\{Acs,BoxNow}`) on top of `lunarphp/table-rate-shipping` — `AcsRateDriver`/`BoxNowRateDriver` (live + static price-break resolution), `AcsFulfillmentService`/`BoxNowFulfillmentService` (shipment creation, label printing, cancellation via the new `Modules\Core\Shipping\Contracts\CarrierFulfillmentInterface`, resolved per-carrier via contextual container binding), `Modules\Core\Shipping\Models\Shipment`/`ShipmentInfo`, `PollShipmentTrackingJob` (scheduled every 30 minutes), `ManagePickupManifests` (Filament page for carrier manifest batching), and an `OrderViewExtension` adding a "Create Shipment" header action to Lunar's order view. Carrier credentials are published config (`config/shippingCarriers/{acs,boxnow}.php`), never committed. +- `Modules\Core\Shipping\Concerns\CachesLivePricing` caches a live-priced carrier quote per `(rate, cart)` for 30 minutes — a real, billed API call that's otherwise re-run on every `getShippingOptions()`/`selectShippingOption()` call within the same checkout attempt. `Modules\Core\Shipping\Listeners\FlushLivePricingCache` invalidates it on the only two things that can change a quote: a cart line changing or the shipping address changing (deliberately **not** on order placement — the price the shopper was quoted must still be readable afterwards). Scoped generically to any `SupportsLivePricing` driver, not hardcoded to ACS. +- `AcsRateDriver::resolveLivePrice()` now falls back to the rate's own configured static price if the live ACS API call fails (previously: the shipping option silently disappeared from the list on any API error, including a brief outage). `ManageShippingRates` (our Filament subclass of the vendor rates page) now allows a static price to be configured and saved on a "live" rate specifically for this fallback — previously those fields were hidden and discarded on save for any live-priced rate. + +### Fixed + +- Fixed a crash (`Attempt to read property "price" on null`) opening/editing a live-priced shipping rate with no fallback price configured yet — the vendor `ManageShippingRates` page's `afterStateHydrated` callback for the price field had no null-guard for a rate with zero `basePrices`, which is now the routine case for an unconfigured live rate. +- Fixed the Filament admin panel's home URL (`/boboko/home`) incorrectly resolving to the Shipping module's `ManagePickupManifests` page instead of the Dashboard — Filament falls back to the first item of the first registered navigation group when no explicit `homeUrl()` is set, and `ManagePickupManifests` had no `navigationGroup`/`navigationSort` of its own. Fixed via explicit `navigationGroup = 'Sales'` / `navigationSort = 100`, placing it after Sales in the nav instead of first overall. + +## [0.8.0] - 2026-08-27 + +### Added + +- `Modules\Core\Cart\Filament\Resources\CartResource` gives staff read-only visibility into carts in the Filament admin panel — Lunar ships no cart admin view at all. Scoped to carts with a known `user_id`/`customer_id` (an anonymous guest cart carries no identity staff could act on); list table shows customer/user, line/item counts (via Filament's built-in `->counts()`/`->sum()`, no per-row queries), currency, and last activity. List page has only two tabs, **Abandoned** (default active) and **Completed** — no "All" tab, so the list never runs an unfiltered fetch over the whole table. They key off whether the cart has a **placed** order (`orders.placed_at IS NOT NULL`), not `Cart::completed_at` — that column is declared/cast on the model but never actually written anywhere in Lunar core, so it's not a real signal; "Abandoned" mirrors Lunar's own `Cart::scopeActive()`. `getNavigationBadge()` shows the abandoned-cart count in the sidebar via a single `COUNT(*)` query, no rows loaded. View page runs `$cart->calculate()` once so line/cart totals (plain public properties Lunar never persists) are populated, without paying that cost per row in the list. Documented in `docs/cart.md`. + +## [0.7.0] - 2026-08-27 + +### Added + +- `Modules\Core\Catalog\Services\CollectionService` provides category browsing/nav AND single-collection lookup from Meilisearch, mirroring `ProductService` exactly (`list()`, `getById()`, `getBySlug()`, same locale-resolution logic). `Modules\Core\Catalog\Services\CollectionIndexer` extends Lunar's own `Lunar\Search\CollectionIndexer` (which only carried `id`/`name`/`created_at`) to add `parent_id`, `_lft`/`_rgt` (nested-set tree position, filterable/sortable), `collection_group_id`, `slugs`, and `thumbnail`. `Modules\Core\Catalog\DTOs\CollectionFilters` supports `parentId` (children of a specific collection), `groupId`, and `rootOnly` (top-level collections, `parent_id IS NULL` — mutually exclusive with `parentId`). `Modules\Core\Catalog\Enums\CollectionSort` adds `Position` (`_lft:asc`, the recommended default for nav/tree UIs — matches admin arrangement order), `Name`, `Newest`. Must be registered in a consuming app's `config/lunar/search.php` (`Lunar\Models\Collection::class => CollectionIndexer::class`), same as `ProductIndexer`. Documented in `docs/collections.md`. +- `Modules\Core\Localization\Services\StorefrontLabels::all()` extracts the default storefront UI label list out of `InstallLunarCommand` into its own class, and adds every previously-missing key (`nav.contact`, `product.description`/`no_image`/`read_more`/`reviews`, `customer_reviews`, `pagination.*`, `review.*`, `shop.*`) that had already been seeded manually in some stores but was absent from the command's own list — bringing the code-side default back in sync with what a real store actually has. `InstallLunarCommand::seedStorefrontLabels()` now does a **per-key upsert** instead of an all-or-nothing "only seed if the group is empty" guard: a key already present in the database (including one an admin has since edited via the Filament **Language Lines** resource) is left untouched, and only missing keys are created via `TranslationService::create()`. This makes it safe to add new keys to `StorefrontLabels::all()` later and re-run `lunar:install` on an already-installed store without either silently skipping the new keys (the old guard's behavior) or reverting an admin's edits back to the hardcoded default. Documented in `docs/localization.md` ("Seeding"). +- `Modules\Core\Catalog\Services\CollectionIndexer` adds `ancestors` — `[{id, name}, ...]` ordered root-first (via the newly eager-loaded `ancestors` relation) — so a breadcrumb can render directly from `CollectionService::getById()`/`getBySlug()` with zero extra queries, and `product_count` — how many products are in a collection or any of its descendants, queried from the product Meilisearch index at collection-index time via the same `collection_ids` field `ProductFilters(collectionId:)` filters against. Documented in `docs/collections.md`, including the reindex-ordering gotcha (`product_count` needs the product index reindexed first). +- `Modules\Core\Catalog\Services\ProductIndexer` adds a filterable `in_stock` boolean — `true` if any variant currently passes `ProductVariant::canBeFulfilledAtQuantity(1)` (Lunar's own purchasability rule, not a naive `stock > 0` check). `Modules\Core\Catalog\DTOs\ProductFilters` gets a matching `inStockOnly` flag. Reflects stock as of the last reindex only — nothing currently reindexes a product when an order decrements its stock, since that's a cart/checkout concern this doesn't attempt to solve; see `docs/product-listing.md` ("Stock goes stale between orders"). +- `Modules\Core\Catalog\Services\ProductService::facets(string $field, ?ProductFilters $filters = null): array` returns Meilisearch facet value counts (e.g. `['Brand A' => 48, 'Brand B' => 135]`) for a discrete-value filterable field, scoped to the given filters. Uses Scout's plain `->options(['facets' => [...]])`, merged directly into the raw Meilisearch query the same way `filter`/`sort` already are — no adoption of Lunar's separate `SearchManager`/`Search` facade needed. `ProductService::priceRange(?ProductFilters $filters = null): array{min, max}` covers the numeric-field case `facets()` explicitly doesn't (`price` would otherwise return one "facet" per exact price) — backed by Meilisearch's `facetStats`, not `facetDistribution`. `priceRange()` always excludes `minPrice`/`maxPrice` from the filter it builds (via a new `$exclude` parameter on the private `buildFilter()`), so a price slider's own bounds don't shrink to whatever range is already selected on it; other filters (`collectionId`, `brand`, `inStockOnly`) still apply normally. Documented in `docs/product-listing.md`. + +### Changed + +- **Breaking:** Renamed the `Product` module to `Catalog`, flattened. Every class under `Modules\Core\Product\*` (`Contracts`, `DTOs`, `Enums`, `Services`, `Observers`, `Filament\Extensions`, `OptionTypes`) now lives under `Modules\Core\Catalog\*` at the same sub-path — e.g. `Modules\Core\Product\Services\ProductService` is now `Modules\Core\Catalog\Services\ProductService`, `Modules\Core\Product\DTOs\ProductFilters` is now `Modules\Core\Catalog\DTOs\ProductFilters`. Class names themselves are unchanged (still `ProductService`, `ProductIndexer`, `ProductFilters`, etc.) — only the namespace/folder moved, to make room for `Collection` as a sibling concern under the same `Catalog` umbrella rather than a disconnected top-level module. Consuming apps must update every `use Modules\Core\Product\...` import and any FQCN reference (`config/lunar/search.php`'s indexer registration, service provider bindings). +- **Breaking:** `Modules\Core\Providers\ProductServiceProvider` renamed to `Modules\Core\Providers\CatalogServiceProvider` (composer.json's provider list updated accordingly) — it now only wires `Catalog`-namespace classes (`ProductOptionTypeManager`, `ProductOptionReindexObserver`), so the name follows the same by-concern convention as `LocalizationServiceProvider`/`ReviewServiceProvider`. +- **Breaking:** `Modules\Core\Review`'s flat `Extensions/`/`Pages/` folders now nest under `Filament/`, matching the strict per-concern subfolder convention already applied to `Product`(now `Catalog`)/`Localization`. `Modules\Core\Review\Extensions\ProductResourceExtension` is now `Modules\Core\Review\Filament\Extensions\ProductResourceExtension`; `Modules\Core\Review\Pages\ManageProductReviews` is now `Modules\Core\Review\Filament\Pages\ManageProductReviews`. `Modules\Core\Review\Models\ProductReview` is unchanged. +- **Breaking:** `ProductFilters(collectionId: ...)` now matches a product in that collection **or any of its descendant collections**, not just direct assignment. Products in a Shopify-imported tree are typically attached only to leaf collections, so filtering strictly on direct assignment meant a parent/root category page (`CollectionFilters(rootOnly: true)`'s results, or any non-leaf collection) always returned zero products even though real products existed several levels down. `Modules\Core\Catalog\Services\ProductIndexer` adds a new filterable `collection_ids` field — every directly-assigned collection's id unioned with all of its ancestors' ids (via the newly eager-loaded `collections.ancestors`) — and `ProductService::buildFilter()` now filters `collectionId` against `collection_ids` instead of the old `collections.id`. The display-only `collections` field (`{id, name}`, direct assignments) is unchanged and no longer filterable. + +## [0.6.1] - 2026-08-27 + +### Added + +- `Modules\Core\Product\Contracts\ProductOptionTypeInterface` describes how a category of `Lunar\Models\ProductOption` (e.g. "Color", "Size") behaves — what structured data its values carry in their free-form `meta` jsonb column, and how an admin edits it via Filament — without introducing a new model. Registered via `Modules\Core\Product\Services\ProductOptionTypeManager::get()->register([...])` (a singleton registry, same shape as `Modules\Core\Notification\NotificationRegistry`) from a service provider's `boot()`. An admin then picks one per `ProductOption` from an "Option Type" dropdown on the option's own edit form (added by `Modules\Core\Product\Filament\Extensions\ProductOptionResourceExtension`), stored in `ProductOption::meta['option_type']` — deliberately not tied to the option's `handle`, since a shop's own handle naming shouldn't have to match a type's key. `Modules\Core\Product\Filament\Extensions\ValuesRelationManagerExtension` hooks Lunar's own `ValuesRelationManager` (both extensions via `LunarPanel::extensions()`, registered in `CorePlugin`) to append the resolved type's meta form fields to the stock "Values" tab — no fork of Lunar's classes needed. Ships a reference implementation, `Modules\Core\Product\OptionTypes\ColorOptionType`, registered automatically by the new `Modules\Core\Providers\ProductServiceProvider`. Documented in `docs/product-options.md`. +- `Modules\Core\Product\Services\ProductIndexer::mapVariant()` now includes each option's `handle` (alongside its translated name) in a variant's indexed `options[]` — previously only the translated `option`/`value` names and `meta` were indexed, with no stable, locale-independent identifier for which option a value belongs to. +- `Modules\Core\Product\Observers\ProductOptionReindexObserver`, wired in the new `Modules\Core\Providers\ProductServiceProvider`, keeps Meilisearch in sync when a `ProductOption` or `ProductOptionValue` is saved or deleted — e.g. picking an Option Type or editing a color's hex. `ProductIndexer::mapVariant()` embeds each option value's `meta` directly into a product's indexed document, but saving the option/value never fires the _product's_ own save events, so without this a changed hex would only reach the index on that product's next unrelated reindex. The observer resolves every `Lunar\Models\Product` whose variants use the changed option (or option value) via the `product_option_value_product_variant` pivot, and calls `->searchable()` on each. + +### Changed + +- **Breaking:** `Modules\Core\Product\Services\ProductIndexer`'s indexed `collections` field is now an array of `{id, name}` objects instead of two parallel arrays (`collections` as bare ID strings, `collection_names` as translated names joined only by array index). `collection_names` is removed. Filtering by collection now targets the nested field `collections.id` (Meilisearch supports filtering on nested object fields), not bare `collections` — `Modules\Core\Product\Services\ProductService::buildFilter()` updated accordingly; `ProductFilters(collectionId: ...)`'s public API is unchanged. Run `php artisan lunar:meilisearch:setup` then `lunar:search:index --refresh` after upgrading (see docs/product-listing.md "Gotchas"). +- **Breaking:** `ProductIndexer`'s indexed `review_count`/`average_rating` top-level keys are folded into the existing `reviews` key: `reviews` is now `{items, count, average_rating}` instead of a bare array with `review_count`/`average_rating` as separate sibling keys. `reviews` (the array of review items) moved to `reviews.items`. + +## [0.6.0] - 2026-08-27 + +### Added + +- `Modules\Core\Localization\Models\LanguageLine` extends `spatie/laravel-translation-loader`'s `LanguageLine` to fall back to the store's actual default language (`LanguageCache::defaultLocale()`, backed by Lunar's `languages.default` flag) instead of the package's stock behavior of falling back to the static `config('app.fallback_locale')` — the two were previously disconnected, so changing the default language via the Filament **Languages** resource had no effect on which locale an untranslated storefront label silently fell back to. Swapped in automatically via `config('translation-loader.model')` in `LocalizationServiceProvider::register()`; no consuming app changes needed. Documented in `docs/localization.md` ("Fallback locale follows the store's default language"). + +### Changed + +- **Breaking:** `Modules\Core\Catalog\ProductService::list()` now returns a real `Illuminate\Pagination\LengthAwarePaginator` (built from the localized Meilisearch hits) instead of a plain `array{data, meta}` — gives callers normal Laravel pagination behaviour (`$products->links()`, standard JSON serialization) without ever touching Scout's raw `paginateRaw()` response directly. `getById()`/`getBySlug()` are unaffected (still return `?array`). +- `ProductService::withLocalizedFields()` (used by `list()`, `getById()`, `getBySlug()`) no longer hardcodes `name`/`description` as the only translated fields — it now reads every `TranslatedText` attribute on `Product` from `Lunar\Base\AttributeManifest` (the same source Lunar's own indexer reads), so a store's own custom translated attributes (e.g. `seo_title`, `seo_description`) are resolved and locale-stripped automatically with no code change here. Raw `{handle}_{locale}` keys (e.g. `name_el`, `seo_title_en`) are now stripped from every returned product, not just `name_*`/`description_*`. +- Extracted `Modules\Core\Localization\Services\LanguageCache` (cached read layer over Lunar's `languages` table: `all()`, `defaultLocale()`, `availableLocales()`, `forget()`) out of `LocaleMiddleware`, which previously owned this as private/static methods despite not being middleware-specific behavior. `LocaleMiddleware` now takes `LanguageCache` via constructor injection. `LocaleMiddleware::defaultLocale()`/`forgetLanguagesCache()` (static) are removed — use `app(LanguageCache::class)` or inject `LanguageCache` directly. + +### Fixed + +- `Modules\Core\MigrateImport\JudgeMe\Resolvers\ProductResolver::resolve()` picked whichever `lunar_urls` row matched a slug first, which can be a soft-deleted product left behind by an earlier import batch rather than the current live one — a store can easily end up with more than one `Product` row sharing the same slug across re-imports, since a soft-deleted product's URL row isn't cleaned up. This silently broke every downstream lookup for that handle (e.g. `Modules\Core\MigrateImport\JudgeMe\JudgeMeExportImporter` logging "no product found for handle, skipping review" and dropping the row, even though a live product with that exact handle existed). Rewrote as a join against `lunar_products` — via `Product::query()`, so Eloquent's `SoftDeletes` global scope excludes trashed rows — so only a URL pointing at a live product resolves. +- `Modules\Core\Review\Models\ProductReview` had no `registerMediaConversions()` at all, unlike `Product`/`ProductVariant` which get one automatically from Lunar's own `Lunar\Base\StandardMediaDefinitions`. `Modules\Core\Search\ProductIndexer::mapMedia()` is shared across product, variant, and review media and always requests the `small` conversion — the first time a review had an attached image, indexing it threw `Spatie\MediaLibrary\MediaCollections\Exceptions\InvalidConversion`, silently failing the product's `MakeSearchable` queue job (and everything queued after it, since Scout batches). Added a matching `small` conversion (300×300, same fit/border/background as Lunar's standard one) directly on `ProductReview`. + +### Breaking + +- Merged `Modules\Core\Catalog` and `Modules\Core\Search` into a single `Modules\Core\Product` concern, since both existed purely to serve `Product` (browsing/filtering vs. indexing/full-text search — two services, one concern), following a stricter subfolder convention (`Contracts/`, `Enums/`, `Services/`, `DTOs/`, `Models/`, etc. per concern) going forward: + - `Modules\Core\Catalog\ProductService` → `Modules\Core\Product\Services\ProductService` + - `Modules\Core\Catalog\ProductFilters` → `Modules\Core\Product\DTOs\ProductFilters` + - `Modules\Core\Catalog\ProductSort` → `Modules\Core\Product\Enums\ProductSort` + - `Modules\Core\Search\ProductIndexer` → `Modules\Core\Product\Services\ProductIndexer` + - `Modules\Core\Search\ProductSearchService` → `Modules\Core\Product\Services\ProductSearchService` + + Consuming apps must update any direct references — notably `config/lunar/search.php`'s `'indexers'` map, which points at `ProductIndexer` by FQCN. `Modules\Core\Catalog\ProductOptionTypeInterface` (in-progress, not yet wired to anything) was deliberately left in place rather than moved. + +- Reorganized `Modules\Core\Localization` under the same stricter per-concern subfolder convention — `Events/`, `Filament/`, `Listeners/` were already correctly categorized; four loose root files moved into typed buckets by structural role: + - `Modules\Core\Localization\LocaleMiddleware` → `Modules\Core\Localization\Middleware\LocaleMiddleware` + - `Modules\Core\Localization\LanguageCacheObserver` → `Modules\Core\Localization\Observers\LanguageCacheObserver` + - `Modules\Core\Localization\TranslationReader` → `Modules\Core\Localization\Services\TranslationReader` + - `Modules\Core\Localization\TranslationService` → `Modules\Core\Localization\Services\TranslationService` + + `Modules\Core\Localization\Services\LanguageCache` (added earlier in this same unreleased version) already lived at its correct final path — unaffected. The `'locale'` route-middleware alias (registered in `LocalizationServiceProvider`) is unaffected for consuming apps using it by string alias rather than FQCN. + +## [0.5.4] - 2026-08-26 + +### Added + +- `Modules\Core\Catalog\ProductService::list()` accepts a `sort` parameter (new `ProductSort` enum: `PriceAsc`, `PriceDesc`, `Newest`), translated into a Meilisearch `sort` clause — `list()` previously had no way to order results, since it always searches with an empty query string and so has no relevance score to fall back on. `Modules\Core\Search\ProductIndexer::getSortableFields()` now also marks `price` sortable (Lunar's base indexer only marks `created_at`/`updated_at`/`skus`/`status`). Requires re-syncing index settings (`php artisan lunar:meilisearch:setup`) on existing stores. Documented in `docs/product-listing.md` ("Sorting"). + +## [0.5.3] - 2026-08-26 + +### Fixed + +- `Modules\Core\Search\ProductIndexer::toSearchableArray()` threw `column reference "id" is ambiguous` on Postgres when computing `channel_ids` — `$model->channels()->wherePivot('enabled', true)->pluck('id')` joins `lunar_channels` and `lunar_channelables`, both of which have an `id` column, and the unqualified `pluck('id')` left Postgres unable to resolve which table's column to select (SQLite/MySQL tolerated the ambiguity). Qualified as `pluck('lunar_channels.id')`. + +## [0.5.2] - 2026-08-26 + +### Fixed + +- `Modules\Core\Localization\LocaleMiddleware`'s shared view data only ever surfaced a single alternate locale (`altLocale`/`altLocaleUrl`, found via `firstWhere('code', '!=', $current)`) — correct by coincidence for a 2-language store, but silently dropped every locale past the first "other" one found for a 3+ language store, with no error. Replaced with `altLocales`, a collection of every other configured language (`code`, `name`, `url` for the current route each), so a language switcher or `hreflang` tags scale to any number of locales. Documented in `docs/localization.md` ("Shared view data — language switcher and `hreflang` tags"). + +## [0.5.1] - 2026-08-25 + +### Added + +- `Modules\Core\Search\ProductIndexer` now indexes `channel_ids` (filterable) — Lunar's base indexer only marks `status` as filterable, not channel assignment, so storefront search couldn't otherwise scope results to products actually assigned and enabled on the current sales channel. Computed from `$product->channels()->wherePivot('enabled', true)`. Ported from an older `Products` branch whose remote had been deleted; the branch's other, now-superseded `ProductIndexer` changes were dropped in favor of the richer indexer already on `master` (collections, price, variants, reviews — see `0.5.0`). + ## [0.5.0] - 2026-08-24 ### Added + - **`Modules\Core\Catalog\ProductService`**: storefront product listing/filtering (`list()`) and single-product lookup (`getById()`, `getBySlug()`), reading directly from the Meilisearch index rather than the database — one data source, no `->get()` model hydration. Returns plain arrays (not Eloquent models), meant to be called directly from a consuming app's controllers. - `ProductFilters` DTO: optional `collectionId`, `brand`, `minPrice`, `maxPrice`, translated into a Meilisearch `filter` expression. - Listing results are locale-aware: `withLocalizedFields()` resolves `name`/`description` from the indexer's per-locale fields, falling back to the store's default language (via `LocaleMiddleware::defaultLocale()`) when the current locale has no translation yet, instead of rendering blank. @@ -17,26 +920,29 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). - `docs/lunar.md` "Gotchas": three new entries hit while building this — `ProductOption`/`ProductOptionValue::name` isn't `attribute_data` (so `translateAttribute()` silently returns `null` for it), a running `queue:work` process not picking up an edited Scout indexer class, and Scout's `paginateRaw()->items()` on the Meilisearch driver returning the whole raw response rather than a hit list. ### Fixed + - The admin login form (`Modules\Core\Auth\Filament\Pages\Login`) had no way back from the OTP-entry step to the email step short of reloading the page. A `back()` method resets to the email step; a "← Back" link/button is shown on the OTP step only. ## [0.4.0] - 2026-08-06 ### Added + - **Locale-prefixed routing** (`Modules\Core\Localization\LocaleMiddleware`): a `locale` route-middleware alias, opt-in per shop (not pushed onto the `web` group globally, since admin/Livewire/webhook routes must not be locale-redirected). Reads the first URL segment against Lunar's own `languages` table, sets `App::setLocale()`, and redirects unprefixed/unknown-locale requests to a resolved locale (`Accept-Language` match → default language → first language). Every locale is prefixed, including the default (`/el/...`, `/en/...`), never a bare root — avoids the hreflang/duplicate-content ambiguity of a bare-root default locale. - Language list cached with `Cache::rememberForever()`, invalidated via `Modules\Core\Localization\LanguageCacheObserver` dispatching `LanguageCreated`/`LanguageUpdated`/`LanguageDeleted` events (see below) rather than doing the work itself. - **Language rename safety**: renaming a `Language::code` (e.g. `el` → `gr`) no longer strands existing translations. `MigrateTranslationsForRenamedLanguage` (listening on `LanguageUpdated`) migrates every affected `LanguageLine.text` key from the old code to the new one and flushes both codes' translation caches — closing a real data-loss gap where a rename would otherwise make existing `LanguageLine` translations permanently unreachable. -- **Storefront UI label translations**: pulled in `spatie/laravel-translation-loader` (self-registers via Composer package auto-discovery; its loader *extends* Laravel's file-based `FileLoader` and merges DB translations on top — existing Filament/Lunar vendor `lang/` strings are unaffected). Labels are looked up via Laravel's native `__('storefront.nav.cart')`, kept in its own `storefront` group so nothing collides with Lunar/Filament's own translation groups. +- **Storefront UI label translations**: pulled in `spatie/laravel-translation-loader` (self-registers via Composer package auto-discovery; its loader _extends_ Laravel's file-based `FileLoader` and merges DB translations on top — existing Filament/Lunar vendor `lang/` strings are unaffected). Labels are looked up via Laravel's native `__('storefront.nav.cart')`, kept in its own `storefront` group so nothing collides with Lunar/Filament's own translation groups. - `Modules\Core\Command\InstallLunarCommand` (overriding `lunar:install`) seeds a starter set of ~15 common e-shop labels (`nav.*`, `cart.*`, `product.*`, `auth.*`, `search.*`, English + Greek), idempotently guarded so it's safe on every boot. - `Modules\Core\Localization\TranslationReader::group('storefront')` returns the whole reduced/cached label array for a locale (backed by `LanguageLine`'s own forever-cache) — for sharing to a view as `$labels` or `@json()`-ing to JS, on top of `__()` for single-key Blade lookups. - **Admin UI**: `Modules\Core\Localization\Filament\Resources\LanguageLineResource` (registered in `CorePlugin`) lists/searches/filters `language_lines` and edits each row's `group`, `key`, and one text input per locale currently in `lunar_languages` — locale columns/inputs are generated dynamically from the language list, so a new language needs no resource changes. - **Event-driven writes**: `Modules\Core\Localization\TranslationService` (`create`/`update`/`delete`) is the single write path for `LanguageLine` — the Filament resource's Create/Edit/Delete pages route through it rather than Filament's default direct-model writes. Dispatches `TranslationCreated`/`TranslationUpdated` (carries the full pre-update `{group, key, text}` snapshot, so a bare rename is tracked the same as a text edit)/`TranslationDeleted`, each handled by two listeners: - - `FlushTranslationCache` — closes a real gap in `LanguageLine`'s own self-invalidation, which only flushes locales/groups present *after* a save. Flushes the union of old and new group+locale combinations, so a locale removed from `text`, or a `group`/`key` rename, can't leave a stale cached array behind. + - `FlushTranslationCache` — closes a real gap in `LanguageLine`'s own self-invalidation, which only flushes locales/groups present _after_ a save. Flushes the union of old and new group+locale combinations, so a locale removed from `text`, or a `group`/`key` rename, can't leave a stale cached array behind. - `LogTranslationActivity` — audits every write via the existing `Modules\Core\Logging\ActivityLogService` (`lunar` activity log channel), same `created`/`updated`/`deleted` shape as every other domain write in this project. Properties are flattened with `Arr::dot()` before logging (`text.en`, `text.el` instead of a nested `text` object) since Filament's Activity resource renders `properties` with a flat `KeyValue` field that can't display nested arrays. - `Modules\Core\Providers\LocalizationServiceProvider` — split out of the growing `CoreServiceProvider` (per this project's own "split when a provider does too much" convention) to own all locale/translation middleware, observer, and event-listener registration. ## [0.3.0] - 2026-07-12 ### Added + - **Meilisearch product search**: pulled in `lunarphp/search` (Lunar's driver-agnostic search abstraction — `database`/`meilisearch`/`typesense` engines, selectable via Scout's own `SCOUT_DRIVER` config) and `lunarphp/meilisearch`, wiring Meilisearch in as the search engine for products. - `Search\ProductIndexer` overrides Lunar's own indexer to strip HTML tags from string fields (e.g. `name_en`, `description_en`) before they reach the search index — Lunar's default indexer sends raw attribute HTML straight through, which pollutes relevance ranking and highlighting with markup. - Meilisearch itself is treated as app-level infrastructure, not a `boboko-core` concern: the actual Meilisearch container, host port, and master key live in each consuming app's own `docker-compose.yml`/`.env` (e.g. `3dealer`), the same way Postgres and Valkey do — `boboko-core` only declares the PHP package dependency and the indexing code. @@ -44,17 +950,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ## [0.2.0] - 2026-07-10 ### Added + - **Product reviews** (`Modules\Core\Review`): a new `ProductReview` model + `product_reviews` table (plain, unprefixed — same convention as `import_mappings`), linked to Lunar's `Product` via a `Product::reviews()` macro (registered in `CorePlugin`, since `Lunar\Models\Product` is a vendor model and can't be edited directly). - **JudgeMe CSV review importer** (`MigrateImport\JudgeMe\JudgeMeExportImporter`), wired into the existing `boboko:migrate:import --source=judgeme --type=export` command: reads a Judge.me review export, resolves each row's `product_handle` to a Lunar product via `Lunar\Models\Url`, and creates/updates `ProductReview` rows idempotently via `import_mappings` (`source=judgeme`, `source_type=review`, keyed on Judge.me's `metaobject_handle`). Rows with no matching product are skipped with a logged warning rather than failing the whole import. - Review images (`picture_urls` in the CSV) are downloaded and stored as real media via Spatie MediaLibrary (`ProductReview::IMAGES_COLLECTION`), not just linked by URL — consistent with how product images are handled. - **Admin UI**: a new "Reviews" sub-navigation page on the product edit screen (`Review\Pages\ManageProductReviews`, wired via `Review\Extensions\ProductResourceExtension`), listing rating/title/reviewer with View, Reply, and Delete actions. The Reply action lets staff write/edit a reply directly from the table, setting `replied_at`. The View modal shows full review detail (body, reviewer email, location, source, dates, reply, downloaded images). ### Fixed + - `Shopify\ShopifyExportImporter` never wrote a Lunar `Url` (slug) row for imported products, despite `docs/shopify-import.md` specifying it should — meaning no code outside the importer itself could resolve "which Lunar product has handle X" (only the importer's own private `import_mappings` bookkeeping could). It now creates/updates a default `Url` row (`slug` = Shopify handle) per product on every import, which the new JudgeMe review importer depends on for product resolution. ## [0.1.0] - 2026-07-09 ### Added + - **Shipping**: registered Lunar's `lunarphp/table-rate-shipping` plugin (`ShippingPlugin`) directly on `CorePlugin`, so table-rate shipping is available to every consumer app without per-app wiring. - **Product migration/import framework** (`Modules\Core\MigrateImport`): a source-agnostic pipeline for importing a vendor's product catalog into Lunar. - `boboko:migrate:import` Artisan command — interactively prompts for source, type (export/API), and credentials or file path, then dispatches the import as a queued job (`RunMigrateImportJob`) on the default queue. The file-path prompt resolves relative to `storage/app/private/imports/`, so answering e.g. `shopify` picks up the first CSV found in `imports/shopify/` automatically. @@ -69,6 +978,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). - `CONTRIBUTE.md` — local dev setup (path-repo + `bin/dc-core.sh`), and the manual DB-verification workflow used to build this feature. ### Fixed + - `ProductOptionResolver` created duplicate `ProductOption`/`ProductOptionValue` rows when the same option or value appeared with different casing across products (e.g. Shopify export rows using both "Size" and "size"), and could create a duplicate value within a single product's own variant rows due to relying on a stale lazy-loaded relation. Both now resolve by normalized (slugified) identity queried fresh from the database. - `boboko:migrate:import` could dispatch an import job with a blank file path (silent no-op failure) if the file-path prompt was answered empty; it now re-prompts until a valid, existing file is given. @@ -77,6 +987,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). First release. ### Added + - OTP-based authentication built around `User` instead of `Customer` (`UserOtpService`, `UserOtpMail`), replacing the earlier customer-scoped OTP flow. - `UserCreated` event with a `CreateCustomerForUser` listener to provision a Lunar customer automatically when a user is created. - `UserRelationManager` for managing users from the customer resource in the panel. @@ -87,7 +998,9 @@ First release. - `docs/modules.md` documenting module structure. ### Removed + - `CustomerOtpMail` and `CustomerOtpService`, superseded by the user-based OTP flow. ### Dependencies + - Added explicit `symfony/yaml` requirement (used directly by `Stoic::loadConfig()`). diff --git a/composer.json b/composer.json index 6d6b840..d871508 100644 --- a/composer.json +++ b/composer.json @@ -2,7 +2,7 @@ "name": "boboko/core", "description": "Core module — authentication and shared panel behaviour", "type": "library", - "version": "0.5.0", + "version": "0.18.0", "autoload": { "psr-4": { "Modules\\Core\\": "src/" @@ -10,14 +10,15 @@ }, "require": { "php": "^8.5", - "lunarphp/lunar": "1.3.0", + "lunarphp/lunar": "1.5.0", "laravel/framework": "^12.0", "laravel/tinker": "^3.0", "symfony/yaml": "^7.0", - "lunarphp/table-rate-shipping": "^1.3", + "lunarphp/table-rate-shipping": "1.5.0", "lunarphp/search": "*", "lunarphp/meilisearch": "*", - "spatie/laravel-translation-loader": "^2.8" + "spatie/laravel-translation-loader": "^2.8", + "stripe/stripe-php": "^16.6" }, "require-dev": { "fakerphp/faker": "^1.23", @@ -27,7 +28,8 @@ "mockery/mockery": "^1.6", "nunomaduro/collision": "^8.6", "pestphp/pest": "^4.6", - "pestphp/pest-plugin-laravel": "^4.1" + "pestphp/pest-plugin-laravel": "^4.1", + "filament/upgrade": "^4.0" }, "extra": { "laravel": { @@ -35,8 +37,14 @@ "Modules\\Core\\Providers\\CoreServiceProvider", "Modules\\Core\\Providers\\AuthServiceProvider", "Modules\\Core\\Providers\\CustomerServiceProvider", + "Modules\\Core\\Providers\\CheckoutServiceProvider", + "Modules\\Core\\Providers\\PaymentServiceProvider", "Modules\\Core\\Providers\\LocalizationServiceProvider", + "Modules\\Core\\Providers\\CatalogServiceProvider", + "Modules\\Core\\Providers\\CartServiceProvider", "Modules\\Core\\Providers\\ReviewServiceProvider", + "Modules\\Core\\Providers\\ShippingServiceProvider", + "Modules\\Core\\Providers\\OrderServiceProvider", "Modules\\Core\\Providers\\PrivacyServiceProvider" ] } diff --git a/config/catalog.php b/config/catalog.php new file mode 100644 index 0000000..14af9e4 --- /dev/null +++ b/config/catalog.php @@ -0,0 +1,25 @@ + [ + SameCategoryRule::class, + RandomRule::class, + ], +]; diff --git a/config/core.php b/config/core.php index 2c96443..bd901cb 100644 --- a/config/core.php +++ b/config/core.php @@ -45,4 +45,78 @@ return [ 'grace_period_days' => 30, ], + /* + |-------------------------------------------------------------------------- + | Cart Abandonment Threshold + |-------------------------------------------------------------------------- + | + | How long a cart (that hasn't converted to a placed order) can go without + | activity before Modules\Core\Cart\Filament\Resources\CartResource treats + | it as "Abandoned" rather than "Ongoing". Anything DateInterval::createFromDateString() + | accepts works, e.g. '1 hour', '30 minutes', '2 days'. + | + */ + + 'cart' => [ + 'abandoned_after' => '1 hour', + + /* + |---------------------------------------------------------------------- + | Unrecoverable Cap + |---------------------------------------------------------------------- + | + | Beyond this age, a stale cart stops being treated as an active + | "Abandoned Cart"/"Abandoned Checkout" (Modules\Core\Cart\Services\ + | CartLifecycleService) — too old to be a realistic recovery target + | (pricing/stock/tax likely stale by then). This is about the + | abandoned-cart pipeline only, not data retention — no rows are + | deleted or pruned based on this value. + | + */ + + 'unrecoverable_after' => '90 days', + ], + + /* + |-------------------------------------------------------------------------- + | Order Return Window + |-------------------------------------------------------------------------- + | + | How many days after a carrier order is delivered (Order::fulfillment_status + | becomes 'return_window_open') before Modules\Core\Order\Commands\ + | CloseExpiredReturnWindows auto-completes it, if no return was requested. + | Store-pickup orders have no return-window step and are unaffected by + | this value (see Modules\Core\Order\Listeners\CompleteOrderOnPickedUp). + | + */ + + 'order' => [ + 'return_window_days' => 14, + ], + + /* + |-------------------------------------------------------------------------- + | Storefront OTP Login + |-------------------------------------------------------------------------- + | + | Modules\Core\Auth\Services\UserOtpService's passwordless login. + | max_attempts caps how many wrong codes a shopper can guess against ONE + | generated code before it's invalidated outright. generation_limit/ + | generation_decay_minutes cap how often a NEW code can be requested for + | the same email — independent of max_attempts, since generating a fresh + | code also resets the guess count, so an attempt cap alone doesn't stop + | an attacker from just requesting a new code every few tries. This same + | limit is also what stands between a malicious/careless caller and + | mail-bombing one inbox. + | + */ + + 'auth' => [ + 'otp' => [ + 'max_attempts' => 5, + 'generation_limit' => 3, + 'generation_decay_minutes' => 10, + ], + ], + ]; diff --git a/config/legal.php b/config/legal.php new file mode 100644 index 0000000..fd37e39 --- /dev/null +++ b/config/legal.php @@ -0,0 +1,21 @@ + env('LEGAL_PRIVACY_POLICY_VERSION', '2026-01-01'), + + 'terms_version' => env('LEGAL_TERMS_VERSION', '2026-01-01'), +]; diff --git a/config/payment.php b/config/payment.php new file mode 100644 index 0000000..01e293c --- /dev/null +++ b/config/payment.php @@ -0,0 +1,28 @@ + [ + ApplyPaymentMethodFee::class, + ], +]; diff --git a/config/shippingCarriers/acs.php b/config/shippingCarriers/acs.php new file mode 100644 index 0000000..cea2928 --- /dev/null +++ b/config/shippingCarriers/acs.php @@ -0,0 +1,50 @@ + env('ACS_BASE_URL', 'https://webservices.acscourier.net/ACSRestServices/api/ACSAutoRest'), + + 'api_key' => env('ACS_API_KEY'), + + 'company_id' => env('ACS_COMPANY_ID'), + 'company_password' => env('ACS_COMPANY_PASSWORD'), + 'user_id' => env('ACS_USER_ID'), + 'user_password' => env('ACS_USER_PASSWORD'), + + 'billing_code' => env('ACS_BILLING_CODE'), + + 'sender' => [ + 'name' => env('ACS_SENDER_NAME'), + 'address' => env('ACS_SENDER_ADDRESS'), + 'zip_code' => env('ACS_SENDER_ZIP'), + 'phone' => env('ACS_SENDER_PHONE'), + ], + + 'timeout' => env('ACS_HTTP_TIMEOUT', 10), + +]; diff --git a/config/shippingCarriers/boxnow.php b/config/shippingCarriers/boxnow.php new file mode 100644 index 0000000..672b95f --- /dev/null +++ b/config/shippingCarriers/boxnow.php @@ -0,0 +1,47 @@ + env('BOXNOW_BASE_URL', 'https://api-production.boxnow.gr/api/v1'), + 'location_api_url' => env('BOXNOW_LOCATION_API_URL', 'https://locationapi-production.boxnow.gr/api/v1'), + + 'client_id' => env('BOXNOW_CLIENT_ID'), + 'client_secret' => env('BOXNOW_CLIENT_SECRET'), + + 'origin_location_id' => env('BOXNOW_ORIGIN_LOCATION_ID'), + + 'sender' => [ + 'name' => env('BOXNOW_SENDER_NAME'), + 'email' => env('BOXNOW_SENDER_EMAIL'), + 'phone' => env('BOXNOW_SENDER_PHONE'), + ], + + 'timeout' => env('BOXNOW_HTTP_TIMEOUT', 10), + +]; diff --git a/database/migrations/2026_07_16_000001_create_shipments_table.php b/database/migrations/2026_07_16_000001_create_shipments_table.php new file mode 100644 index 0000000..ffccb42 --- /dev/null +++ b/database/migrations/2026_07_16_000001_create_shipments_table.php @@ -0,0 +1,29 @@ +id(); + $table->foreignId('order_id')->constrained(config('lunar.database.table_prefix').'orders'); + $table->string('carrier'); + $table->string('tracking_reference')->unique(); + $table->string('parent_reference')->nullable(); + $table->timestamp('label_printed_at')->nullable(); + $table->string('manifest_reference')->nullable(); + $table->timestamp('cancelled_at')->nullable(); + $table->json('meta')->nullable(); + $table->timestamps(); + }); + } + + public function down(): void + { + Schema::dropIfExists('shipments'); + } +}; diff --git a/database/migrations/2026_07_21_000001_create_shipment_info_table.php b/database/migrations/2026_07_21_000001_create_shipment_info_table.php new file mode 100644 index 0000000..fbfe887 --- /dev/null +++ b/database/migrations/2026_07_21_000001_create_shipment_info_table.php @@ -0,0 +1,28 @@ +id(); + $table->foreignId('shipment_id')->constrained('shipments')->cascadeOnDelete(); + $table->string('status'); + $table->string('carrier_status')->nullable(); + $table->text('message')->nullable(); + $table->string('location')->nullable(); + $table->timestamp('occurred_at'); + $table->json('meta')->nullable(); + $table->timestamps(); + }); + } + + public function down(): void + { + Schema::dropIfExists('shipment_info'); + } +}; diff --git a/database/migrations/2026_08_31_000001_create_payment_methods_table.php b/database/migrations/2026_08_31_000001_create_payment_methods_table.php new file mode 100644 index 0000000..4ac80b7 --- /dev/null +++ b/database/migrations/2026_08_31_000001_create_payment_methods_table.php @@ -0,0 +1,24 @@ +id(); + $table->string('type')->unique(); + $table->boolean('enabled')->default(true); + $table->json('data')->nullable(); + $table->timestamps(); + }); + } + + public function down(): void + { + Schema::dropIfExists('payment_methods'); + } +}; diff --git a/database/migrations/2026_09_03_000001_add_cascade_delete_to_product_reviews_product_id.php b/database/migrations/2026_09_03_000001_add_cascade_delete_to_product_reviews_product_id.php new file mode 100644 index 0000000..38cc54a --- /dev/null +++ b/database/migrations/2026_09_03_000001_add_cascade_delete_to_product_reviews_product_id.php @@ -0,0 +1,43 @@ +dropForeign(['product_id']); + }); + + Schema::table('product_reviews', function (Blueprint $table) { + $table->foreign('product_id') + ->references('id') + ->on(config('lunar.database.table_prefix').'products') + ->cascadeOnDelete(); + }); + } + + public function down(): void + { + Schema::table('product_reviews', function (Blueprint $table) { + $table->dropForeign(['product_id']); + }); + + Schema::table('product_reviews', function (Blueprint $table) { + $table->foreign('product_id') + ->references('id') + ->on(config('lunar.database.table_prefix').'products'); + }); + } +}; diff --git a/database/migrations/2026_09_03_000001_create_stripe_payment_intents_table.php b/database/migrations/2026_09_03_000001_create_stripe_payment_intents_table.php new file mode 100644 index 0000000..6f54166 --- /dev/null +++ b/database/migrations/2026_09_03_000001_create_stripe_payment_intents_table.php @@ -0,0 +1,46 @@ +prefix.'stripe_payment_intents')) { + return; + } + + Schema::create($this->prefix.'stripe_payment_intents', function (Blueprint $table) { + $table->id(); + $table->foreignId('cart_id')->constrained($this->prefix.'carts'); + $table->foreignId('order_id')->nullable()->constrained($this->prefix.'orders'); + $table->string('intent_id')->index(); + $table->string('status')->nullable(); + $table->string('event_id')->index()->nullable(); + $table->timestamp('processing_at')->nullable(); + $table->timestamp('processed_at')->nullable(); + $table->timestamps(); + }); + } + + public function down(): void + { + Schema::dropIfExists($this->prefix.'stripe_payment_intents'); + } +}; diff --git a/database/migrations/2026_09_03_000002_add_context_to_stripe_payment_intents.php b/database/migrations/2026_09_03_000002_add_context_to_stripe_payment_intents.php new file mode 100644 index 0000000..06a5421 --- /dev/null +++ b/database/migrations/2026_09_03_000002_add_context_to_stripe_payment_intents.php @@ -0,0 +1,47 @@ +prefix + * resolves the SAME table-prefix config every Lunar-owned table uses + * (config('lunar.database.table_prefix')) — the vendor migration that + * creates this table (lunarphp/stripe's create_stripe_payment_intents_table) + * already does this, so a store running with a non-default prefix (this + * one runs with 'lunar_') would otherwise have this migration fail against + * a table name that doesn't exist. + */ +return new class extends Migration +{ + public function up(): void + { + Schema::table($this->prefix.'stripe_payment_intents', function (Blueprint $table) { + $table->json('context')->nullable()->after('status'); + $table->string('payment_type')->nullable()->after('context'); + }); + } + + public function down(): void + { + Schema::table($this->prefix.'stripe_payment_intents', function (Blueprint $table) { + $table->dropColumn(['context', 'payment_type']); + }); + } +}; diff --git a/database/migrations/2026_09_05_000001_add_driver_columns_to_payment_methods.php b/database/migrations/2026_09_05_000001_add_driver_columns_to_payment_methods.php new file mode 100644 index 0000000..0ea1f28 --- /dev/null +++ b/database/migrations/2026_09_05_000001_add_driver_columns_to_payment_methods.php @@ -0,0 +1,52 @@ +string('name')->nullable()->after('type'); + $table->string('driver')->nullable()->after('name'); + $table->string('capture_mode')->nullable()->after('driver'); + $table->string('captured_status')->nullable()->after('capture_mode'); + $table->string('authorized_status')->nullable()->after('captured_status'); + $table->unsignedInteger('position')->default(0)->after('authorized_status'); + $table->timestamp('driver_missing_at')->nullable()->after('position'); + }); + } + + public function down(): void + { + Schema::table('payment_methods', function (Blueprint $table) { + $table->dropColumn([ + 'name', 'driver', 'capture_mode', 'captured_status', + 'authorized_status', 'position', 'driver_missing_at', + ]); + }); + } +}; diff --git a/database/migrations/2026_09_08_000001_add_refunded_status_to_payment_methods.php b/database/migrations/2026_09_08_000001_add_refunded_status_to_payment_methods.php new file mode 100644 index 0000000..00b973e --- /dev/null +++ b/database/migrations/2026_09_08_000001_add_refunded_status_to_payment_methods.php @@ -0,0 +1,38 @@ +string('refunded_status')->nullable()->after('authorized_status'); + }); + } + + public function down(): void + { + Schema::table('payment_methods', function (Blueprint $table) { + $table->dropColumn('refunded_status'); + }); + } +}; diff --git a/database/migrations/2026_09_11_000001_add_status_axes_to_orders_table.php b/database/migrations/2026_09_11_000001_add_status_axes_to_orders_table.php new file mode 100644 index 0000000..001192a --- /dev/null +++ b/database/migrations/2026_09_11_000001_add_status_axes_to_orders_table.php @@ -0,0 +1,43 @@ +string('payment_status')->default('awaiting_payment')->after('status')->index(); + $table->string('fulfillment_status')->default('unfulfilled')->after('payment_status')->index(); + $table->string('return_status')->default('none')->after('fulfillment_status')->index(); + }); + } + + public function down(): void + { + Schema::table('lunar_orders', function (Blueprint $table) { + $table->dropColumn(['payment_status', 'fulfillment_status', 'return_status']); + }); + } +}; diff --git a/database/migrations/2026_09_11_000002_create_order_status_transitions_table.php b/database/migrations/2026_09_11_000002_create_order_status_transitions_table.php new file mode 100644 index 0000000..38b9a29 --- /dev/null +++ b/database/migrations/2026_09_11_000002_create_order_status_transitions_table.php @@ -0,0 +1,42 @@ +id(); + $table->foreignId('order_id')->constrained('lunar_orders')->cascadeOnDelete(); + $table->string('axis'); + $table->string('from_status')->nullable(); + $table->string('to_status'); + $table->string('event_class'); + $table->timestamp('created_at')->useCurrent(); + $table->index(['order_id', 'axis']); + }); + } + + public function down(): void + { + Schema::dropIfExists('order_status_transitions'); + } +}; diff --git a/database/migrations/2026_09_11_000003_backfill_order_status_axes.php b/database/migrations/2026_09_11_000003_backfill_order_status_axes.php new file mode 100644 index 0000000..63a53d9 --- /dev/null +++ b/database/migrations/2026_09_11_000003_backfill_order_status_axes.php @@ -0,0 +1,79 @@ + ['payment_status' => 'awaiting_payment', 'fulfillment_status' => 'unfulfilled'], + 'payment-offline' => ['payment_status' => 'awaiting_payment', 'fulfillment_status' => 'unfulfilled'], + 'payment-received' => ['payment_status' => 'paid', 'fulfillment_status' => 'unfulfilled'], + 'ready-for-dispatch' => ['payment_status' => 'paid', 'fulfillment_status' => 'ready'], + 'ready-for-pickup' => ['payment_status' => 'paid', 'fulfillment_status' => 'ready'], + 'dispatched' => ['payment_status' => 'paid', 'fulfillment_status' => 'in_transit'], + 'completed' => ['payment_status' => 'paid', 'fulfillment_status' => 'completed'], + ]; + + public function up(): void + { + Order::query()->with('transactions')->chunkById(200, function ($orders) { + foreach ($orders as $order) { + $mapped = self::MAP[$order->status] ?? null; + + if ($mapped === null) { + Log::warning('Order status axis backfill: unmapped status, leaving column defaults', [ + 'order_id' => $order->id, + 'status' => $order->status, + ]); + + continue; + } + + $paymentStatus = $mapped['payment_status']; + + $derived = OrderStatus::payment($order); + + if ($derived === PaymentStatus::Refunded) { + $paymentStatus = 'refunded'; + } elseif ($derived === PaymentStatus::PartialRefund) { + $paymentStatus = 'partially_refunded'; + } + + DB::table('lunar_orders')->where('id', $order->id)->update([ + 'payment_status' => $paymentStatus, + 'fulfillment_status' => $mapped['fulfillment_status'], + 'return_status' => 'none', + ]); + } + }); + } + + public function down(): void + { + // Column defaults (set in the schema migration) are the correct + // "undo" — no need to reverse-map back to the flat status, since + // `status` itself was never touched by this migration. + } +}; diff --git a/database/migrations/2026_09_11_000004_drop_status_columns_from_payment_methods_table.php b/database/migrations/2026_09_11_000004_drop_status_columns_from_payment_methods_table.php new file mode 100644 index 0000000..6e24878 --- /dev/null +++ b/database/migrations/2026_09_11_000004_drop_status_columns_from_payment_methods_table.php @@ -0,0 +1,36 @@ +dropColumn(['captured_status', 'authorized_status', 'refunded_status']); + }); + } + + public function down(): void + { + Schema::table('payment_methods', function (Blueprint $table) { + $table->string('captured_status')->nullable(); + $table->string('authorized_status')->nullable(); + $table->string('refunded_status')->nullable(); + }); + } +}; diff --git a/database/migrations/2026_09_12_000001_add_paid_to_orders_table.php b/database/migrations/2026_09_12_000001_add_paid_to_orders_table.php new file mode 100644 index 0000000..e012efb --- /dev/null +++ b/database/migrations/2026_09_12_000001_add_paid_to_orders_table.php @@ -0,0 +1,30 @@ +boolean('paid')->default(false)->after('status')->index(); + $table->timestamp('paid_at')->nullable()->after('paid'); + }); + } + + public function down(): void + { + Schema::table('lunar_orders', function (Blueprint $table) { + $table->dropColumn(['paid', 'paid_at']); + }); + } +}; diff --git a/database/migrations/2026_09_12_000002_backfill_single_order_status_and_paid.php b/database/migrations/2026_09_12_000002_backfill_single_order_status_and_paid.php new file mode 100644 index 0000000..d9a9279 --- /dev/null +++ b/database/migrations/2026_09_12_000002_backfill_single_order_status_and_paid.php @@ -0,0 +1,116 @@ + 'awaiting_payment', + 'payment-offline' => 'awaiting_payment', + 'payment-received' => 'processing', + 'ready-for-dispatch' => 'ready_for_dispatch', + 'ready-for-pickup' => 'ready_for_pickup', + 'dispatched' => 'dispatched', + 'completed' => 'completed', + ]; + + /** + * Axis fulfillment_status -> new single status, given branch. Axis + * 'delivered' folds into 'return_window_open' (same combined-value + * decision the going-forward design makes). Axis payment_status is + * used only to decide whether a fully-unfulfilled order should read + * as 'awaiting_payment' or 'processing'. + */ + private function mapFromAxes(string $payment, string $fulfillment, string $return, bool $isPickup): ?string + { + if ($return === 'returned') { + return 'returned'; + } + if ($return === 'requested') { + return 'return_requested'; + } + + return match ($fulfillment) { + 'unfulfilled' => $payment === 'paid' ? 'processing' : 'awaiting_payment', + 'processing' => 'processing', + 'ready' => $isPickup ? 'ready_for_pickup' : 'ready_for_dispatch', + 'in_transit' => 'dispatched', + 'delivered', 'return_window_open' => 'return_window_open', + 'picked_up' => 'picked_up', + 'completed' => 'completed', + default => null, + }; + } + + public function up(): void + { + Order::query()->with('transactions')->chunkById(200, function ($orders) { + foreach ($orders as $order) { + $isPickup = $order->isStorePickupOrder(); + + $axisIsDefault = $order->payment_status === 'awaiting_payment' + && $order->fulfillment_status === 'unfulfilled' + && $order->return_status === 'none'; + + $status = $axisIsDefault + ? (self::LEGACY_MAP[$order->status] ?? null) + : $this->mapFromAxes($order->payment_status, $order->fulfillment_status, $order->return_status, $isPickup); + + if ($status === null) { + Log::warning('Single-status backfill: unmapped order, defaulting to awaiting_payment', [ + 'order_id' => $order->id, + 'status' => $order->status, + 'payment_status' => $order->payment_status, + 'fulfillment_status' => $order->fulfillment_status, + 'return_status' => $order->return_status, + ]); + $status = 'awaiting_payment'; + } + + $derived = OrderStatus::payment($order); + $paid = $order->payment_status === 'paid' + || in_array($derived, [PaymentStatus::Captured, PaymentStatus::Refunded, PaymentStatus::PartialRefund], true); + + // A refund implies the order concluded via a return — + // even one backfilled to an early status (e.g. an order + // refunded before fulfillment ever started) is corrected + // to refunded/partially_refunded here, not left stuck + // pre-fulfillment with no sign a refund ever happened. + if ($derived === PaymentStatus::Refunded) { + $status = 'refunded'; + } elseif ($derived === PaymentStatus::PartialRefund) { + $status = 'partially_refunded'; + } + + DB::table('lunar_orders')->where('id', $order->id)->update([ + 'status' => $status, + 'paid' => $paid, + 'paid_at' => $paid ? ($order->placed_at ?? now()) : null, + ]); + } + }); + } + + public function down(): void + { + // No reverse mapping — column defaults (post-rollback of the + // schema migrations) are the correct "undo". + } +}; diff --git a/database/migrations/2026_09_12_000003_drop_status_axes_from_orders_table.php b/database/migrations/2026_09_12_000003_drop_status_axes_from_orders_table.php new file mode 100644 index 0000000..8644e00 --- /dev/null +++ b/database/migrations/2026_09_12_000003_drop_status_axes_from_orders_table.php @@ -0,0 +1,34 @@ +dropColumn(['payment_status', 'fulfillment_status', 'return_status']); + }); + } + + public function down(): void + { + // Mirrors 2026_09_11_000001's own down() — restores columns + // empty/defaulted, does not attempt to resurrect real per-order + // values. + Schema::table('lunar_orders', function (Blueprint $table) { + $table->string('payment_status')->default('awaiting_payment')->after('paid_at')->index(); + $table->string('fulfillment_status')->default('unfulfilled')->after('payment_status')->index(); + $table->string('return_status')->default('none')->after('fulfillment_status')->index(); + }); + } +}; diff --git a/database/migrations/2026_09_12_000004_drop_axis_from_order_status_transitions_table.php b/database/migrations/2026_09_12_000004_drop_axis_from_order_status_transitions_table.php new file mode 100644 index 0000000..8ae0e36 --- /dev/null +++ b/database/migrations/2026_09_12_000004_drop_axis_from_order_status_transitions_table.php @@ -0,0 +1,33 @@ +dropIndex(['order_id', 'axis']); + $table->dropColumn('axis'); + $table->index('order_id'); + }); + } + + public function down(): void + { + Schema::table('order_status_transitions', function (Blueprint $table) { + $table->dropIndex(['order_id']); + $table->string('axis')->default('status')->after('order_id'); + $table->index(['order_id', 'axis']); + }); + } +}; diff --git a/database/migrations/2026_09_12_000005_correct_cash_on_delivery_payment_method_driver.php b/database/migrations/2026_09_12_000005_correct_cash_on_delivery_payment_method_driver.php new file mode 100644 index 0000000..e72c810 --- /dev/null +++ b/database/migrations/2026_09_12_000005_correct_cash_on_delivery_payment_method_driver.php @@ -0,0 +1,27 @@ + 'offline' — the same immediate-capture driver as + * cash-in-hand. That's the bug that made COD "pay immediately" instead of + * waiting for staff to confirm cash was actually received. Repoints + * already-seeded environments to the new dedicated + * Modules\Core\Payment\Drivers\CashOnDeliveryPaymentDriver; the seeder + * itself is fixed separately for fresh installs. + */ +return new class extends Migration +{ + public function up(): void + { + DB::table('payment_methods')->where('type', 'cash-on-delivery')->update(['driver' => 'cash-on-delivery']); + } + + public function down(): void + { + DB::table('payment_methods')->where('type', 'cash-on-delivery')->update(['driver' => 'offline']); + } +}; diff --git a/database/migrations/2026_09_13_000001_rename_return_window_open_status_to_delivered.php b/database/migrations/2026_09_13_000001_rename_return_window_open_status_to_delivered.php new file mode 100644 index 0000000..001b528 --- /dev/null +++ b/database/migrations/2026_09_13_000001_rename_return_window_open_status_to_delivered.php @@ -0,0 +1,30 @@ +where('status', 'return_window_open')->update(['status' => 'delivered']); + DB::table('order_status_transitions')->where('from_status', 'return_window_open')->update(['from_status' => 'delivered']); + DB::table('order_status_transitions')->where('to_status', 'return_window_open')->update(['to_status' => 'delivered']); + } + + public function down(): void + { + DB::table('lunar_orders')->where('status', 'delivered')->update(['status' => 'return_window_open']); + DB::table('order_status_transitions')->where('from_status', 'delivered')->update(['from_status' => 'return_window_open']); + DB::table('order_status_transitions')->where('to_status', 'delivered')->update(['to_status' => 'return_window_open']); + } +}; diff --git a/database/migrations/2026_09_13_000002_create_manifests_table.php b/database/migrations/2026_09_13_000002_create_manifests_table.php new file mode 100644 index 0000000..1e9abd4 --- /dev/null +++ b/database/migrations/2026_09_13_000002_create_manifests_table.php @@ -0,0 +1,43 @@ +count()) purely so the manifests list can + * render without an extra query per row. + * + * carrier-agnostic by design — see Modules\Core\Shipping\Contracts\ + * SupportsManifestBatching, the same contract any future carrier + * (Speedex, etc.) implements to get manifest batching at all; this table + * has no ACS-specific columns. + */ +return new class extends Migration +{ + public function up(): void + { + Schema::create('manifests', function (Blueprint $table) { + $table->id(); + $table->string('carrier'); + $table->string('reference'); + $table->unsignedInteger('shipment_count')->default(0); + $table->timestamp('issued_at'); + $table->timestamps(); + + $table->unique(['carrier', 'reference']); + }); + } + + public function down(): void + { + Schema::dropIfExists('manifests'); + } +}; diff --git a/database/migrations/2026_09_13_000003_add_manifest_id_to_shipments_table.php b/database/migrations/2026_09_13_000003_add_manifest_id_to_shipments_table.php new file mode 100644 index 0000000..4b3de28 --- /dev/null +++ b/database/migrations/2026_09_13_000003_add_manifest_id_to_shipments_table.php @@ -0,0 +1,82 @@ +foreignId('manifest_id')->nullable()->after('manifest_reference')->constrained()->nullOnDelete(); + }); + + $groups = DB::table('shipments') + ->select('carrier', 'manifest_reference') + ->whereNotNull('manifest_reference') + ->distinct() + ->get(); + + foreach ($groups as $group) { + $shipments = DB::table('shipments') + ->where('carrier', $group->carrier) + ->where('manifest_reference', $group->manifest_reference) + ->get(); + + $issuedAt = $shipments->pluck('label_printed_at')->filter()->min() + ?? $shipments->pluck('updated_at')->min(); + + $manifestId = DB::table('manifests')->insertGetId([ + 'carrier' => $group->carrier, + 'reference' => $group->manifest_reference, + 'shipment_count' => $shipments->count(), + 'issued_at' => $issuedAt, + 'created_at' => $issuedAt, + 'updated_at' => $issuedAt, + ]); + + DB::table('shipments') + ->where('carrier', $group->carrier) + ->where('manifest_reference', $group->manifest_reference) + ->update(['manifest_id' => $manifestId]); + } + + Schema::table('shipments', function (Blueprint $table) { + $table->dropColumn('manifest_reference'); + }); + } + + public function down(): void + { + Schema::table('shipments', function (Blueprint $table) { + $table->string('manifest_reference')->nullable()->after('parent_reference'); + }); + + DB::table('shipments') + ->whereNotNull('manifest_id') + ->orderBy('id') + ->each(function ($shipment) { + $manifest = DB::table('manifests')->find($shipment->manifest_id); + + if ($manifest) { + DB::table('shipments')->where('id', $shipment->id)->update([ + 'manifest_reference' => $manifest->reference, + ]); + } + }); + + Schema::table('shipments', function (Blueprint $table) { + $table->dropConstrainedForeignId('manifest_id'); + }); + } +}; diff --git a/database/migrations/2026_09_14_000001_add_otp_attempts_to_users_table.php b/database/migrations/2026_09_14_000001_add_otp_attempts_to_users_table.php new file mode 100644 index 0000000..bf43b6c --- /dev/null +++ b/database/migrations/2026_09_14_000001_add_otp_attempts_to_users_table.php @@ -0,0 +1,30 @@ +unsignedTinyInteger('otp_attempts')->default(0)->after('otp_expires_at'); + }); + } + + public function down(): void + { + Schema::table('users', function (Blueprint $table) { + $table->dropColumn('otp_attempts'); + }); + } +}; diff --git a/database/migrations/2026_09_15_000001_create_user_sessions_table.php b/database/migrations/2026_09_15_000001_create_user_sessions_table.php new file mode 100644 index 0000000..dbfb6fa --- /dev/null +++ b/database/migrations/2026_09_15_000001_create_user_sessions_table.php @@ -0,0 +1,41 @@ +id(); + $table->foreignId('user_id')->constrained()->cascadeOnDelete(); + $table->string('token', 64)->unique(); + $table->string('user_agent')->nullable(); + $table->string('ip_address', 45)->nullable(); + $table->timestamp('last_used_at'); + $table->timestamp('revoked_at')->nullable(); + $table->timestamps(); + + $table->index(['user_id', 'revoked_at']); + }); + } + + public function down(): void + { + Schema::dropIfExists('user_sessions'); + } +}; diff --git a/database/migrations/2026_09_15_000001_make_payment_methods_name_translatable.php b/database/migrations/2026_09_15_000001_make_payment_methods_name_translatable.php new file mode 100644 index 0000000..fc97701 --- /dev/null +++ b/database/migrations/2026_09_15_000001_make_payment_methods_name_translatable.php @@ -0,0 +1,65 @@ +value('code') ?? 'en'; + + $existing = DB::table('payment_methods')->pluck('name', 'id'); + + DB::statement('ALTER TABLE payment_methods ALTER COLUMN name DROP DEFAULT'); + DB::statement("ALTER TABLE payment_methods ALTER COLUMN name TYPE json USING NULL"); + + foreach ($existing as $id => $name) { + if ($name === null) { + continue; + } + + DB::table('payment_methods') + ->where('id', $id) + ->update(['name' => json_encode([$defaultLocale => $name])]); + } + } + + public function down(): void + { + $defaultLocale = Language::where('default', true)->value('code') ?? 'en'; + + $existing = DB::table('payment_methods')->pluck('name', 'id'); + + DB::statement('ALTER TABLE payment_methods ALTER COLUMN name TYPE varchar(255) USING NULL'); + + foreach ($existing as $id => $name) { + $decoded = json_decode((string) $name, true); + $flat = is_array($decoded) ? ($decoded[$defaultLocale] ?? reset($decoded) ?: null) : $name; + + DB::table('payment_methods')->where('id', $id)->update(['name' => $flat]); + } + } +}; diff --git a/database/migrations/2026_09_15_000002_make_shipping_methods_name_translatable.php b/database/migrations/2026_09_15_000002_make_shipping_methods_name_translatable.php new file mode 100644 index 0000000..2a64fdd --- /dev/null +++ b/database/migrations/2026_09_15_000002_make_shipping_methods_name_translatable.php @@ -0,0 +1,74 @@ +prefix.'shipping_methods'; + $defaultLocale = Language::where('default', true)->value('code') ?? 'en'; + + // The column is NOT NULL (vendor migration never marked it + // nullable) — converting via `USING NULL` first, then + // backfilling with a second UPDATE, violates that constraint + // before the backfill ever runs. json_build_object() converts + // each existing string in place, in the same statement, so the + // column is never transiently NULL. $defaultLocale is inlined + // (not bound) — parameter binding inside an ALTER TABLE ... USING + // expression isn't reliable across drivers; it's a Language::code + // value we control, not user input, so quote_literal-safe + // interpolation here is fine. + $quotedLocale = DB::getPdo()->quote($defaultLocale); + + DB::statement("ALTER TABLE {$table} ALTER COLUMN name TYPE json USING json_build_object({$quotedLocale}, name)"); + } + + public function down(): void + { + $table = $this->prefix.'shipping_methods'; + $defaultLocale = Language::where('default', true)->value('code') ?? 'en'; + + // Same NOT NULL constraint applies going back — ->>'{locale}' + // extracts the default locale's text value directly in the + // USING clause, falling back to the first key present via + // COALESCE for any row missing that locale (e.g. one only ever + // filled in via a non-default language). + $quotedLocale = DB::getPdo()->quote($defaultLocale); + + DB::statement( + "ALTER TABLE {$table} ALTER COLUMN name TYPE varchar(255) ". + "USING COALESCE(name->>{$quotedLocale}, (SELECT value FROM json_each_text(name) LIMIT 1))" + ); + } +}; diff --git a/docs/cart.md b/docs/cart.md new file mode 100644 index 0000000..0e99efa --- /dev/null +++ b/docs/cart.md @@ -0,0 +1,280 @@ +# Cart Admin Visibility + +`Modules\Core\Cart\Filament\Resources\CartResource` gives staff read-only visibility into +every cart in the Filament admin panel, guest carts included. Lunar itself ships no cart +admin view at all — no Filament resource for `Cart`/`CartLine` exists anywhere in +`lunarphp/lunar` or `lunarphp/core` — this is a from-scratch addition, not an extension of +something Lunar half-built. See `docs/lunar.md`'s "Cart and Checkout" section for the +underlying Lunar cart mechanics this resource reads from. + +--- + +## Scope: every cart, identified or not + +`CartResource` lists every cart the four lifecycle states (below) cover, with no +`user_id`/`customer_id` filter — an anonymous guest's session cart is included. + +This was a reversal of an earlier, deliberate call to exclude guest carts entirely (on the +reasoning that an anonymous cart carries no identity a staff member could act on — no name, no +email, nothing to follow up with — so listing every guest session cart would be noise, not a +real admin capability). That reasoning holds for "can I click through to a Customer record," +but not for the resource's other real use — seeing how many carts are ongoing/abandoned right +now regardless of who's shopping. Most real storefront traffic never reaches an identified +user/customer, so excluding it silently undercounts exactly the thing `ListCarts`'s tabs (and +`CartLifecycleService`, which they and `DetectAbandonedCarts` both build on) exist to report +on. The `Customer`/`User` columns on a guest row just render "—" (Filament's `placeholder()`) +instead of a link — nothing to click into, but the row and its contents are still visible via +`ViewCart`. + +This does **not** mirror Shopify's admin (Shopify has no "all carts" view at all — only +"Abandoned checkouts," gated on a shopper reaching checkout and entering contact info, a +later/narrower stage than Lunar's `Cart`). + +--- + +## Four states, not two — and not `Cart::completed_at` + +`Lunar\Models\Cart::completed_at` is declared and cast (`'completed_at' => 'datetime'`) but +**never actually written anywhere in Lunar core** — grep `vendor/lunarphp/core/src` for it; +the only hits are the property declaration and the cast. It is not a real signal. `Cart` has +no `status` column at all — every state below is derived from relations/timestamps, not a +single field. + +`Cart::scopeActive()` (Lunar's own "not yet converted to an order" scope) actually mixes two +distinct states together: no order ever started, vs. a draft order exists +(`placed_at IS NULL`) but was never placed — checkout was started, not finished. Those are +different purchase-intent signals (see "Abandoned Cart vs Abandoned Checkout" below) and +different reachability (checkout usually captures an email even for a guest), so +`ListCarts::getTabs()` splits them into four tabs instead of `scopeActive()`'s two-state +split. + +`Modules\Core\Cart\Services\CartLifecycleService` is the single source of truth for these four +query shapes — both `ListCarts::getTabs()` (staff browsing) and `DetectAbandonedCarts` +(abandonment-event dispatch) build on it, rather than each reimplementing the same split +independently (which is what happened before this service existed, and is exactly the kind of +drift that lets the admin panel and the recovery-email pipeline quietly disagree about what +"abandoned" means): + +- **Ongoing** (`ongoing()`) — `scopeActive()` and recent `updated_at` (within + `abandonedCutoff()`). Default active tab on page load. +- **Abandoned Cart** (`abandonedCarts()`) — `whereDoesntHave('orders')` and stale + `updated_at`. +- **Abandoned Checkout** (`abandonedCheckouts()`) — has an order with `placed_at IS NULL`, + and stale `updated_at`. +- **Completed** (`completed()`) — has an order with `placed_at IS NOT NULL`. + +Each method takes a `Builder` and returns it further scoped, so callers compose it onto +whatever base query they already have (`CartResource::getEloquentQuery()` for the Filament +tabs, a bare `Cart::query()` for the command). Deliberately query-shape-only: consent +(`meta->recovery_consent`) and non-empty-lines filtering stay in `DetectAbandonedCarts`, not on +the service — those gate whether a recovery *event* should fire, not what "abandoned" means to +a staff member browsing the list. + +There is deliberately **no "All" tab.** Every row shown is always scoped to one of the four +states above — the list never runs an unfiltered `Cart::query()->get()` over the whole +(potentially large) table. + +### Abandoned Cart vs Abandoned Checkout — why they're not one bucket + +Different purchase intent, different reachability, and different recovery strategy — see +`docs/recovery-strategies.md` for the full marketing-strategy discussion. In short: + +- **Abandoned Cart** (no order started) is a weak intent signal — often window-shopping, not + a near-purchase. Frequently unreachable (no email/identity at all for a true guest). + Recovery leans on on-site retargeting and ad remarketing rather than email. +- **Abandoned Checkout** (draft order, never placed) is a strong intent signal — the shopper + committed to buying and something blocked completion. Checkout typically captures contact + info even for a guest, so this state is usually reachable. This is the state the + researched 1h/24h/72h recovery-email cadence targets specifically. + +`Modules\Core\Cart\Events\CartAbandoned` and `Modules\Core\Checkout\Events\CheckoutAbandoned` +mirror this same split (see "Events" below) rather than one combined event. + +--- + +## Why this scales fine at a large cart count + +Two things keep this cheap regardless of how many carts exist (10,000+): + +- **The list is always paginated.** Filament applies `LIMIT`/`OFFSET` to whichever tab's + query is active — a page only ever fetches one page's worth of rows, never the whole + table, "All" tab or not (and there is no "All" tab — see above). +- **No per-row queries.** `lines_count`/`lines_sum_quantity` use Filament's built-in + `->counts('lines')`/`->sum('lines', 'quantity')`, which fold into the same query as the + rest of the list (one `LEFT JOIN`-based aggregate, not N separate lookups). There's no + per-record `getStateUsing()` closure anywhere in this table doing its own query — that's + the pattern to avoid if a future column needs derived data (see `Modules\Core\Catalog\ + Services\ProductIndexer` for the general "compute once at index time / one aggregate + query, never per-row" principle this project follows elsewhere). + +The one thing that **does** scan more rows as the cart count grows is +`CartResource::getNavigationBadge()` (see below) — but it's a `COUNT(*)`, not a fetch, and +runs once per admin page load, not once per cart row. + +--- + +## Navigation badge — abandoned cart count + +```php +public static function getNavigationBadge(): ?string +{ + return (string) static::getEloquentQuery()->active()->where('updated_at', '<=', static::abandonedCutoff())->count(); +} +``` + +Shows the number of abandoned carts (not all carts — a converted cart isn't something a +staff member needs to keep noticing) next to "Carts" in the sidebar. `->count()` compiles to +a single `SELECT COUNT(*) ...` — confirmed via query log — no rows are ever loaded just to +render the badge. + +--- + +## The view page runs the cart's full calculate pipeline — once + +`ViewCart::resolveRecord()` calls `$cart->calculate()` before rendering, since `CartLine`'s +computed properties (`unitPrice`, `total`, etc.) and `Cart`'s own totals (`subTotal`, `total`, +...) are plain public properties populated as a side effect of that pipeline — never +persisted, so a plain Eloquent-fetched `Cart` has them all `null`/unset (see `docs/lunar.md` +Gotchas). This only runs on the single-record view page, not per row in the list table — +running the full 5-step pipeline for every row of a paginated list would be needless cost for +data the list doesn't display. + +--- + +## Not built: staff editing a cart + +The resource is deliberately read-only (`canCreate()` returns `false`, no edit page +registered). A cart is owned by the storefront's own add/update/remove flow +(`CartSession`/`Cart::add()`/etc.) — hand-editing cart contents from the admin panel isn't a +supported use case here. + +--- + +## `CartService` — the storefront-facing API + +`Modules\Core\Cart\Services\CartService` mirrors `Modules\Core\Catalog\Services\ +ProductService`/`CollectionService`'s shape — one boboko-owned API a storefront calls, so +Lunar's own `CartSession`/`Cart` stay an implementation detail rather than something a +consuming app depends on directly. + +- `current()` / `currentOrCreate()` — the latter force-creates a cart (`CartSession::manager()`), + the former doesn't (`CartSession::current()`, returns `null` for a fresh visitor — see + `docs/lunar.md`'s Cart gotchas). +- `addLine()` / `updateLine()` / `removeLine()` / `clear()` — thin wrappers over + `Cart::add()`/`updateLine()`/`remove()`/`clear()`. No boboko-owned exception types wrap + Lunar's own cart exceptions (`InvalidCartLineQuantityException`, `CartLineIdMismatchException`, + etc.) — they propagate as-is; a wrapper would add indirection with identical semantics. +- `applyCoupon()` / `removeCoupon()` — sets/clears `Cart::coupon_code` (there's no dedicated + Lunar action for this, unlike add/update/remove). `applyCoupon()` validates via + `Discounts::validateCoupon()` first and throws `Modules\Core\Cart\Exceptions\ + InvalidCouponException` on a bad code — `CouponString`'s cast only normalizes casing, it + doesn't validate anything, so setting `coupon_code` directly would silently accept a bogus + code and just not discount anything once calculated. +- `saveForLater()` / `moveToCart()` / `activeLines()` / `savedLines()` — see "Save for later" + below. + +Every mutating method returns the recalculated `Cart` (matching Lunar's own `Cart::add()` +etc., which already return `$this` after `refresh()->recalculate()`) and dispatches a +matching domain event. + +### Events — Lunar dispatches none of its own + +`Lunar` dispatches zero cart events — no "item added," no "cart created" (see +`docs/lunar.md`'s Cart gotchas). `CartService` fills that gap with its own, dispatched after +the underlying Lunar operation completes: + +`CartLineAdded`, `CartLineUpdated`, `CartLineRemoved`, `CartCleared`, `CartCouponApplied`, +`CartCouponRemoved`, `CartLineSaved`, `CartLineMovedToCart` — all under +`Modules\Core\Cart\Events`. `CartAbandoned`/`CheckoutAbandoned` live under +`Modules\Core\Recovery\Events` instead, not `Cart`/`Checkout` — see "Abandonment detection" +below for why. + +**None of these currently have a listener.** They're dispatched-but-unconsumed by design — +built so something downstream (reindexing, notifications, a future read-side reporting +service) has a hook to attach to, not because a concrete consumer exists today. This was a +deliberate decision, not an oversight — see the "don't build speculative infrastructure" +calls made elsewhere in this project (e.g. not wrapping Lunar's cart exceptions). + +**Why not wired to Spatie's Activity Log:** `Cart`/`CartLine` already use Lunar's own +`LogsActivity` trait (Spatie's package, Lunar's defaults) — confirmed from source, this logs +model saves/deletes automatically, independent of actor. `Modules\Core\Logging\ +ActivityLogService` (this project's own wrapper, used by e.g. `LogTranslationActivity`) is +hardcoded to the `staff` guard — correctly scoped for staff-driven writes (Filament admin +actions), but wrong for customer-driven cart activity, which would resolve `causedBy()` to +`null` every time. Both `ActivityLogService` and `Cart`/`CartLine`'s native `LogsActivity` +write to the **same** `log_name = 'lunar'` / `activity_log` table, with no built-in +separation beyond reading `causer_type` per row — a real limitation worth knowing about, but +not one this project is fixing by giving Cart a distinct `log_name`, since every other Lunar +model logs to `'lunar'` too and a Cart-only carve-out would just be inconsistent. The +intended fix, if this becomes a real need, is a read-side service that queries `activity_log` +and classifies by `causer_type`/`log_name` — not touching every write site. + +### Save for later + +A `CartLine` can be moved out of the purchasable cart without being deleted — flagged via +`meta.saved_for_later`, not a new column (matches the free-form-JSON pattern already used +elsewhere, e.g. `ProductOptionValue::meta`). `Modules\Core\Cart\Pipelines\ +ZeroSavedForLaterPrice` (registered in `config('lunar.cart.pipelines.cart_lines')`, after the +stock `GetUnitPrice`) zeroes `unitPrice`/`unitPriceInclTax` for flagged lines **before** +Lunar's own `CalculateLines` pipeline step sums the cart — `CalculateLines` sums every +`CartLine` unconditionally with no meta-based exclusion of its own, so zeroing the price +upstream is what makes `Cart::subTotal`/`total` naturally correct without a second pass or +callers needing a different totals accessor. + +`Lunar\Actions\Carts\UpdateCartLine` **replaces** the whole `meta` column on write (plain +`update(['meta' => $meta])`, not a merge) — `saveForLater()`/`moveToCart()` read the line's +existing meta and merge in the flag change before calling `Cart::updateLine()`, or an +unrelated meta key set by something else would be silently wiped. + +### Coupons + +See `CartService::applyCoupon()`/`removeCoupon()` above. `Lunar\Base\Casts\CouponString` +just upper-cases the code; `Lunar\Managers\DiscountManager::validateCoupon()` (via the +`Discounts` facade) is the actual check — does a matching `Discount` (type `AmountOff` or +`BuyXGetY`) exist, `active()`, with `max_uses` not exhausted. + +--- + +## Abandonment detection + +"Abandoned" is a **derived** state (`Cart::updated_at` older than +`config('core.cart.abandoned_after')`, default `1 hour`) — nothing transitions a cart into it +via a normal Eloquent write, so there's no model-event hook to dispatch from directly. +`Modules\Core\Cart\Commands\DetectAbandonedCarts` (registered on an hourly schedule by +`Modules\Core\Providers\CartServiceProvider`) is the only place that moment gets detected: it +builds on the same `CartLifecycleService::abandonedCarts()`/`abandonedCheckouts()` queries +`ListCarts::getTabs()` uses (no order at all vs. draft order never placed) and dispatches +`Modules\Core\Recovery\Events\CartAbandoned`/`CheckoutAbandoned` for anything currently stale +that also has `meta->recovery_consent = true`. + +### Cart/Checkout have zero abandonment-related writes — by design + +`DetectAbandonedCarts` **only dispatches** — it never writes to `Cart`/`Order` at all. An +earlier version recorded an "already notified" marker on `Cart::meta`/`Order::meta` to avoid +refiring the same event every run, but that `->save()` call bumped `Cart::updated_at` as an +Eloquent side effect — since `updated_at` is also the field abandonment staleness is computed +from, the write **un-staled the very cart it had just marked abandoned**: confirmed live, a +cart that correctly fired `CartAbandoned` showed back up as "Ongoing," not "Abandoned Cart," +on the very next tab-count check. + +The fix wasn't to write the marker more carefully — it was to stop `Cart`/`Checkout` from +having any way to write abandonment state at all. Deduplication ("has this cart already been +notified") is deliberately **not** this command's job; it belongs to `Recovery` (not yet +built — see `docs/recovery-strategies.md`), which will own its own tracking table, keeping +`Cart`/`Order` permanently free of abandonment-related columns or `meta` keys. + +**Current tradeoff, accepted deliberately**: until `Recovery` exists, every cart still +matching the "abandoned" query refires its event on every hourly run — there is no dedup at +all right now. That's fine today only because nothing consumes these events yet (see +"Events" above); it would need addressing before anything real listens for them. + +--- + +## Recovery Sequences — design only, not built + +See `docs/recovery-strategies.md` — a full marketing-strategy discussion and a first-pass +feature design for an admin-configurable sequence of "touches" (delay + optional discount + +label) per abandonment type. Explicitly parked as an open design question, not scoped for +implementation yet — whether this belongs under `Cart`, a new `Recovery`/`Marketing` concern, +and how far the touch model needs to flex (channel choice, value-based branching, segment +targeting) are all still undecided. diff --git a/docs/checkout.md b/docs/checkout.md new file mode 100644 index 0000000..9f486b8 --- /dev/null +++ b/docs/checkout.md @@ -0,0 +1,155 @@ +# Checkout — Design Notes + +**Status: design finalized, not yet built.** This is the design spec for +`Modules\Core\Checkout\Services\CheckoutService`, plus the three-stage lifecycle model it's +part of. Nothing in this document is implemented yet. + +--- + +## Three-stage lifecycle: Cart → Checkout → Order + +Each stage is its own concern, not a phase inside a shared one — matching the pattern already +established this session (`Recovery` was split out from `Cart` specifically because +abandonment detection is a different lifecycle stage than line-item mutation, even though it +reads `Cart` state). + +- **`Cart`** — line items, coupons, save-for-later (`docs/cart.md`). Ends the moment + `Cart::createOrder()` is called. +- **`Checkout`** — the placement moment itself: setting addresses, selecting a shipping + option, placing the order. Starts where Cart ends, ends the instant an `Order` exists. + This document. +- **`Order`** — everything after an order exists: status transitions (`Order::status`, + changed via the Filament admin `EditOrder` page — always staff-driven, never part of + checkout itself), fulfillment/shipment tracking. **Named and scoped here, not yet built** — + same status as `Recovery` before it existed as real code. + +`Modules\Core\Checkout\Events\OrderPlaced` (see below) is the handoff point: `Checkout` +dispatches it the moment an order exists; `Order`'s own listeners (not built yet) would be +what reacts to it — e.g. sending a confirmation email, initializing whatever `Order` needs to +initialize. `Checkout` itself has no opinion about what happens after `OrderPlaced` fires. + +### Where `Order` would likely absorb work that currently lives under `Shipping` + +`Modules\Core\Shipping`'s `Shipment`/`ShipmentInfo` models are already order-scoped +(`Shipment::order(): BelongsTo`), and `PollShipmentTrackingJob`/ +`ShipmentStatusUpdatedByCarrier` are fulfillment/tracking concerns that happen entirely after +an order exists — conceptually closer to `Order` than to `Shipping`'s actual job (carrier +rate quoting, `ShippingRateInterface` drivers, `ShippingManifest`). Not decided whether/when +this gets moved; noted here so the boundary is visible when `Order` is actually scoped. + +--- + +## `CheckoutService` + +Mirrors `Modules\Core\Cart\Services\CartService`'s shape (see `docs/cart.md`) — one +boboko-owned API a storefront calls, keeping Lunar's own `Cart`/`ShippingManifest` primitives +an implementation detail. + +| Method | Wraps | Dispatches | +|---|---|---| +| `setShippingAddress(array\|Addressable $address)` | `Cart::setShippingAddress()` | `ShippingAddressSet($cart, $address)` | +| `setBillingAddress(array\|Addressable $address)` | `Cart::setBillingAddress()` | `BillingAddressSet($cart, $address)` | +| `getShippingOptions()` | `ShippingManifest::getOptions($cart)` | — (read-only) | +| `selectShippingOption(string $identifier)` | `Cart::setShippingOption()` | `ShippingOptionSelected($cart, $option)` — throws `InvalidShippingOptionException` if `$identifier` doesn't resolve | +| `placeOrder(string $fingerprint)` | `Cart::checkFingerprint()` then `Cart::createOrder()` | `OrderPlaced($order)` | + +### `getShippingOptions()` — already fully backed by the merged Shipping-Carriers work + +`ShippingManifest::getOptions($cart)` runs every registered `ShippingRateInterface` driver +through a pipeline — this already includes ACS/Box Now live-rate quoting +(`Modules\Core\Shipping\Carriers\Acs\AcsRateDriver`/`BoxNowRateDriver`, merged from the +`Shipping-Carriers` branch) alongside `table-rate-shipping`'s own flat-rate/free-shipping/ +collection drivers. `CheckoutService` doesn't need to build any rate-resolution logic — it's +a thin pass-through to what already exists and works. + +### `placeOrder()` — fingerprint check is mandatory, not optional + +`placeOrder(string $fingerprint): Order` requires the fingerprint the shopper's last-seen +cart total was built from (`Cart::fingerprint()`) as a parameter — not an optional +after-the-fact check a caller might forget. `Cart::checkFingerprint()` throws Lunar's own +`FingerprintMismatchException` if the cart's contents/total changed since that fingerprint +was generated (a line's price changed, stock adjusted the total, another tab modified the +cart), forcing re-confirmation instead of silently placing an order at a different total than +what the shopper approved. + +### No exception wrapping — same reasoning as `CartService` + +Confirmed from source: `Lunar\Validation\Cart\ValidateCartForOrderCreation` (the validator +`Cart::createOrder()` runs via `config('lunar.cart.validators.order_create')`) already throws +`Lunar\Exceptions\Carts\CartException` with a field-keyed `MessageBag` +(`$exception->errors()`) — billing/shipping address completeness, missing shipping option, +duplicate-order guard. This is already the right shape for a storefront to catch and render +as form errors directly; wrapping it in a boboko-owned exception type would add indirection +with identical semantics, the same call made for `CartService`'s cart-line exceptions. + +`FingerprintMismatchException` (from the mandatory fingerprint check above) propagates +as-is for the same reason. + +**One genuine exception to this rule**: `selectShippingOption()` throws +`Modules\Core\Checkout\Exceptions\InvalidShippingOptionException` when `$identifier` doesn't +resolve to a real option (`ShippingManifest::getOption()` just returns `null` — Lunar has no +matching exception type here to propagate, unlike `CartException`/`FingerprintMismatchException` +above). Same reasoning as `Modules\Core\Cart\Exceptions\InvalidCouponException` for +`Discounts::validateCoupon()`, which also just returns a bool with nothing to reuse. Confirmed +live: an invalid identifier previously returned the cart unchanged with no signal at all — +fixed to throw instead, verified via a real container test. + +### Validated from source: the real precondition chain + +`ValidateCartForOrderCreation::validate()`, read directly from `vendor/lunarphp/core`: + +1. No completed order already exists on this cart (duplicate-order guard). +2. A billing address is set and passes `country_id`/`first_name`/`line_one`/`city`/`postcode` + required-field validation. +3. If the cart `isShippable()` (has at least one non-digital line): + - A shipping option must already be selected (`Cart::getShippingOption()` — which only + resolves anything once `shippingAddress->shipping_option` has been persisted via + `selectShippingOption()`, confirmed from `Lunar\Base\ShippingManifest::getShippingOption()`). + - Unless that option is collect/pickup (`$shippingOption->collect`), a shipping address is + also required and validated the same way as billing. + +This is why `CheckoutService`'s methods exist in the order they're listed above — a +storefront checkout flow has to drive them roughly in that sequence for `placeOrder()` to +ever succeed. + +--- + +## Events — richer payload than `CartService`'s, deliberately + +`Modules\Core\Checkout\Events`: `ShippingAddressSet`, `BillingAddressSet`, +`ShippingOptionSelected`, `OrderPlaced`. + +Unlike `CartService`'s events (which carry a plain `Cart`/`CartLine` model reference — see +`docs/cart.md`), these carry richer, already-resolved payload — e.g. `ShippingOptionSelected` +includes the resolved `ShippingOption` (name, price, carrier identifier), not just the +string identifier a listener would have to re-resolve. Deliberate divergence from +`CartService`'s convention: a live-priced shipping quote or a submitted address is +meaningfully more expensive/awkward for a listener to re-derive later than a `CartLine` +model reference is. + +**Why this matters beyond `Checkout` itself:** the Analytics survey (`docs/scratch/ +analytics-feature-survey.html`) found conversion-funnel tracking (product view → add to cart +→ checkout → purchase) entirely missing, with zero underlying data captured anywhere. The +Checkout survey separately flagged "abandoned-checkout stage tracking (email captured vs. +shipping selected vs. payment started)" as missing. One event per real state transition here +— not just a single `OrderPlaced` at the end — is what gives a future analytics/reporting +listener (not built) the funnel-stage data neither gap currently has anything to build on. + +**None of these have a listener yet.** Same status as `CartService`'s events — dispatched, +unconsumed, built so something downstream has a hook to attach to. + +--- + +## Explicitly out of scope for `CheckoutService` + +- **Order-status-changed events** — post-placement, staff-driven (`Order::status` changes via + the Filament admin `EditOrder` page, never through checkout). Belongs to `Order` (see + above), not `Checkout`. +- **Order confirmation email** — needs `OrderPlaced` as a trigger, but actual sending is + separate infrastructure, same "detection/signal only, sending is a later concern" deferral + already applied to `Recovery` (`docs/recovery-strategies.md`). +- **Guest order tracking/lookup** — a separate storefront feature, not part of the placement + flow itself. +- **Payment** — authorizing/capturing a transaction against the placed order. Genuinely + separate from `Checkout` as scoped here; `CheckoutService::placeOrder()` produces an + `Order`, what happens to pay for it is out of this document's scope. diff --git a/docs/collections.md b/docs/collections.md new file mode 100644 index 0000000..affba4f --- /dev/null +++ b/docs/collections.md @@ -0,0 +1,116 @@ +# Collections + +`Modules\Core\Catalog\Services\CollectionService` provides category browsing/nav AND +single-collection lookup for a storefront — `list()`, `getById()`, `getBySlug()` — +all reading directly from the Meilisearch index, mirroring +`Modules\Core\Catalog\Services\ProductService` (see `product-listing.md`) exactly. + +--- + +## Why it reads from the index, not the database + +Lunar's own `Lunar\Search\CollectionIndexer` only carries `id`/`name`/`created_at` — +nowhere near enough for a storefront category page or a nav tree. +`Modules\Core\Catalog\Services\CollectionIndexer` extends it to add everything +`CollectionService` needs: + +| Field | Source | Notes | +|---|---|---| +| `parent_id` | `$model->parent_id` | Filterable. The nested-set tree's parent pointer — `null` for a top-level collection. | +| `_lft` | `$model->_lft` | Filterable and sortable. The nested-set tree position — lets `CollectionService` resolve tree order without a database read. | +| `collection_group_id` | `$model->collection_group_id` | Filterable. Mirrors `Collection::scopeInGroup()`. | +| `slugs` | `$model->urls->pluck('slug')` | Filterable. Every locale's `Url::slug`, so `getBySlug()` resolves purely from the index. | +| `thumbnail` | `$model->getThumbnailImage()` | Display only. `null` if the collection has no thumbnail image. | +| `ancestors` | `$model->ancestors` | Display only. Array of `{id, name}`, ordered root-first — a breadcrumb (`Home > Apparel > Keychains`) can render directly from a single `getById()`/`getBySlug()` call, no extra queries. Empty array for a top-level collection. | +| `product_count` | Queried from the *product* Meilisearch index at collection-index time | Display only. How many products are in this collection **or any of its descendants** — matches what `ProductService::list(ProductFilters(collectionId: ...))` would return, not just direct assignment. Computed via `Product::search('')->options(['filter' => "collection_ids = \"{id}\""])`, so it depends on the product index already being current — reindex products *before* collections (see "Gotchas" below). | + +`name`/`description` (and any other `TranslatedText` attribute) are indexed per-locale +by Lunar's base indexer and resolved by `CollectionService` exactly like +`ProductService` does — see `product-listing.md`'s "Locale resolution" section, same +logic, same `LanguageCache::defaultLocale()` fallback. + +--- + +## Usage + +```php +use Modules\Core\Catalog\DTOs\CollectionFilters; +use Modules\Core\Catalog\Enums\CollectionSort; +use Modules\Core\Catalog\Services\CollectionService; + +$service = app(CollectionService::class); + +// Top-level collections only (parent_id IS NULL) — for building a nav tree +$roots = $service->list( + filters: new CollectionFilters(rootOnly: true), + sort: CollectionSort::Position, +); + +// Children of a specific collection +$children = $service->list( + filters: new CollectionFilters(parentId: 222), + sort: CollectionSort::Position, +); + +// Filter by collection group +$collections = $service->list(filters: new CollectionFilters(groupId: 4)); + +// Single collection, by primary key or slug +$collection = $service->getById(223); +$collection = $service->getBySlug('keychains'); +``` + +`CollectionFilters(parentId: ..., rootOnly: ...)` are mutually exclusive — if both are +set, `parentId` wins. There's no `parentId: null` shorthand for "root only", since +that would be ambiguous with "don't filter by parent at all" (the DTO's actual +default); `rootOnly` names the root-collections case explicitly instead. + +`CollectionSort::Position` (`_lft:asc`) is the recommended default for any nav/tree +UI — it matches the order an admin arranges collections in Lunar's own Filament UI. +`Name` and `Newest` are also available, mirroring `ProductSort`'s shape. + +--- + +## Registration + +Like `ProductIndexer`, `CollectionIndexer` must be registered in the consuming app's +own `config/lunar/search.php`: + +```php +'indexers' => [ + Lunar\Models\Collection::class => Modules\Core\Catalog\Services\CollectionIndexer::class, + // ... +], +``` + +New/changed fields aren't filterable/sortable in Meilisearch until `php artisan +lunar:meilisearch:setup` re-syncs index settings, and existing documents need +`lunar:search:index --refresh` to pick up the new shape. If `SCOUT_QUEUE` is enabled, +the queue worker also needs restarting after deploying changes to the indexer class — +see `docs/lunar.md` "Gotchas". + +**`product_count` needs the product index reindexed first.** `config/lunar/search.php`'s +`indexers` array is typically ordered `Collection` before `Product`, so a plain +`lunar:search:index --refresh` computes `product_count` against whatever the product +index held *before* this run — stale if products changed too. `lunar:search:index` +takes an explicit model list as its argument (`--ignore` restricts it to only those), +so reindex products first, then collections, when both need a fresh `--refresh` in the +same deploy: + +``` +php artisan lunar:search:index "Lunar\Models\Product" --ignore --refresh +php artisan lunar:search:index "Lunar\Models\Collection" --ignore --refresh +``` + +--- + +## When to still use Eloquent directly + +A single collection's full detail page (breadcrumb via `$collection->breadcrumb`, +tree ancestors/descendants, route-model-bound `Collection $collection` in a +controller signature) should keep reading Eloquent directly rather than going through +`CollectionService` — the indexed document doesn't carry ancestor chains or the full +nested-set relations, and route-model binding already gives a controller the full +model for free. `CollectionService` is for browsing/listing and lightweight +by-id/by-slug lookups where a full Eloquent hydration would be wasteful, the same +tradeoff `ProductService` makes for products. diff --git a/docs/localization.md b/docs/localization.md index 18fe74d..abf98c7 100644 --- a/docs/localization.md +++ b/docs/localization.md @@ -50,7 +50,7 @@ fine — just keep admin/Livewire/webhook routes registered outside of it (as th ## Behavior -`Modules\Core\Localization\LocaleMiddleware`: +`Modules\Core\Localization\Middleware\LocaleMiddleware`: 1. Reads the first path segment (`request()->segment(1)`). 2. Matches it against `Lunar\Models\Language::code`. @@ -68,7 +68,7 @@ and invalidated automatically. Adding, editing, or removing a language via the F ### How invalidation is wired (event-driven, not the observer itself) -`Modules\Core\Localization\LanguageCacheObserver` observes `Lunar\Models\Language`'s +`Modules\Core\Localization\Observers\LanguageCacheObserver` observes `Lunar\Models\Language`'s `created`/`updated`/`deleted` Eloquent events, but it's a thin trigger only — it doesn't do any invalidation work itself. It dispatches one of three events from `Modules\Core\Localization\Events` (`LanguageCreated`, `LanguageUpdated` — carrying the old @@ -105,6 +105,33 @@ $language = $request->attributes->get('language'); // Lunar\Models\Language in Use `$language->id` when querying Lunar's translatable content (e.g. `Url::where('language_id', ...)`). +### Shared view data — language switcher and `hreflang` tags + +The middleware also shares two variables with every view, via `View::share()`, so a layout's +language switcher or `hreflang` tags don't have to recompute the language list themselves: + +```blade +{{-- current locale --}} +{{ $currentLocale }} {{-- e.g. "el" --}} + +{{-- every OTHER configured language, each with its own URL for the current page --}} +@foreach ($altLocales as $altLocale) + {{ $altLocale['name'] }} +@endforeach +``` + +`$altLocales` is a **collection**, not a single value — deliberately, so it scales to any number +of configured languages rather than assuming exactly two. Each entry is a plain array: + +| Key | Description | +|---|---| +| `code` | The language's `Lunar\Models\Language::code` (e.g. `en`) | +| `name` | The language's display name | +| `url` | The **current route**, re-generated with that language's code — via `route($routeName, [...])` when the current request matched a named route, or a bare `/{code}` fallback otherwise | + +A 3+ language store gets one `$altLocales` entry per additional language automatically — nothing +about this shape assumes or special-cases a two-language store. + --- ## Single-language shops @@ -151,12 +178,41 @@ namespaced groups so nothing collides. `__()` resolves the translation for whate `App::getLocale()` currently is, which `LocaleMiddleware` already sets per-request (see "Behavior" above) — no extra wiring needed between the two systems. +### Fallback locale follows the store's default language, not `config('app.fallback_locale')` + +`spatie/laravel-translation-loader`'s stock `LanguageLine::getTranslation()` falls back to +`config('app.fallback_locale')` — a static `.env` value — when a key has no text for the current +locale. That's a second, disconnected "default language" concept: an admin changing the default +language via the Filament **Languages** resource has no effect on it, so an untranslated label +could silently fall back to the wrong language. + +`Modules\Core\Localization\Models\LanguageLine` overrides `getTranslation()` to fall back to +`LanguageCache::defaultLocale()` instead — the same `languages.default` flag `LocaleMiddleware` +already treats as the single source of truth. It's swapped in via +`config('translation-loader.model')` (the package's own documented extension point for +"any model that extends `LanguageLine`"), set in `LocalizationServiceProvider::register()` so it +wins regardless of provider boot order (Laravel's `mergeConfigFrom()` only fills in config keys +not already set, so an explicit `register()`-time set always beats the package's own default). +No consuming app configuration needed — this is automatic once `LocalizationServiceProvider` is +registered. + ### Seeding A starter set of common e-shop labels (`nav.*`, `cart.*`, `product.*`, `auth.*`, `search.*`, -English + Greek) is seeded by `Modules\Core\Command\InstallLunarCommand` (overrides Lunar's own -`lunar:install`), guarded by `LanguageLine::where('group', 'storefront')->exists()` — same -idempotent pattern as the rest of that command, safe to run unattended on every boot. +`review.*`, `shop.*`, `pagination.*`, English + Greek) lives in +`Modules\Core\Localization\Services\StorefrontLabels::all()` — kept as its own class, separate +from the seeding logic, so the label list can be scanned/diffed without wading through the +seeding mechanics. + +`Modules\Core\Command\InstallLunarCommand` (overrides Lunar's own `lunar:install`) seeds them via +a **per-key upsert**, not an all-or-nothing "only seed if the group is empty" guard: a key already +present in the database — including one an admin has since edited via the Filament **Language +Lines** resource — is left untouched; only keys missing entirely are created. This is what makes +it safe to add new keys to `StorefrontLabels::all()` later and re-run `lunar:install` on an +already-installed store, without either silently skipping the new keys (the old guard's behavior) +or reverting an admin's edits back to the hardcoded default (what a naive `updateOrCreate` would +do). New writes go through `TranslationService::create()`, so the usual cache-invalidation and +activity-log events fire for them too. ### Admin UI @@ -168,13 +224,13 @@ a third language automatically adds a third input, no resource changes needed. ### `TranslationService` — writes go through here, not the model directly -`Modules\Core\Localization\TranslationService` wraps create/update/delete on `LanguageLine` and +`Modules\Core\Localization\Services\TranslationService` wraps create/update/delete on `LanguageLine` and dispatches a domain event after each write, following this project's standard event-driven pattern (see `modules.md`'s "Splitting Service Providers" / event-listener convention — the same shape as `Modules\Core\Auth\Events\UserCreated`): ```php -use Modules\Core\Localization\TranslationService; +use Modules\Core\Localization\Services\TranslationService; app(TranslationService::class)->create('storefront', 'nav.wishlist', [ 'en' => 'Wishlist', diff --git a/docs/lunar.md b/docs/lunar.md index 9e97e70..f21eb27 100644 --- a/docs/lunar.md +++ b/docs/lunar.md @@ -554,7 +554,11 @@ Customer resolution order: session → `$user->latestCustomer()`. ```php use Lunar\Facades\CartSession; -$cart = CartSession::current(); // calculates totals; returns null if no cart +$cart = CartSession::current(); // returns null unless a cart already exists in + // session — does NOT auto-create one (see Gotchas) +$cart = CartSession::manager(); // force-creates a cart if none exists yet — use + // this (or __call forwarding, see Gotchas) for + // "give me a cart to add to" flows $cart->recalculate(); // force recalculation CartSession::createOrder(); // creates order, removes cart from session @@ -563,6 +567,39 @@ CartSession::forget(); // clear session (soft deletes cart by def CartSession::forget(delete: false); // clear session, keep cart in DB ``` +Session/identity: the active cart's id is stored under session key `lunar.cart_session.session_key` +(default `lunar_cart`). `CartSession`'s underlying manager (`Lunar\Managers\CartSessionManager`) — +not `Lunar\Base\CartSessionInterface`, which is stale/incomplete, see Gotchas — resolves the current +cart from that session key, falling back to the authenticated user's active cart +(`$user->carts()->active()->first()`) if the session has none. + +### `config/lunar/cart_session.php` + +| Key | Default | Meaning | +|---|---|---| +| `session_key` | `'lunar_cart'` | Laravel session key storing the active cart id. | +| `auto_create` | `false` | Whether `CartSession::current()` auto-creates a cart when none exists — it does **not**, by default (see Gotchas). | +| `allow_multiple_orders_per_cart` | `false` | If false, a cart with a completed order is abandoned in favor of a fresh cart on next fetch. | +| `delete_on_forget` | `true` | Whether `forget()` (called on logout) soft-deletes the cart — see the auth-policy note above. | + +### `config/lunar/cart.php` (cart-line-relevant keys) + +| Key | Default | Meaning | +|---|---|---| +| `auth_policy` | `'merge'` | Guest→user cart reconciliation on login: `merge` or `override`. | +| `pipelines.cart` | `CalculateLines, ApplyShipping, ApplyDiscounts, CalculateTax, Calculate` | Steps run on `$cart->calculate()`. | +| `pipelines.cart_lines` | `[GetUnitPrice::class]` | Steps run per-line before cart-level calc. | +| `actions.add_to_cart` | `AddOrUpdatePurchasable::class` | Swappable action behind `Cart::add()`. | +| `actions.get_existing_cart_line` | `GetExistingCartLine::class` | Line-matching logic for add-or-merge (see "Adding items" above). | +| `actions.update_cart_line` | `UpdateCartLine::class` | Behind `Cart::updateLine()`. | +| `actions.remove_from_cart` | `RemovePurchasable::class` | Behind `Cart::remove()`. | +| `validators.add_to_cart` | `[CartLineQuantity, CartLineStock]` | Run before add. | +| `validators.update_cart_line` | `[CartLineQuantity, CartLineStock]` | Run before update. | +| `validators.remove_from_cart` | `[]` | None by default. | +| `eager_load` | 7 relation paths (currency, `lines.purchasable.*`, `lines.cart.currency`) | Auto-eager-loaded whenever the session manager fetches a cart by id. Does **not** include `addresses`/`shippingAddress`/`billingAddress`, `discounts`, or `customer` — add these yourself if needed, to avoid N+1s. | +| `prune_tables.enabled` | `false` | Whether scheduled cart pruning runs. | +| `prune_tables.prune_interval` | `90` (days) | Age threshold for pruning. | + ### Adding items ```php @@ -573,6 +610,11 @@ $cart->addLines([ ]); ``` +`add()` matches an existing line by purchasable **and exact `meta` equality** (config +`lunar.cart.actions.get_existing_cart_line`, default `GetExistingCartLine`) — if it matches, the +existing line's quantity is incremented instead of a new line being created; any difference in +`meta` (e.g. a different chosen option) makes it a separate line for the same purchasable. + ### Updating and removing ```php @@ -664,6 +706,14 @@ class MyPipeline `merge` — guest cart items combine with user's existing cart on login. `override` — guest cart replaces user's cart. +This is wired via `Lunar\Listeners\CartSessionAuthListener`, listening on Laravel's own +`Illuminate\Auth\Events\Login`/`Logout`. On login, if the session already has a cart with no +`user_id` yet, it associates that cart to the user (running the policy above); if the session has +no cart at all, it looks up and resumes the user's own active cart instead. **On logout, it calls +`CartSession::forget()`** — which, per `cart_session.delete_on_forget` (default `true`), **soft- +deletes the cart**. A logged-in customer's cart is gone on logout unless that config is set to +`false`. + ### Shipping options ```php @@ -1206,6 +1256,13 @@ Real bugs/traps hit while building against Lunar in this package — not obvious - **`ProductOption.handle` must be unique and non-null if a product has more than one option.** Lunar's Filament variant-switcher widget does `SelectFilter::make($option->handle)` per option — two options with a `null`/matching handle throws "Filter must have a unique name" as a 500 when opening that product's variant pricing page. Always derive a slug and check uniqueness. - **`Attribute.position` is per-group, and the panel sorts by it.** Hardcoding `position => 1` for multiple new attributes in the same group makes their order undefined/collide with existing attributes at position 1. Compute `max('position') + 1` per group instead. - **Currency `decimal_places` isn't always 2.** A seeded/demo currency can have the wrong value (seen: EUR seeded with `decimal_places = 1`), which silently corrupts every price display (`€16.50` renders as `165`). If prices look wrong by a factor of 10, check the currency row before assuming the price-writing code is broken. -- **`Builder::paginateRaw()`'s `items()` is not a hit list on the Meilisearch driver.** It contains the *entire* raw response (`hits`, `query`, `processingTimeMs`, `hitsPerPage`, `page`, `totalPages`, `totalHits`) as one associative array. Treating `$paginator->items()` as a plain list (e.g. `collect($paginator->items())->values()`) silently produces 7 elements — the real hits array happens to land first, the rest are stray scalars from the other response keys — no error, just corrupted data. Pull `$paginator->items()['hits']` explicitly. `total()`/`perPage()`/`currentPage()`/`lastPage()` on the paginator are unaffected. See `Modules\Core\Catalog\ProductService` / `docs/product-listing.md`. -- **`ProductOption`/`ProductOptionValue::$name` is not `attribute_data` — `translateAttribute('name')` silently returns null for them.** Unlike `Product`/`Collection`/`Brand`, their translated `name` is a plain locale-keyed array cast (`AsArrayObject`) directly on the column, not stored in `attribute_data`. `HasTranslations::translateAttribute()` only reads `attribute_data`, so calling it on these two models compiles fine and returns `null` with no error — read the array directly instead (`$value->name[$locale] ?? ...`). See `Modules\Core\Search\ProductIndexer::translatedName()`. +- **`Builder::paginateRaw()`'s `items()` is not a hit list on the Meilisearch driver.** It contains the *entire* raw response (`hits`, `query`, `processingTimeMs`, `hitsPerPage`, `page`, `totalPages`, `totalHits`) as one associative array. Treating `$paginator->items()` as a plain list (e.g. `collect($paginator->items())->values()`) silently produces 7 elements — the real hits array happens to land first, the rest are stray scalars from the other response keys — no error, just corrupted data. Pull `$paginator->items()['hits']` explicitly. `total()`/`perPage()`/`currentPage()`/`lastPage()` on the paginator are unaffected. See `Modules\Core\Catalog\Services\ProductService` / `docs/product-listing.md`. +- **`ProductOption`/`ProductOptionValue::$name` is not `attribute_data` — `translateAttribute('name')` silently returns null for them.** Unlike `Product`/`Collection`/`Brand`, their translated `name` is a plain locale-keyed array cast (`AsArrayObject`) directly on the column, not stored in `attribute_data`. `HasTranslations::translateAttribute()` only reads `attribute_data`, so calling it on these two models compiles fine and returns `null` with no error — read the array directly instead (`$value->name[$locale] ?? ...`). See `Modules\Core\Catalog\Services\ProductIndexer::translatedName()`. - **A running `queue:work` process does not pick up an edited/newly-added Scout indexer class.** It loads PHP classes once at boot and keeps them for the process's lifetime. Symptoms: reindexing commands succeed with no errors, calling `toSearchableArray()` directly (e.g. via `artisan tinker`, which always boots fresh) returns the new fields correctly, but documents written via `$model->searchable()` through the live queue are still missing them. Restart the queue worker after deploying an indexer change — no code fix needed. +- **`CartSession::current()` returns `null` for a fresh visitor by default.** `cart_session.auto_create` defaults to `false`, so nothing auto-creates a cart just from checking `current()`. Use `CartSession::manager()` (force-creates) for an "add to cart" flow, or rely on the fact that `add()`/`remove()`/etc. auto-create via `__call` forwarding (next entry) — don't gate an add-to-cart button on `current() !== null`, it will be null for every guest who hasn't added anything yet. +- **`CartSession`'s facade/interface don't declare `add()`, `remove()`, `updateLine()`, `clear()`, etc. at all — they work anyway, via `__call` magic.** `CartSessionManager::__call()` forwards any undeclared method call straight to the underlying `Cart` model (auto-creating one first if needed). So `CartSession::add($variant, 2)` genuinely works, but neither the facade's `@method` docblock nor `Lunar\Base\CartSessionInterface` mention it — reading either in isolation makes it look unsupported. Trust the manager's source (`Lunar\Managers\CartSessionManager`), not the interface, which is also missing several real methods (`manager()`, `createOrder()`, the shipping-estimate methods) and has a stale signature for `current()`. +- **`Cart::calculate()` is a no-op if totals already look populated — even right after you mutated lines with raw Eloquent.** It's memoized via `isCalculated()` (true when `total` and every line's `total` are non-blank). Every built-in mutator (`add`, `remove`, `updateLine`, `clear`, `associate`, …) already calls `$this->refresh()->recalculate()` to force past this memo — but custom code that touches `CartLine` rows directly (raw `update()`, a queued job, a migration) must call `$cart->recalculate()` itself, or `total`/`subTotal`/etc. silently stay stale. +- **`CartLine`'s computed properties (`unitPrice`, `subTotal`, `total`, `taxAmount`, …) are plain public properties, not DB columns or Eloquent attributes.** A raw `CartLine::find($id)` (no `calculate()` having run on its owning cart) has all of these as `null`/unset — they only populate as a side effect of the owning `Cart`'s pipeline running. Don't read them off a line fetched outside of `CartSession`/`Cart::add()` etc. without calling `$cart->calculate()` first. +- **Logging out deletes the cart by default.** `CartSessionAuthListener::logout()` calls `CartSession::forget()`, and `cart_session.delete_on_forget` defaults to `true` — so a logged-in customer's cart is soft-deleted the moment they log out, guest or not. Set `delete_on_forget` to `false` in `config/lunar/cart_session.php` if carts should survive a logout. +- **Lunar dispatches no cart events at all** — no "item added," "cart created," "line removed," nothing under `Lunar\Events\Cart*`/`CartLine*` exists (unlike products/collections, which have their own Scout indexing hooks). The only reactive surface is `CartLineObserver` (`creating`/`updating`, and it only validates the purchasable type — doesn't dispatch anything). If a feature needs to react to cart changes (reindexing, abandoned-cart notifications, analytics), it has to be built from scratch on plain Eloquent model events (`CartLine::created`, etc.) — there's no Lunar-native pattern to hook into. +- **No Filament admin resource exists for `Cart`/`CartLine`.** Carts aren't visible anywhere in the admin panel except indirectly through an order's `cart` relationship once that cart has become an order. Don't assume there's an admin cart-viewer to check against when debugging — there isn't one. diff --git a/docs/payments.md b/docs/payments.md new file mode 100644 index 0000000..31bdde6 --- /dev/null +++ b/docs/payments.md @@ -0,0 +1,189 @@ +# Payment — Design Notes + +**Status: abstraction layer built, drivers/wiring in progress.** `Payment` is designed as a +standalone module: it never calls into `Checkout` or `Order`, never touches their Eloquent +models, and communicates only via events. This document is the design spec for that +abstraction — contracts, DTOs, events — independent of how `Checkout`/`Order` end up consuming +it (that wiring is a separate, later pass). + +--- + +## Operations, not gateways + +The driver contracts model the actual operations a payment gateway can perform, not vendor +terminology. Every real gateway checked while designing this converges on the same small set +under different names: + +| Operation | Mastercard | Stripe | Nexi | +|---|---|---|---| +| Atomic charge (authorize+capture in one call) | `Pay` | `capture_method: automatic` | `ActionType::PAY()` | +| Hold only, settle/release later | `Authorize` | `capture_method: manual` | `ActionType::PREAUTH()` | +| Settle a prior hold | `Capture` | `PaymentIntent::capture()` | `CaptureRequest`/`CaptureResponse` | +| Release a prior hold without settling | `Void`/`Cancel` | `PaymentIntent::cancel()` | `CancelRequest`/`CancelResponse` | +| Reverse settled funds | `Refund` | `Refund::create()` | (refund endpoint) | + +A driver implements only the interfaces its gateway actually supports: + +- An offline/cash type (`cash-on-delivery`, `cash-in-hand`) only ever settles atomically — + implements `SupportsPay` alone. +- A card gateway capable of either mode per-transaction (Stripe, most card processors) + implements `SupportsPay`, `SupportsAuthorization`, `SupportsCaptures`, `SupportsVoids`, and + `SupportsRefunds` all at once — which one gets *called* for a given attempt is the caller's + policy choice (e.g. `config('lunar.stripe.policy')`), not something baked into the driver's + shape. +- A redirect/wallet gateway with no separate hold step (Viva/Klarna in typical flows) + implements `SupportsPay` and `SupportsRefunds`, never `SupportsCaptures`/`SupportsVoids`. + +### `pay()` and `authorize()` stay separate methods even when a gateway implements both as "the same call with a flag" + +Stripe has no separate `authorize`/`pay` API endpoints — one `PaymentIntent`, confirmed with +either `capture_method: automatic` or `manual`. Mastercard and Nexi *do* have genuinely +separate operations. The contract abstracts over both shapes uniformly: every driver capable +of both exposes two distinct methods, `pay()` and `authorize()`. A Mastercard-style driver +calls two different endpoints under the hood; a Stripe-style driver calls the same endpoint +twice with a different flag each time. Neither difference is visible to a caller. + +### `capture()`/`void()` are only ever valid against a prior `authorize()` + +They are not standalone operations — `capture()` settles a specific hold identified by the +`reference` `authorize()` returned; `void()` releases that same hold instead. A driver that +never implements `SupportsAuthorization` never produces a reference either of these methods +could act on. + +--- + +## `PaymentResult` — the one return shape, every operation, every driver + +```php +enum PaymentResultStatus { case Succeeded; case Failed; case Pending; } + +final class PaymentResult { + public function __construct( + public readonly PaymentResultStatus $status, + public readonly string $reference, + public readonly int $amount, + public readonly ?string $failureReason = null, + public readonly bool $retriable = false, + public readonly array $raw = [], + public readonly array $meta = [], + ) {} +} +``` + +Real gateway responses vary wildly in richness — confirmed by reading three SDKs directly: + +- **Stripe's `PaymentIntent`** is rich: `status`, `amount`, `amount_capturable`, + `amount_received`, `last_payment_error`, a full `getLastResponse()`. +- **Nexi's `CaptureResponse`/`CancelResponse`** are minimal: just `operationId` + + `operationTime` — no echoed amount or status at all. Success is inferred from getting a + response rather than an SDK exception. +- **Mastercard's** gateway sits in between, with `gatewayCode`/`acquirerCode`/ + `merchantAdviceCode`. + +`PaymentResult` only requires what every driver can always know: `status`, `reference`, +`amount` (the amount **we** requested — not necessarily echoed back by a sparse gateway like +Nexi's capture). Everything else is best-effort: `failureReason`/`retriable` are normalized +only when the gateway has something to normalize from; `raw` is the unconditional escape +hatch — the untouched gateway response body, always populated, for genuine audit fidelity +regardless of how sparse the normalized fields ended up. + +### `retriable` — real on some gateways, absent on others + +Stripe classifies declines as soft (`do_not_honor`, `insufficient_funds` — worth retrying, +after a delay) vs. hard (`stolen_card`, `expired_card` — never retry the same method). +Mastercard has the equivalent via `authorizationResponse.merchantAdviceCode` and card-scheme +soft-decline codes. **Nexi has no such signal at all** — `OperationResult` is just +`DECLINED`/`DENIED_BY_RISK`/`FAILED`/etc. with no retriability classification. `retriable` +therefore defaults to `false` (assume not safely retriable) rather than guessing when a +driver's gateway has nothing to base it on. + +--- + +## Events — one terminal pair per operation, keyed to the business fact, not the call path + +`Modules\Core\Payment\Events`: + +| Event pair | Dispatched by | +|---|---| +| `PaymentAuthorized` / `PaymentAuthorizationFailed` | `SupportsAuthorization::authorize()`, or a later `HandlesPaymentCallback::handleCallback()` resolving it | +| `PaymentCaptured` / `PaymentCaptureFailed` | `SupportsPay::pay()` **or** `SupportsCaptures::capture()` | +| `PaymentVoided` / `PaymentVoidFailed` | `SupportsVoids::void()` | +| `PaymentRefunded` / `PaymentRefundFailed` | `SupportsRefunds::refund()` | + +`PaymentCaptured` is deliberately the *same* event whether money was taken via `pay()` (one +gateway call) or `authorize()` → `capture()` (two calls) — "a payment has been captured" is +the same business fact either way, and a listener reacting to it never needs to know which +path produced it. There is no separate "payment succeeded" wrapper event distinct from +`PaymentCaptured`. + +Every event carries `{type: string, result: PaymentResult, context: array}`. `Payment` has no +concept of a `Cart`, an `Order`, or a checkout fingerprint — `$context` is an opaque bag the +caller hands in on the way down (`pay($type, $data, $context)`) and gets back untouched on +whichever event that call (or a later `handleCallback()`) produces. Each listener interprets +`$context` on its own terms, or ignores the event if the keys it needs aren't present — +`Checkout` is only one possible consumer of these events, not the only one. + +--- + +## Async resolution — `HandlesPaymentCallback` + +Only implemented by a driver whose `pay()`/`authorize()` can return `PaymentResultStatus::Pending` +— a redirect the shopper completes elsewhere, a webhook that arrives later. A driver whose +gateway always resolves synchronously never implements this. + +```php +public function handleCallback(string $reference, array $data, array $context = []): PaymentResult; +``` + +Resolves into the *same* event pair the original `pay()`/`authorize()` call would have +produced had it resolved synchronously. + +### The correlation problem: `handleCallback()` runs in a different request + +`$context` passed into the original `pay()`/`authorize()` call does not survive to +`handleCallback()` on its own — that call is typically a separate HTTP request (a webhook) +with no memory of the request that started the payment. Something has to persist enough to +answer "which order/cart does gateway reference X belong to?" between the two calls. + +**Read directly from `lunarphp/stripe`'s own source** (`StripePaymentType::authorize()`, +`ProcessStripeWebhook`, `WebhookController`) to see how Lunar itself solves this — confirmed +it does **not** stash a generic opaque blob. It writes the correlating ids as real, typed +columns on `Lunar\Stripe\Models\StripePaymentIntent` (`cart_id`, `order_id`) at the moment the +intent is created/first seen, then reads them back the same way when the webhook arrives: + +```php +// ProcessStripeWebhook::handle() — falls back through two real lookups, +// neither of them a generic context blob: +$cart = StripePaymentIntent::where('intent_id', $this->paymentIntentId)->first()?->cart + ?: Cart::where('meta->payment_intent', '=', $this->paymentIntentId)->first(); +``` + +**`StripePaymentDriver` follows this exact precedent**: it reads `cart_id`/`order_id` out of +`$context` at `pay()`/`authorize()` time and writes them onto its own `StripePaymentIntent` +row (a table already owned by `lunarphp/stripe`, already shaped for exactly this), then reads +them back the same way in `handleCallback()`. No generic `context` json column, no new table. + +### This pattern is per-driver, not a shared table + +`stripe_payment_intents` is Stripe-specific — keyed on `intent_id`, typed around +`Stripe\PaymentIntent`'s own status values. It cannot be reused as-is for a future non-Stripe +async driver (Nexi, Viva): that driver's own gateway reference has a different shape entirely, +and shoehorning it into Stripe-named columns would make the table misleading. The **pattern** +generalizes — *any* driver needing async callback resolution owns a small table keyed by its +own gateway's reference, storing whatever correlation data that driver specifically needs — +but each driver gets its own table, matching what it actually needs to correlate, rather than +a shared generic one. + +--- + +## Explicitly out of scope for this pass + +- **`Checkout`/`Order` wiring** — how `Checkout` calls into `Payment`, how `Order`/`Checkout` + react to `Payment`'s events, where a draft `Order` gets created relative to when `Payment` is + called. Deliberately designed and built separately, after `Payment` itself was complete — + `Payment` must stand on its own regardless of what ends up consuming it. +- **`Transaction` persistence** — Lunar's own `transactions` table (`type`: `intent`/`capture`/ + `refund`, `parent_transaction_id` chaining) already models the audit trail these events + would feed, once a listener is built to write to it. `Payment` itself does not write + `Transaction` rows — see the events table above; that is a listener's job, in whichever + module ends up owning the write (likely `Order`, since `Transaction.order_id` is required). diff --git a/docs/product-listing.md b/docs/product-listing.md index 7d2397d..02b4934 100644 --- a/docs/product-listing.md +++ b/docs/product-listing.md @@ -1,10 +1,11 @@ # Product Listing -`Modules\Core\Catalog\ProductService` provides catalog browsing/filtering AND single-product -lookup for a storefront — `list()`, `getById()`, `getBySlug()` — all reading directly from the -Meilisearch index rather than the database. One data source for everything this service does. +`Modules\Core\Catalog\Services\ProductService` provides catalog browsing/filtering AND single-product +lookup for a storefront — `list()`, `getById()`, `getBySlug()`, `random()`, `variantSummaries()` — +all reading directly from the Meilisearch index rather than the database. One data source for +everything this service does. -This is separate from `Modules\Core\Search\ProductSearchService` (see `product-search.md`), which +This is separate from `Modules\Core\Catalog\Services\ProductSearchService` (see `product-search.md`), which handles free-text query search. `ProductService` is for browsing/lookup without a search term. --- @@ -14,7 +15,7 @@ handles free-text query search. `ProductService` is for browsing/lookup without Every method here reads Meilisearch documents directly and returns plain arrays — never Scout's `->get()`, which would re-hydrate Eloquent models from the database. This means the index has to carry everything a detail page needs (variants, prices, options, media, reviews — see below), not -just the trimmed fields a listing page needs. `Modules\Core\Search\ProductIndexer` is built to +just the trimmed fields a listing page needs. `Modules\Core\Catalog\Services\ProductIndexer` is built to carry that full shape. --- @@ -22,61 +23,129 @@ carry that full shape. ## Usage ```php -use Modules\Core\Catalog\ProductFilters; -use Modules\Core\Catalog\ProductService; +use Modules\Core\Catalog\DTOs\ProductFilters; +use Modules\Core\Catalog\Services\ProductService; +use Modules\Core\Catalog\Enums\ProductSort; $service = app(ProductService::class); -// List everything, paginated -$result = $service->list(perPage: 24, page: 1); +// One call for everything a listing page needs — products AND the price slider's +// bounds together, as a Modules\Core\Catalog\DTOs\ProductListingResult. A caller +// used to have to call list() and priceSliderBounds() (or the older priceRange()) +// separately and glue the results together itself; that's now list()'s own job. +$listing = $service->list(perPage: 24, page: 1); -// Filter by collection, brand, and/or price range -$result = $service->list( - filters: new ProductFilters(collectionId: 17, minPrice: 10.0, maxPrice: 50.0), +// Filter by collection, brand, price range, and/or stock +$listing = $service->list( + filters: new ProductFilters(collectionId: 17, minPrice: 10.0, maxPrice: 50.0, inStockOnly: true), perPage: 24, page: 1, ); -$result['data']; // array of Meilisearch documents (plain arrays, not models) -$result['meta']['total']; -$result['meta']['per_page']; -$result['meta']['current_page']; -$result['meta']['last_page']; +// Sort — cheapest/priciest first, or newest first. Omit for Meilisearch's default +// relevance ordering (irrelevant here since the query is always empty). +$listing = $service->list(perPage: 24, page: 1, sort: ProductSort::PriceAsc); + +$products = $listing->products; // a real Illuminate\Pagination\LengthAwarePaginator, + // built from the localized Meilisearch hits (not Scout's + // own paginateRaw() result — see "Meilisearch driver + // quirk" below), so it behaves like any other Laravel + // paginator. +$products->items(); // array of Meilisearch documents (plain arrays, not models) +$products->total(); +$products->perPage(); +$products->currentPage(); +$products->lastPage(); +$products->links(); // in a Blade view — renders pagination links as usual + +$bounds = $listing->priceBounds; // Modules\Core\Catalog\DTOs\PriceSliderBounds +$bounds->floor; // ?int — floor() of the matching range's minimum, in whole currency units +$bounds->ceil; // ?int — ceil() of the matching range's maximum +$bounds->filtered; // bool — whether the applied filters' minPrice/maxPrice actually + // narrow the slider below/above these bounds (drives whether a + // "clear filter" control should show) // Single product, by primary key $product = $service->getById(367); // array, or null if not found // Single product, by URL slug (any locale — slugs are indexed across all languages) $product = $service->getBySlug('erotika-mprelok'); // array, or null if not found + +// $limit random products — still scoped to the index's own default channel/status +// visibility, unlike Eloquent's Product::inRandomOrder() (which has no notion of +// that filtering at all). Meilisearch has no ORDER BY RANDOM() equivalent, so this +// pulls every matching id only, shuffles in PHP, then fetches the full localized +// documents for just the ids picked — see random()'s own docblock. +$randomProducts = $service->random(13); // array of documents, same shape as list()'s items + +// The id/price/image of every variant on a product document — the base price and +// thumbnail a variant picker/swatch list needs, without reaching into +// $product['variants'][n]['prices'][0]/['media'][0] yourself. +$variants = $service->variantSummaries($product); +// [['id' => 1204, 'price' => 19.99, 'image' => 'https://.../thumb.jpg'], ...] + +// Facet counts for a sidebar — value => matching product count, scoped to whatever +// $filters is passed. Does NOT exclude the faceted field itself from $filters — see +// facets()'s docblock for why, and how to build a standard "every option's count, +// unaffected by that option's own currently-selected value" sidebar. +$brandCounts = $service->facets('brand', filters: new ProductFilters(collectionId: 17)); +// ['3Dealer.gr - 3D printed creations' => 48, 'Kraniou Topos - 3D printed creations' => 135] + +// Min/max price across matching products — the raw, unrounded values list() itself +// uses to build priceBounds above. minPrice/maxPrice are ALWAYS excluded from the +// filter driving this (unlike facets(), which doesn't auto-exclude) — the slider's +// own bounds shouldn't shrink to whatever range is currently selected on it. Other +// filters (collectionId, brand, inStockOnly) still apply normally. Pass $query too +// to scope the range to a text search's own matches (see product-search.md) rather +// than the whole catalog. +$range = $service->priceRange(new ProductFilters(collectionId: 17)); +// ['min' => 0.0, 'max' => 120.0] ``` All `ProductFilters` fields are optional; only the ones set are added to the Meilisearch query. +`facets()` only makes sense on discrete-value filterable fields (`brand`, `in_stock`) — a numeric +field like `price` would return one "facet" per exact price, not a usable range bucket. Use +`priceRange()` (or `list()`'s own `priceBounds`) for `price` instead, which reads Meilisearch's +`facetStats` (min/max), a different feature from `facetDistribution`. + --- -## Fields this depends on: `Modules\Core\Search\ProductIndexer` +## Stock goes stale between orders + +`in_stock` reflects `ProductVariant::stock`/`purchasable` as of the **last reindex**, not live +inventory. Nothing in this codebase currently reindexes a product when an order decrements its +stock — that's a cart/checkout concern, not something `ProductIndexer` can solve on its own (see +`Modules\Core\Catalog\Observers\ProductOptionReindexObserver` for the equivalent pattern once an +order → stock → reindex pipeline exists to hook into). Until then, `in_stock`/`product_count` can +drift from the database the same way every other indexed field already can between writes. + +--- + +## Fields this depends on: `Modules\Core\Catalog\Services\ProductIndexer` Lunar's own `Lunar\Search\ProductIndexer` only carries listing-grade fields (name, description, status, brand, a single thumbnail, skus) and marks just `__soft_deleted`, `skus`, `status` as -filterable. `Modules\Core\Search\ProductIndexer` extends it to add everything `ProductService` +filterable. `Modules\Core\Catalog\Services\ProductIndexer` extends it to add everything `ProductService` needs, listing and detail alike: | Field | Source | Notes | |---|---|---| | `id` | — | Newly marked **filterable** — needed for `getById()`'s `id = "..."` filter; Meilisearch doesn't filter on the primary key by default. | -| `collections` | `$product->collections->pluck('id')` | Filterable. Array of collection IDs (as strings) — filtering matches by ID, not slug. | -| `collection_names` | `$product->collections` | Display only, not filterable — translated collection names. | +| `collections` | `$product->collections` | Array of `{id, name}` — directly assigned collections only, `name` is the translated collection name. Not filterable — see `collection_ids`. | +| `collection_ids` | `$product->collections` + `->ancestors` | Filterable. Flat array of every directly-assigned collection's id, unioned with all of its ancestors' ids. `ProductFilters(collectionId: ...)` filters against this field, not `collections`, since products are typically attached only to leaf collections — a plain direct-match filter would never return anything for a parent/root category page. | | `slugs` | `$product->urls->pluck('slug')` | Filterable. Every locale's `Url::slug` for the product, so `getBySlug()` resolves purely from the index — no database read. | +| `skus` | `$product->variants->pluck('sku')` | Filterable. Every variant's `sku`, deduplicated, empty ones dropped. Same "resolve from the index alone" reasoning as `slugs`, for a future SKU-based lookup/filter. | | `price` | Cheapest variant's base price | Filterable. Float in major units (e.g. `19.99`, not `1999`). Base price only — no customer group, default currency (`Currency::getDefault()`) only. `null` if the product has no priced variant yet, so it's excluded from range filters rather than treated as free. | | `brand` | Already indexed by Lunar's base indexer | Newly marked **filterable** — it existed in the document already, just wasn't usable in a `filter` clause. | | `tags` | `$product->tags->pluck('value')` | Display only. | | `media` | `$product->media` | Full gallery (id/url/thumb per image), not just the single thumbnail Lunar's base indexer sends. | -| `variants` | `$product->variants` | Per variant: `id`, `sku`, `stock`, `purchasable`, `options` (option/value names, in the current locale), `prices` (per currency/customer group), `media` (variant-specific images). | -| `reviews`, `review_count`, `average_rating` | `Modules\Core\Review\Models\ProductReview` | See "Reviews" below. | +| `variants` | `$product->variants` | Per variant: `id`, `sku`, `gtin`, `mpn`, `ean`, `stock`, `backorder`, `unit_quantity`, `purchasable`, `shippable`, `tax_ref`, `dimensions` (`length`/`width`/`height`/`weight`/`volume`, each `{value, unit}`), `options` (option/value names, in the current locale), `prices` (per currency/customer group), `media` (the variant's own images — `ProductVariant::images()`, a separate pivot from the product's own gallery above, populated by `ShopifyExportImporter` from Shopify's `Variant Image` CSV column). | +| `reviews` | `Modules\Core\Review\Models\ProductReview` | `{items, count, average_rating}` — see "Reviews" below. | +| `in_stock` | `$model->variants` | Filterable boolean. `true` if ANY variant currently passes `ProductVariant::canBeFulfilledAtQuantity(1)` — Lunar's own purchasability rule (`purchasable === 'always'` ignores stock entirely; `in_stock` checks `stock` alone; anything else checks `stock + backorder`). Only as fresh as the last reindex — see "Stock goes stale" below. | -`description` and other translated attributes are indexed as-is, including any HTML markup -(e.g. from a Shopify `Body (HTML)` import) — **not stripped**. Any view rendering a description -sourced from `ProductService`'s results must treat it as trusted HTML. +`name`/`description` (and any other `TranslatedText` attribute) are indexed per-locale — see +"Locale resolution" below for how `ProductService` resolves them down to one value per request. **`ProductOption`/`ProductOptionValue` names need a different translation accessor.** Unlike `Product`/`Collection`/`Brand`, their `name` is a plain locale-keyed array cast, not @@ -85,13 +154,41 @@ indexer's `translatedName()` reads the array directly instead. See `docs/lunar.m --- +## Locale resolution: `name`, `description`, and any other translated attribute + +Lunar's base `ScoutIndexer` explodes every `TranslatedText` attribute into one `{handle}_{locale}` +field per store language at index time (`name_el`, `name_en`, `description_el`, ... — and the same +for any custom translated attribute a store adds, e.g. `seo_title`/`seo_description`). Every raw +document in Meilisearch carries all of them side by side, since a document is written once but +read across many different-locale requests. + +`ProductService` resolves these back down to a single value per request. For every result it +returns (`list()`'s items, `getById()`, `getBySlug()`), it: + +1. Reads which `Product` attributes are `TranslatedText` from `Lunar\Base\AttributeManifest` — the + same source Lunar's own indexer reads — rather than a hardcoded `['name', 'description']` list, + so a store's own custom translated attributes are picked up automatically with no change here. +2. For each one, resolves `{handle}_{currentLocale}`, falling back to `{handle}_{storeDefaultLocale}` + (`LanguageCache::defaultLocale()`) if the current locale has no translation — e.g. a product with + no English copy yet still shows its Greek name on `/en/` rather than rendering blank. +3. Assigns the result to a plain `{handle}` key and **strips every raw `{handle}_{locale}` key** — + callers only ever see `$product['name']`/`$product['seo_title']`/etc., never the per-locale + fields the index actually stores. + +`description` and other translated attributes are otherwise indexed as-is, including any HTML +markup (e.g. from a Shopify `Body (HTML)` import) — **not stripped**. Any view rendering a +description sourced from `ProductService`'s results must treat it as trusted HTML. + +--- + ## Reviews -`Modules\Core\Review\Models\ProductReview` (`product_reviews` table) is indexed per-product as -`reviews` (array), plus `review_count` and `average_rating` (rounded to 1 decimal, `null` if the -product has no reviews). Only public-safe fields are included — **`reviewer_email` is deliberately -excluded**, it's PII with no storefront use. `reply`/`replied_at` (the staff response) are -included, since they're meant to be shown alongside the review. +`Modules\Core\Review\Models\ProductReview` (`product_reviews` table) is indexed per-product under +a single `reviews` key: `{items, count, average_rating}` — `items` is the array of reviews, +`average_rating` is rounded to 1 decimal (`null` if the product has no reviews). Only public-safe +fields are included on each item — **`reviewer_email` is deliberately excluded**, it's PII with no +storefront use. `reply`/`replied_at` (the staff response) are included, since they're meant to be +shown alongside the review. A review is created/edited independently of its product (a customer submission, a staff reply) — its own save doesn't touch the `Product` row, so the product's own model events never fire. @@ -113,13 +210,28 @@ variants don't. --- +## Sorting + +`ProductSort` (`Modules\Core\Catalog\Enums\ProductSort`) is a fixed enum of supported sort orders — +`PriceAsc`, `PriceDesc`, `Newest` — each mapping to a Meilisearch `sort` clause against a field +`Modules\Core\Catalog\Services\ProductIndexer::getSortableFields()` marks sortable (`price`, plus +`created_at`/`updated_at`/`skus`/`status` inherited from Lunar's base indexer). Adding a new +`ProductSort` case requires adding the matching field to `getSortableFields()` and re-syncing (see +below) — sortable attributes are index settings, not computed per-query, same as filterable ones. + +Omitting `sort` leaves Meilisearch's default ordering, which is meaningless here since `list()` +always searches with an empty query string (`Product::search('')`) — there's no relevance score to +rank by, so results come back in whatever order the index returns them absent an explicit sort. + +--- + ## Registering the indexer Not automatic — an app opts in via its own `config/lunar/search.php`: ```php 'indexers' => [ - Lunar\Models\Product::class => Modules\Core\Search\ProductIndexer::class, + Lunar\Models\Product::class => Modules\Core\Catalog\Services\ProductIndexer::class, // ...other model indexers unchanged ], ``` diff --git a/docs/product-options.md b/docs/product-options.md new file mode 100644 index 0000000..7ff203e --- /dev/null +++ b/docs/product-options.md @@ -0,0 +1,113 @@ +# Product Option Types + +Lunar's `ProductOption`/`ProductOptionValue` are generic by design — a "Color" option +and a "Size" option are both just a handle, a translated name, and a list of values. +Each `ProductOptionValue` carries a free-form `meta` jsonb column, but nothing in +Lunar's own admin UI exposes it — there's no way for an admin to, say, attach a hex +code to a "Red" value without editing the database directly. + +`Modules\Core\Catalog\Contracts\ProductOptionTypeInterface` describes how a category +of option behaves — what structured data its values carry in `meta`, and how an +admin edits that data — without introducing a new model. `ProductOption`/ +`ProductOptionValue` stay exactly as Lunar defines them. + +--- + +## Registering a type + +A shop registers a type class from its own service provider's `boot()`, the same +shape as `Modules\Core\Notification\NotificationRegistry`: + +```php +use Modules\Core\Catalog\Services\ProductOptionTypeManager; + +ProductOptionTypeManager::get()->register([ + \App\ProductOptions\ColorOptionType::class, +]); +``` + +Not a published config array — the mapping isn't per-`ProductOption`, so there's +nothing for a shop to *key* by. Instead, an admin picks a type per-option from a +dropdown on the `ProductOption` edit form itself (see below); the choice is stored +in `ProductOption::meta['option_type']`, deliberately **not** tied to the option's +`handle` (a shop's own handle naming — transliterated Greek, legacy import slugs — +shouldn't have to match a type's key). + +A `ProductOption` with no type selected behaves exactly as stock Lunar does — plain +name/position, no extra meta form. + +--- + +## Writing a type + +```php +namespace App\ProductOptions; + +use Filament\Forms\Components\ColorPicker; +use Modules\Core\Catalog\Contracts\ProductOptionTypeInterface; + +class ColorOptionType implements ProductOptionTypeInterface +{ + public static function getKey(): string + { + return 'color'; + } + + public function getMetaForm(): array + { + return [ + ColorPicker::make('meta.hex') + ->label('Color') + ->required(), + ]; + } +} +``` + +`getMetaForm()` returns Filament form components, keyed under `meta.*` dot notation +— the path they save to on `ProductOptionValue::meta` (cast as `AsArrayObject`, a +plain jsonb column). `getKey()` is the identifier used in the admin's "Option Type" +dropdown and in `ProductOption::meta['option_type']` — it has no relationship to the +`ProductOption::handle`. + +A reference implementation ships at `Modules\Core\Catalog\OptionTypes\ColorOptionType`, +registered automatically by `Modules\Core\Providers\CatalogServiceProvider` — no shop +setup needed for it to appear in the "Option Type" dropdown, though an admin still +has to pick it per-`ProductOption` for it to take effect. + +--- + +## How it's wired into the admin UI + +`Modules\Core\Catalog\Services\ProductOptionTypeManager` is a singleton registry: +- `get(): static` — the shared instance. +- `register(array $types): void` — registers one or more type classes, keyed + internally by `getKey()`. +- `unregister(string $key): void` +- `resolve(?string $key): ?ProductOptionTypeInterface` — looks up a registered type + by key (or `null` if no key / not found). +- `all(): array` — every registered type's class, keyed by + `getKey()`. + +Two extensions hook into Lunar's admin via its extension system +(`LunarPanel::extensions([...])`, registered in `CorePlugin`) — no forking of Lunar's +classes needed: + +- `Modules\Core\Catalog\Filament\Extensions\ProductOptionResourceExtension` extends + `Lunar\Admin\Filament\Resources\ProductOptionResource`'s own form with a `Select` + (`meta.option_type`) listing every enabled type's key. Shown only when at least one + type is enabled. +- `Modules\Core\Catalog\Filament\Extensions\ValuesRelationManagerExtension` extends + the "Values" tab's form. Its `extendForm()` reads + `$option->meta['option_type']` off the owning `ProductOption`, resolves it via + `ProductOptionTypeManager`, and appends `getMetaForm()`'s fields to the stock name + field. A `ProductOption` with no type selected gets the stock form unchanged. + +--- + +## Reading the value back + +Storefront code reads `ProductOptionValue::meta` like any other jsonb column — e.g. +`$value->meta['hex']` for a color swatch. `ProductOptionTypeManager` is an admin-side +concern only (describing *how to edit* the meta); nothing requires the storefront to +go through it to *read* the meta. diff --git a/docs/product-recommendations.md b/docs/product-recommendations.md new file mode 100644 index 0000000..2a391ed --- /dev/null +++ b/docs/product-recommendations.md @@ -0,0 +1,155 @@ +# Product Recommendations + +`Modules\Core\Catalog\Services\RecommendationService` computes "related products" for a given +product — a same-category pick today, with a random fallback, but built as a configurable chain of +strategies rather than one hardcoded rule. `Modules\Core\Catalog\Services\ProductIndexer` embeds +the result directly into each product's own Meilisearch document, so a product detail page renders +its recommendations with zero extra queries — same reasoning as `collections` (see +`docs/product-listing.md`). + +--- + +## The rule chain + +```php +use Modules\Core\Catalog\Services\RecommendationService; + +$recommendations = app(RecommendationService::class)->recommend($product, limit: 4); +// Illuminate\Support\Collection +``` + +`recommend()` walks `config('catalog.recommendation_rules')` in order, **topping up** from each +successive rule until `$limit` distinct products are collected or every rule is exhausted — it does +not stop at the first rule that returns *something*. If a product's category only has 3 other +products, `SameCategoryRule` contributes those 3 and `RandomRule` fills the last slot. A rule is +handed the ids already collected (`$exclude`, always including the source product's own id) so it +never wastes its own `$limit` budget re-suggesting something already picked, and the same product +is never returned twice even if two rules would both suggest it. + +Default chain (`config/catalog.php`): + +```php +'recommendation_rules' => [ + SameCategoryRule::class, // other products sharing $product's first collection + RandomRule::class, // universal fallback — always returns something as + // long as the store has more than one product +], +``` + +A consuming app publishes and edits this config to reorder, add, or remove rules — nothing about +the chain shape is hardcoded in `RecommendationService` itself. A new rule (same tag, best sellers, +"frequently bought together", ...) is a class implementing `Modules\Core\Catalog\Contracts\ +RecommendationRule`, added to the array: + +```php +interface RecommendationRule +{ + /** + * @param array $exclude ids to never return — the source product's own + * id, plus every id an earlier rule in the chain already picked + * @return Collection at most $limit products + */ + public function recommend(Product $product, int $limit, array $exclude): Collection; +} +``` + +Rules query Eloquent directly (`$product->collections->first()->products()`, `Product::query()`), +not `Modules\Core\Catalog\Services\ProductService` — see "Why not `ProductService`" below. + +--- + +## Why not `ProductService` + +Every other read path in `Modules\Core\Catalog` goes through `ProductService`, which reads +Meilisearch and resolves translated fields to whatever locale the *current request* is in (see +`docs/product-listing.md`, "Locale resolution"). Recommendation rules deliberately don't use it: +they run inside `ProductIndexer::toSearchableArray()`, at **index time** — there is no request, no +meaningful "current locale" to resolve against, and Meilisearch itself may be mid-write for the very +product being indexed. Rules return raw `Lunar\Models\Product` models instead; `ProductIndexer` +resolves what it embeds (`name` via `translateAttribute()`, `price` via the indexer's own +`cheapestPrice()`, `image` via its own `mapMedia()`) the same way it already does for the embedded +`collections` field — including that field's same accepted index-time-locale tradeoff (a +recommendation's embedded `name` reflects whatever locale was active when *that* product was last +indexed, not the viewer's current locale). + +--- + +## What's embedded, and why not just an id + +`ProductIndexer` embeds full card data per recommendation, not just an id: + +```php +$data['recommendations'] = [ + ['id' => 42, 'name' => 'Espresso Cup', 'price' => 12.5, 'image' => 'https://.../thumb.jpg'], + // ... +]; +``` + +This shape is deliberately exactly what `x-ui.product-card`/`x-product-grid` (3dealer's storefront +components) need — `name`, `price`, `image`, and an `id` the view resolves to a URL itself via +`route('product.show', ['id' => $rec['id']])`. A resolved `href` is **not** embedded: `product.show` +is locale-prefixed (`{locale}/products/{id}`), so a URL baked in at index time would be correct only +for whichever locale happened to be active during that index run — wrong for every other locale. +Building the URL is left to the view, which knows the current request's locale. + +`recommendations.id` is marked **filterable** — not for the storefront, but for the reverse-lookup +reindexing below. + +--- + +## Keeping it fresh: `ProductSaved` / `ProductDeleted` + +A recommendation is computed once, at index time, and embedded — it does not update itself when the +recommended product later changes name, price, or image, or is deleted. Unlike `Modules\Core\Catalog\ +Observers\ProductOptionReindexObserver`'s equivalent problem (which product option value is used by), +there is no Postgres relation for "which products currently recommend product X" — a recommendation +only exists inside Meilisearch. The fix is a reverse Meilisearch filter query, not a database join, +wired through a real event → listener pair (`Modules\Core\Providers\CatalogServiceProvider`): + +- `Product::saved()` dispatches `Modules\Core\Catalog\Events\ProductSaved`. +- `Product::deleted()` dispatches `Modules\Core\Catalog\Events\ProductDeleted` — fires for both a + soft delete and a force delete (`Lunar\Models\Product` uses `SoftDeletes`), the same model event + Laravel Scout's own `ModelObserver` hooks to make a deleted product `unsearchable()`. +- `Modules\Core\Catalog\Listeners\ReindexProductsRecommendingProduct` handles both: it searches the + product index for `recommendations.id = "{id}"`, finds every referencing product, and calls + `->searchable()` on each — which recomputes their `recommendations` field fresh, picking up the + changed name/price/image, or (for a delete) dropping the now-gone product and topping back up to + the configured limit via the rule chain, same as any other reindex. + +`->searchable()` dispatches Scout's own reindex job, queued if `SCOUT_QUEUE` is configured — this +listener does no synchronous Meilisearch writing itself. + +**Product creation is deliberately not hooked into this.** A brand-new product has no +`recommendations` of its own until Scout's existing create-triggered indexing runs (already correct +— nothing to add). What's *not* immediate is other products picking the new one up as a fresh +recommendation candidate — that happens on their own next natural reindex (a save, or the nightly +full reindex below), the same accepted staleness window `docs/product-listing.md` already documents +for `in_stock`/`price`. A full proactive "who could now recommend this new product" pass was +considered and rejected as unnecessary cost for a cosmetic delay. + +--- + +## Nightly full reindex + +`Modules\Core\Providers\CatalogServiceProvider` schedules `lunar:search:index "Lunar\Models\Product" +--refresh` daily at 03:00 — a safety net on top of the event-driven reindexing above, not a +replacement for it. Catches what event-driven reindexing deliberately doesn't cover: a newly-created +product not yet appearing as a recommendation elsewhere, and any other drift already accepted +between reindexes (see `docs/product-listing.md`, "Stock goes stale between orders"). `--refresh` +also re-syncs filterable/sortable index *settings*, not just documents, so a deploy that changed +`ProductIndexer`'s field list self-heals overnight even if `lunar:meilisearch:setup` wasn't run +manually right after that deploy. + +--- + +## Re-syncing after this change + +Same as any other `ProductIndexer` field change (see `docs/product-listing.md`): + +```bash +php artisan lunar:meilisearch:setup +php artisan lunar:search:index "Lunar\Models\Product" --refresh +``` + +Restart the queue worker if `SCOUT_QUEUE=true` — see `docs/product-listing.md`'s "Re-syncing after +this change" for why a running worker won't otherwise pick up the new indexer code. diff --git a/docs/product-search.md b/docs/product-search.md index 8f3a98b..aceb157 100644 --- a/docs/product-search.md +++ b/docs/product-search.md @@ -1,6 +1,6 @@ # Product Search -`Modules\Core\Search\ProductSearchService` provides locale-aware full-text product search on +`Modules\Core\Catalog\Services\ProductSearchService` provides locale-aware full-text product search on top of Laravel Scout + Meilisearch. --- @@ -24,36 +24,62 @@ merges `$builder->options` directly into the search request). ## Usage ```php -use Modules\Core\Search\ProductSearchService; +use Modules\Core\Catalog\DTOs\ProductFilters; +use Modules\Core\Catalog\Enums\ProductSort; +use Modules\Core\Catalog\Services\ProductSearchService; $results = app(ProductSearchService::class)->search('running shoes'); -// or an explicit locale, bypassing App::getLocale(): -$results = app(ProductSearchService::class)->search('running shoes', 'el'); + +// Filters/sort apply the exact same semantics ProductService::list() uses for +// collection browsing (same ProductFilterBuilder, same ProductSort) — a shopper +// narrowing a text search by price/brand/stock gets identical filter behavior +// to narrowing a category listing. +$results = app(ProductSearchService::class)->search( + 'running shoes', + filters: new ProductFilters(brand: 'Acme', minPrice: 20.0, inStockOnly: true), + sort: ProductSort::PriceAsc, +); ``` Returns an `Illuminate\Database\Eloquent\Collection` of `Lunar\Models\Product` — Scout's `->get()` hydrates real models from the database after the Meilisearch query, so relations (`variants`, `brand`, `media`, etc.) are available on the results as normal. -`$locale` defaults to `App::getLocale()` — already set correctly on every storefront request by -`Modules\Core\Localization\LocaleMiddleware` (see `localization.md`), so callers in controllers -don't need to pass it explicitly. +There is no `$locale` parameter — see "Field list is dynamic, not hardcoded" below for why +every configured store language is always searched, regardless of the current request locale. --- -## Missing-translation fallback +## Missing-translation fallback, in both directions If a product was only ever given an English name, `name_el` doesn't exist on that document at all (Lunar's indexer only writes a `{handle}_{locale}` field for locales actually present in the attribute's stored data — see `ScoutIndexer::mapSearchableAttributes()`). Searching strictly -against `name_el` would make that product invisible to Greek-locale search, even though it's a -real catalog item. +against the current request's locale field would make that product invisible whenever a shopper's +locale doesn't match the language it happens to be translated into. -To avoid silently hiding incompletely-translated products, `ProductSearchService` targets **both** -the resolved locale's fields **and** the default language's fields -(`Lunar\Models\Language::getDefault()->code`) — e.g. searching in `el` targets `name_el`, -`name_en`, `description_el`, `description_en` together (assuming `en` is the default language). -A product missing an `el` translation still matches via its `en` fields. +`ProductSearchService` avoids this by targeting **every configured store language's fields** +(`Lunar\Models\Language::all()`) on every search, not just the current request locale plus the +store default — e.g. with `el`/`en` configured, every search targets `name_el`, `name_en`, +`description_el`, `description_en` together, regardless of which locale the shopper is browsing +in. This is deliberately not scoped to "current locale + default locale": if the current locale +already equals the default (a single-language store, or a shopper browsing in the default +language), that pairing collapses to one locale and stops catching anything else — always +searching every configured language avoids that gap in both directions, at the cost of a larger +`attributesToSearchOn` list as the store's language count grows. + +--- + +## Variant option values are searched too + +Alongside the locale-suffixed attribute fields, every search also targets +`variants.options.value` directly — e.g. a variant named "Κάπτεν Γαμέρικα" on a "Name" option +matches a search for that text, even though it never appears in the product's own name or +description. This isn't one of Lunar's own attributes (`AttributeManifest` has no entry for it), +so it can't be discovered the way `name`/`description` are — it's a structural field of +`Modules\Core\Catalog\Services\ProductIndexer`'s own document shape (see `ProductIndexer::mapVariant()`), +added here directly. Not locale-suffixed — each option value is stored as one already-resolved +string per variant. --- diff --git a/docs/recovery-strategies.md b/docs/recovery-strategies.md new file mode 100644 index 0000000..bd1a78f --- /dev/null +++ b/docs/recovery-strategies.md @@ -0,0 +1,128 @@ +# Cart/Checkout Recovery Strategies — Design Notes + +**Status: open design discussion, not scoped or built.** This is a record of the +reasoning behind an eventual "Recovery Sequences" feature, kept so the discussion doesn't +have to be re-derived from scratch later. Nothing in this document is implemented. + +See `docs/cart.md` for what's actually built today (the four-state cart classification, +`CartAbandoned`/`CheckoutAbandoned` events, `DetectAbandonedCarts`). + +--- + +## Why Abandoned Cart and Abandoned Checkout need different strategies + +Established in `docs/cart.md`: Abandoned Cart (no order ever started) is a weak purchase-intent +signal and often unreachable (no identity for a true guest). Abandoned Checkout (a draft order +exists, `placed_at IS NULL`) is a strong intent signal and usually reachable, since checkout +typically captures an email/address even for a guest. + +That difference in intent and reachability drives genuinely different marketing strategy, not +just a different admin filter: + +### Abandoned Cart strategy — re-engagement, not completion + +- **On-site retargeting first** (exit-intent popups, "still thinking it over?" banners on + return visits) — often the only viable channel, since email may not exist yet. +- **Ad platform retargeting** (Meta/Google dynamic remarketing) is the dominant channel here + specifically because it works off a browser/device signal, not an email address — the one + thing reliably available for an anonymous cart. +- **Soft messaging** ("did you forget something?") rather than urgency-driven — intent is + weak, so aggressive discounting is often poor ROI: it trains browsers who were never close + to buying to expect a coupon. +- **Longer, gentler cadence** — a single reminder around 24h, maybe a second a few days out, + sometimes trigger-based (a price drop, back-in-stock) rather than a fixed schedule. + +### Abandoned Checkout strategy — completion, not re-engagement + +- **Speed matters most.** This is where the classic 1h/24h/72h recovery-email cadence lives — + conversion drops sharply with delay, since the shopper is often still in a "was about to + buy" mental state within the first hour. +- **Direct, urgency-framed messaging** ("complete your order"), sometimes showing cart + contents/total, occasionally a countdown or limited-time incentive on later touches. +- **Discount escalation pays off here** — a small incentive (free shipping, 10% off) on the + 2nd/3rd touch is standard, because it's nudging someone who already decided to buy past + whatever blocked them (price shock, a broken payment step, indecision on shipping cost) — + not manufacturing demand from nothing. +- **SMS is more viable** — checkout often captures a phone number, and the higher intent + justifies a more direct channel than for cart-stage. + +--- + +## The broader strategy space (beyond cadence + discount) + +Raised as context for how far a "Recovery Sequence" feature might eventually need to flex, +without committing to building any of it yet: + +**Message-content strategies** +- Social proof ("X people have this in their cart," reviews shown in the reminder) +- Scarcity/urgency framing (low-stock count, countdown timer on an offer) +- Personalized alternatives — a cheaper or complementary item instead of just re-showing the + abandoned one, useful when the likely blocker was price + +**Channel strategies** +- Email (the baseline; nothing built yet — see `docs/cart.md`'s "Recovery Sequences" section) +- SMS — checkout-stage specifically, opt-in required +- Push notifications — not relevant yet given this project's storefront maturity, noted for + completeness +- On-site remarketing (banner/modal on the shopper's next visit) — doesn't require email at + all, arguably the highest-value channel for Abandoned Cart specifically +- Ad platform sync (pushing abandoned-cart product data to a custom audience for paid retargeting) + +**Escalation/segmentation strategies** +- Value-based branching — a high-value abandoned checkout might skip straight to a bigger + incentive rather than waiting through a full ladder +- Repeat-abandoner suppression — a customer who's abandoned 3+ times without ever completing + either stops receiving emails (fatigue/spam risk) or gets a different tactic (e.g. a "what + stopped you?" survey) instead of another discount +- New vs. returning customer branching — a first-time visitor's abandoned cart might warrant + "welcome discount" framing instead of a generic recovery email, since the blocker was + likely trust/unfamiliarity rather than price + +**Timing refinement** +- Time-of-day/timezone-aware sending (don't fire a touch at 3am local time even if the delay + technically elapsed) +- Cart-content-triggered timing — a fast-moving/low-stock item might warrant an earlier, more + urgent first touch than a cart of always-in-stock staples + +--- + +## First-pass feature shape (discussed, not finalized) + +An admin defines, independently per abandonment type (Abandoned Cart, Abandoned Checkout), an +ordered sequence of **touches**. Each touch is three ideas: + +1. **How long to wait** since the abandonment began +2. **What offer to attach**, optional — reusing whatever `Discount` already exists in the + system rather than inventing a new pricing concept +3. **A label**, so staff can see what a touch represents in the admin UI + +The system continuously re-evaluates every abandoned cart/checkout against its sequence, and +when a cart becomes due for the next touch it hasn't had yet, that becomes a signal — this +feature's responsibility ends there. Actually sending anything (email, SMS, on-site banner) is +explicitly out of scope for this feature; something else, not yet designed, would consume that +signal. + +### What this requires that isn't built yet + +- **A fixed "abandonment began at" timestamp**, captured once and never re-derived — a + sequence needs to schedule touches from a stable starting point, not from `Cart::updated_at`, + which keeps moving every time the cart (or its own bookkeeping) is written to. This is the + same underlying issue as the known bug in `docs/cart.md`'s "Abandonment detection" section — + fixing that bug properly (freezing the abandonment moment) is very likely a prerequisite for + this feature, not a separate concern. +- **Re-evaluation, not one-shot detection** — `DetectAbandonedCarts` today marks a cart + abandoned once and stops; a sequence needs a cart to be revisited on every scheduler run to + check "which touch, if any, is now due," for as long as it stays unrecovered. + +### Still undecided + +- **Which concern this belongs under.** Not `Cart` (it's not a cart-mechanics concern) — + candidates raised: a new `Recovery` concern, or `Marketing`. Not decided. +- **How far the touch model needs to flex.** The three-idea shape above (delay, discount, + label) covers cadence + discount escalation cleanly, but doesn't yet accommodate channel + choice, value-based branching, or segment targeting from the broader strategy list above. + Whether those get folded into the touch model, layered on top some other way, or deliberately + left out of v1 is unresolved. +- **Whether "recovery" is cart/checkout-specific at all**, or a more general "scheduled + customer touch based on a triggering condition" mechanism that cart/checkout abandonment + happens to be the first use case for. diff --git a/docs/scratch/analytics-feature-survey.html b/docs/scratch/analytics-feature-survey.html new file mode 100644 index 0000000..18ee9a7 --- /dev/null +++ b/docs/scratch/analytics-feature-survey.html @@ -0,0 +1,449 @@ +Analytics Feature Survey + + + +
+ +
+
boboko / analytics · competitive survey
+

What analytics elsewhere can do that boboko can't yet

+

+ A feature-by-feature pass across Shopify, WooCommerce Analytics, and PrestaShop's + stats modules — sourced, not recalled from memory — checked against what + Lunar's admin Dashboard actually ships today and what + raw data already sits in lunar_orders/lunar_carts unused. + This is genuinely new territory for boboko — most rows below land on partial or + missing, and that's an honest read, not an undersell. +

+
+ ● have + ◐ partial + ○ missing +
+
+ +
+
+ 01 +

Sales & revenue dashboard

+
+

What loads the moment staff open the admin panel — this is the one area where Lunar ships more than expected.

+ +
+
Revenue / order-count stat cards with period-over-period trend
+ have +
Verified from source: OrderStatsOverview widget — today vs. yesterday, last 7 vs. prior 7, last 30 vs. prior 30 days, both order count and sub-total, with up/down trend icons. Registered by default on Lunar's Dashboard page, and boboko's panel (3dealer/app/Providers/PanelServiceProvider.php) registers the stock panel with no pages()/Dashboard override — this ships as-is.
+
+ +
+
Sales-over-time chart (revenue + order count, 12-month trend)
+ have +
OrdersSalesChart — ApexCharts area chart, monthly buckets over the trailing year, dual y-axis (order count / sub-total). Same "no override" reasoning as above applies to every widget on this page.
+
+ +
+
Average order value (AOV) trend, segmented by customer group
+ have +
AverageOrderValueChart — one series per CustomerGroup plus a synthetic guest series, monthly average of sub_total over the trailing year.
+
+ +
+
New vs. returning customer split
+ have +
NewVsReturningCustomersChart reads Order::new_customer, a real boolean column set by Lunar\Jobs\Orders\MarkAsNewCustomer (true when no prior order existed for that customer at placement time) — not a cosmetic flag.
+
+ +
+
Live/latest-orders feed on the dashboard
+ have +
LatestOrdersTable — last 10 placed orders, 60s polling, reuses OrderResource's own table columns.
+
+ +
+
Real-time dashboard vs. scheduled email reports
+ partial +
The dashboard widgets above poll every 60s (near-real-time, pull-based) — there is no scheduled/emailed report anywhere in Lunar or boboko-core. Industry pattern researched: real-time suits operational checks, scheduled digest suits weekly/monthly strategic review — boboko only has the first half.
+
+
+ +
+
+ 02 +

Product & catalog performance

+
+

Which products are actually selling, and what's about to run out.

+ +
+
Best-sellers / top-products report
+ have +
PopularProductsTable — groups lunar_order_lines by product identifier over the trailing 12 months, ranked by quantity sold, with revenue (sub_total) alongside. Physical products only (whereType('physical')).
+
+ +
+
Per-product detail stats (views, conversion, revenue for one SKU)
+ missing +
PrestaShop's statsproduct module was researched as the comparison point (per-product page-view + sales detail) — boboko has no page-view capture at all (see 04), so even the sales half of this can't be built without the traffic half.
+
+ +
+
Catalog-wide statistics (active/inactive counts, category breakdown)
+ missing +
PrestaShop's statscatalog module researched as the reference. No equivalent surface in Lunar or boboko-core — would be a straightforward aggregate over lunar_products/lunar_collections, just not built.
+
+ +
+
Inventory / stock-turnover report
+ missing +
ProductVariant::$stock is a plain point-in-time integer column — no stock-movement ledger or history table exists in lunarphp/core (grepped the models and migrations directories). Turnover reporting needs a time series of stock levels or receipts/sales deltas; today's schema only has "current stock," so there's nothing to compute turnover from yet, not just a missing report.
+
+ +
+
Low-stock / reorder alerting surfaced in a report
+ missing +
The Cart survey already noted ProductIndexer's in_stock field exists for search/listing purposes — nothing aggregates it into a "low stock" admin view or report.
+
+
+ +
+
+ 03 +

Customer analytics

+
+

Value and behavior at the level of one shopper, or a group of them.

+ +
+
Per-customer order count / average spend / lifetime spend
+ have +
Verified from source: CustomerStatsOverviewWidget on the customer view page — total orders, average spend, and total spend, computed live from orders()->sum()/average(). This is per-customer lookup, not an aggregate report across all customers.
+
+ +
+
Customer Lifetime Value (CLV) as a store-wide metric/segment
+ partial +
The per-customer total-spend figure above is the raw ingredient, but there's no store-wide CLV report, no ranking of customers by CLV, and no predictive/forward-looking CLV — WooCommerce Analytics' Customer Analytics extension (researched) computes this plus churn and RFM segments, none of which exist here.
+
+ +
+
Cohort retention analysis
+ missing +
Researched as a WooCommerce/Metorik feature (retention rate by signup-month cohort). No cohort concept, table, or query exists anywhere in Lunar or boboko-core.
+
+
+ +
+
+ 04 +

Behavioral & funnel tracking

+
+

What happens before an order exists — the storefront side neither repo instruments at all.

+ +
+
Page-view / product-view event capture
+ missing +
Grepped both repos for gtag/dataLayer/GA4/any client-side event tracker — zero hits. No storefront event of any kind is dispatched, captured, or stored anywhere.
+
+ +
+
Conversion funnel (view → add to cart → checkout → purchase)
+ missing +
Shopify's funnel report (researched) needs a session-scoped event stream across all four stages. boboko has only the last stage as durable data (a placed Order) — no view or add-to-cart events exist to build the earlier steps from, consistent with the Cart survey's finding that Lunar dispatches zero cart events.
+
+ +
+
Abandoned-cart aggregate value/rate reporting
+ partial +
Distinct from the Cart survey's per-cart admin lookup (CartResource, already shipped) — this is a rolled-up metric: total abandoned value this week, abandonment rate as a percentage of carts started. The underlying rows exist in lunar_carts/lunar_cart_lines (same query CartResource's Abandoned tab already runs), but nothing aggregates them into a rate or a trend — it's list-only today.
+
+ +
+
Traffic-source / campaign attribution (UTM-based)
+ missing +
No UTM capture, no marketing/session table anywhere in either repo. Researched as the backbone of Shopify's/GA4's acquisition reporting — would need a session table capturing utm_source/medium/campaign at first touch, tied forward to the eventual order.
+
+
+ +
+
+ 05 +

Tax, accounting & export

+
+

Getting numbers out of boboko and into someone else's books.

+ +
+
Tax / VAT breakdown captured per order
+ have +
Verified from source: lunar_orders migration stores both tax_breakdown (JSON, per-rate detail) and tax_total as real columns on every placed order — this is genuine underlying data, not inferred.
+
+ +
+
Tax / VAT report for accounting (e.g. by tax zone, by period)
+ partial +
The per-order data above is complete enough to build this from, but nothing aggregates tax_breakdown/tax_total across orders into a filing-ready report by TaxZone or period — no such widget, page, or query exists in Lunar or boboko-core.
+
+ +
+
CSV / accounting-software export of orders or sales data
+ missing +
Grepped for Exporter/ExportAction/Excel:: across lunarphp/lunar and boboko-core's src — no hits. Filament ships export actions as a first-party feature elsewhere in the ecosystem; nothing here wires one up for orders.
+
+ +
+
Sales by channel
+ partial +
Order::channel_id is a real, always-populated foreign key (verified in the lunar_orders migration) — every order already knows its channel. No report groups by it; the dashboard's charts are all channel-blind.
+
+
+ +
+
+ 06 +

Audit trail vs. analytics

+
+

A distinction worth being explicit about, since it's easy to mistake one for the other.

+ +
+
Activity log (Spatie activitylog) on core models
+ have +
Verified from source and docs/lunar.md's Activity Logging section: Lunar\Base\Traits\LogsActivity covers Order, Cart, Product, Customer, and 15 other models, recording only dirty attributes per change under the lunar log name.
+
+ +
+
This counts as analytics
+ missing +
It doesn't, and isn't listed as "have" anywhere above for that reason — activity log is a per-record change history for compliance/support ("who edited this order's shipping address"), not aggregate reporting ("how much revenue this month"). No row in this survey is satisfied by activity-log data.
+
+
+ +
+ Compiled 2026-08-28 — sources cited inline: docs/lunar.md §Filament Panel Integration and §Activity Logging plus direct reads of vendor/lunarphp/lunar/src/Filament/Widgets/Dashboard, vendor/lunarphp/core models/migrations, and 3dealer/app/Providers/PanelServiceProvider.php are repo-verified; Shopify/WooCommerce/PrestaShop feature claims are from web research, not repo reads. + boboko-core / docs +
+ +
diff --git a/docs/scratch/checkout-feature-survey.html b/docs/scratch/checkout-feature-survey.html new file mode 100644 index 0000000..f543775 --- /dev/null +++ b/docs/scratch/checkout-feature-survey.html @@ -0,0 +1,429 @@ +Checkout Feature Survey + + + +
+ +
+
boboko / checkout · competitive survey
+

What checkout elsewhere can do that boboko can't yet

+

+ A feature-by-feature pass across Shopify, WooCommerce, and PrestaShop's checkout + layer — sourced, not recalled from memory — checked against what + Lunar's Cart::createOrder() / order-creation pipeline + actually supports today. Companion to the Cart survey: this starts where that one + left off — address and shipping-option capture through to a placed order. For + deciding what to design next, not a build order. +

+
+ ● have + ◐ partial + ○ missing +
+
+ +
+
+ 01 +

Getting to checkout

+
+

Who's allowed to check out, and in how many steps.

+ +
+
Guest checkout (no account required)
+ have +
Structural, not bolted-on: Order.user_id and customer_id are both nullable, and ValidateCartForOrderCreation never checks for either — it only requires a billing address and, if shippable, a shipping address + option. A cart with no user_id creates an order fine.
+
+ +
+
One-page vs. multi-step checkout
+ missing +
Pure storefront-UI concern — Lunar has no opinion here, it just exposes setShippingAddress()/setBillingAddress()/setShippingOption() as independent calls that a UI can sequence however it likes. WooCommerce and PrestaShop both ship one-page as a plugin/theme layer, not core, so this isn't a Lunar gap so much as storefront work still to do.
+
+ +
+
Address autocomplete (type-ahead, from Google Places / Loqate)
+ missing +
Research: cuts address-entry keystrokes by 70%+ and is a proven abandonment-reduction tactic (Google Maps Platform, Loqate). No Lunar hook for it either way — it's a storefront form concern layered on top of the same setShippingAddress() call.
+
+ +
+
Express/accelerated checkout (Shop Pay, Apple Pay, Google Pay equivalents)
+ missing +
Research: Shopify reports Shop Pay can lift conversion up to 50% over guest checkout, mobile especially. Lunar's Payments facade is driver-based (Payments::driver('card')) so a wallet driver is architecturally pluggable, but none ships, and there's no one-tap "skip the address form" path since address capture still runs through the standard cart-address flow first.
+
+ +
+
Terms & conditions acceptance at checkout
+ partial +
Order.meta and Cart.meta are both free-form JSON columns carried straight through FillOrderFromCart ('meta' => $cart->meta) — technically able to record a timestamp/version of accepted terms today, but no dedicated field, checkbox validation, or admin display exists.
+
+
+ +
+
+ 02 +

Order creation mechanics

+
+

What actually happens inside createOrder(), verified from source.

+ +
+
Duplicate-order prevention on repeat submits
+ have +
Two layers, both real: Cart::draftOrder() matches on fingerprint() + total, so re-running createOrder() on an unchanged cart reuses the same draft order instead of duplicating it (CreateOrder::execute()); once an order is placed, hasCompletedOrders() throws DisallowMultipleCartOrdersException unless allowMultipleOrders is explicitly passed.
+
+ +
+
Draft order created before payment, finalized after
+ have +
Order::isDraft()/isPlaced() gate on placed_at; orders.draft_status config (default awaiting-payment) sets the initial status. The order exists — and can be re-run through the pipeline idempotently via the fingerprint match above — before a payment driver ever authorizes anything.
+
+ +
+
Order address, line, and shipping-line snapshotting from cart
+ have +
The whole orders.pipelines.creation chain does this explicitly — FillOrderFromCart, CreateOrderLines, CreateOrderAddresses, CreateShippingLine, CleanUpOrderLines, MapDiscountBreakdown — each copying cart state into immutable order rows rather than referencing the cart live.
+
+ +
+
Address validation before order creation
+ have +
ValidateCartForOrderCreation requires country_id, first_name, line_one, city, postcode on billing always, and on shipping too unless the chosen ShippingOption->collect is true (in-store pickup skips a shipping address).
+
+ +
+
Exchange rate and currency locked at order time
+ have +
FillOrderFromCart copies currency_code and exchange_rate from the cart's currency onto the order at creation — later currency-config changes don't retroactively alter placed orders.
+
+
+ +
+
+ 03 +

Confirmation & communication

+
+

What tells the customer (and staff) an order happened.

+ +
+
Order confirmation email on placement
+ missing +
Surprising given how close it looks to shipping: every status in config/lunar/orders.php carries a mailers and notifications array, but grep across core turns up exactly one reader of that config (Order::getStatusLabelAttribute(), and it only reads label). Nothing in core ever dispatches a mailer or notification from a status change — those keys are unwired placeholders, not a working feature.
+
+ +
+
Order-status-changed events
+ missing +
Same gap as Cart's event survey found — src/Events/ in core contains only PaymentAttemptEvent. No OrderCreated, no OrderStatusUpdated. Confirmation email, staff Slack ping, or customer SMS on status change all have to be built from scratch on plain Eloquent model events (Order::updated()), same pattern as the cart-event gap.
+
+ +
+
Order tracking / status lookup for guests
+ missing +
Research: PrestaShop's order-tracking extensions explicitly cover "non-logged-in customers track their orders." Lunar has the data (Order.reference, status, OrderAddress.contact_email) but no lookup mechanism — a guest with no account has no route back to their order without the confirmation email that also doesn't exist yet.
+
+ +
+
New-customer detection on first order
+ have +
CreateOrder::execute() dispatches MarkAsNewCustomer::dispatch($order->id) as a queued job after every order creation — genuinely wired, unlike the mail/notification config above.
+
+
+ +
+
+ 04 +

Abandoned checkout recovery

+
+

Distinct from abandoned cart recovery (covered in the Cart survey) — this is someone who reached address/email capture and still left.

+ +
+
Draft orders are queryable and staff-visible
+ partial +
The data exists — Order::isDraft() plus the address already captured on it — but per the Cart survey's finding, there's no Filament resource for Cart and (unverified here, likely the same gap) no dedicated "abandoned checkout" view distinguishing a draft order with a captured address from one that never got that far.
+
+ +
+
Automated recovery email (post-address-capture)
+ missing +
Research: Shopify's built-in template fires after a shopper enters details and leaves, with editable wait time and an optional discount. boboko has strictly better raw material for this than the cart-abandonment case — a draft order after address capture always has OrderAddress.contact_email, where an abandoned guest cart usually has none — but nothing sends on it.
+
+ +
+
Abandoned-checkout stage tracking (email captured vs. shipping selected vs. payment started)
+ missing +
No event dispatch anywhere in the checkout pipeline (see 03) means no timestamped record of which step a checkout got to — only the current state of the draft order, not its history.
+
+
+ +
+
+ 05 +

Pricing, tax & locale at checkout

+
+

What the customer sees the moment money is on screen.

+ +
+
Tax-inclusive vs. tax-exclusive price display
+ have +
TaxZone.price_display is a first-class enum (tax_inclusive/tax_exclusive), and Price::priceExTax()/priceIncTax() both exist on the model — more complete than PrestaShop, where dual-price display is a separately-sold addon module, not core.
+
+ +
+
Full tax breakdown shown at checkout (per-line, per-rate)
+ have +
Cart.taxBreakdown and OrderLine.tax_breakdown are both populated structured objects (iterate .amounts), not just a lump-sum total — the data supports a itemized tax display, a storefront just has to render it.
+
+ +
+
Multi-currency checkout (pay in shopper's own currency)
+ have +
Currency.exchange_rate plus sync_prices per non-default currency, and the rate is snapshotted onto the order at creation (see 02) — the same mechanics PrestaShop needs an addon for.
+
+ +
+
Multi-language checkout copy
+ partial +
Product/collection/attribute copy is fully translatable via attribute_data + Language, but checkout itself — form labels, validation errors, status labels — is storefront-owned Laravel localization, not something Lunar's order pipeline touches either way.
+
+ +
+
Click-and-collect / in-store pickup as a checkout option
+ have +
ShippingOption.collect is a real boolean the validator checks directly — when true, ValidateCartForOrderCreation skips the shipping-address requirement entirely. Modeled at the same level as the collection driver in the Table Rate Shipping add-on.
+
+
+ +
+ Compiled 2026-08-28 — sources cited inline; vendor/lunarphp/core/src reads are marked by file/class name, Shopify/WooCommerce/PrestaShop claims are marked "Research." + boboko-core / docs +
+ +
diff --git a/docs/scratch/customer-accounts-feature-survey.html b/docs/scratch/customer-accounts-feature-survey.html new file mode 100644 index 0000000..32a9097 --- /dev/null +++ b/docs/scratch/customer-accounts-feature-survey.html @@ -0,0 +1,476 @@ +Customer Accounts Feature Survey + + + +
+ +
+
boboko / customer accounts · competitive survey
+

What customer accounts elsewhere can do that boboko can't yet

+

+ A feature-by-feature pass across Shopify, WooCommerce, and PrestaShop's + account layer — sourced, not recalled from memory — checked against what + Lunar's Customer/Address/CustomerGroup + models actually support today and what exists (or doesn't) in boboko-core + and 3dealer right now. For deciding what to design next, not a build order. +

+
+ ● have + ◐ partial + ○ missing +
+
+ +
+
+ 01 +

Whether an account exists at all

+
+

The storefront-facing account experience, as distinct from staff/admin auth in Modules\Core\Auth.

+ +
+
Customer↔User linking (data model)
+ have +
Fully modeled by Lunar core — Customer::users() / User::customers() via customer_user pivot (LunarUser trait), plus User::latestCustomer().
+
+ +
+
Customer record auto-created on signup
+ have +
Modules\Core\Customer\Listeners\CreateCustomerForUser attaches a new Customer to every User on UserCreated, gated by config('core.auto_create_customer_for_user').
+
+ +
+
Storefront login / registration UI
+ missing +
3dealer has no auth scaffolding at all — no Breeze/Fortify/Sanctum in composer.json, no login/register views, nothing in routes/web.php. Only Modules\Core\Auth's Filament staff panel login exists.
+
+ +
+
Account/profile page (name, addresses, orders)
+ missing +
No AccountController, no account/profile route, no matching Blade views anywhere in 3dealer's app/ or resources/views — confirmed by exhaustive grep.
+
+ +
+
Account nav link in header
+ missing +
resources/views/components/header.blade.php has a cart icon and a search button but no account/login link at all — not even a dead one. The cart icon itself links to /cart, which also has no matching route, matching this codebase's known stubbed-UI pattern.
+
+
+ +
+
+ 02 +

Order history & tracking

+
+

Letting a customer see and follow their own orders without contacting support.

+ +
+
Order history data (per customer)
+ have +
Fully modeled — Customer::orders() and User::orders() both exist (Lunar\Models\Order), with status, line items, addresses, and transactions already relational.
+
+ +
+
Self-service order history / status page
+ missing +
No storefront route or controller reads Order for a logged-in customer — the data exists, nothing surfaces it. Shopify's rebuilt (2026) customer-accounts UI and PrestaShop's order-detail tracking page are both native; WooCommerce ships this in My Account by default.
+
+ +
+
Shipment tracking numbers surfaced to customer
+ missing +
No tracking-number field found on Order/OrderLine/shipping models in vendor/lunarphp/core; PrestaShop's tracking module patches this same gap with a third-party add-on, so it isn't a "native everywhere" bar either.
+
+ +
+
Reorder / buy-again from order history
+ missing +
Needs an order-history UI to exist first (see above) plus a "re-add these lines to cart" action — Lunar's Cart::add() already supports the mechanics, nothing wires an Order line back into a new cart.
+
+
+ +
+
+ 03 +

Saved addresses

+
+

What a returning customer doesn't have to retype.

+ +
+
Multiple saved addresses per customer
+ have +
Customer::addresses() (HasMany) — Lunar\Models\Address has no cap on count.
+
+ +
+
Separate default shipping / billing address
+ have +
Address::shipping_default and billing_default booleans; AddressObserver auto-unsets the previous default when a new one is flagged, so only one of each can be true at a time.
+
+ +
+
Self-service address book (add/edit/delete UI)
+ missing +
Only Filament's staff-facing AddressRelationManager (src/Customer/RelationManagers/AddressRelationManager.php) touches addresses today — that's an admin back-office view, not a storefront one. No customer-facing CRUD exists.
+
+ +
+
Address autocomplete / validation at entry
+ missing +
Nothing in lunarphp/core or boboko-core wires a geocoding/validation service — this is a storefront-only concern layered on top of the plain line_one…postcode fields.
+
+
+ +
+
+ 04 +

Login & identity

+
+

How a customer gets in, and how forgiving that path is.

+ +
+
Email + password login
+ missing +
No storefront auth guard/routes configured — see 01. Modules\Core\Auth\Services\OtpService/UserOtpService exist but are wired to staff/Filament login, not a customer-facing flow.
+
+ +
+
Passwordless / magic-link / OTP login
+ partial +
UserOtpService and UserOtpMail already implement an OTP-by-email mechanism for the staff panel — the building block for a customer-facing passwordless flow exists, just not exposed to a storefront route. Shopify ships this as sign-in links (6-digit email code) by default in its 2026 customer accounts.
+
+ +
+
Social login (Google / Apple / Facebook)
+ missing +
No laravel/socialite in either composer.json. Shopify offers Google/Facebook sign-in and "Sign in with Shop" natively; this would be a from-scratch integration here.
+
+ +
+
Guest checkout → account conversion
+ missing +
No storefront checkout flow exists yet in 3dealer to convert from — this depends on checkout being built before it's meaningful. Lunar's Cart::user_id/customer_id nullable-until-claimed design would support it once a checkout and account UI exist.
+
+
+ +
+
+ 05 +

Payments & saved methods

+
+

Whether a returning customer can skip re-entering card details.

+ +
+
Saved payment methods on account
+ missing +
No tokenized-card storage model found in lunarphp/core or boboko-core's payment integration. Even Shopify gates this behind Enterprise; WooCommerce's version depends entirely on gateway-level tokenization (e.g. Stripe), not a core feature.
+
+
+ +
+
+ 06 +

Wishlist & saved items

+
+

Keeping track of products outside the cart.

+ +
+
Wishlist / saved-for-later products
+ missing +
No wishlist model, table, or reference anywhere in src/ or vendor/lunarphp — grep confirms zero hits. Shopify also has no native wishlist (third-party apps like Flits fill the gap); WooCommerce/PrestaShop are the same story via plugins, so this is a genuinely common gap, not a boboko-specific one.
+
+
+ +
+
+ 07 +

Groups, pricing & B2B

+
+

Where boboko is already ahead of a typical single-tenant storefront — Lunar's CustomerGroup does real work here.

+ +
+
Customer groups for differentiated pricing/visibility
+ have +
CustomerGroup model plus HasCustomerGroups trait — Product::customerGroup() scope and Price's polymorphic customer-group awareness are both real, shipped behavior, not scaffolding.
+
+ +
+
Scheduled group availability (time-boxed access)
+ have +
HasCustomerGroups::scheduleCustomerGroup() / unscheduleCustomerGroup(), backed by CanScheduleAvailability — supports a starts_at/ends_at window per group, e.g. early access for wholesale.
+
+ +
+
Multi-user company / B2B accounts
+ partial +
Customer::users()->sync([...]) already supports attaching several Users to one Customer record — the data model allows a shared company account today, but nothing (invite flow, role/permission split between company users, storefront switch-account UI) is built on top of it. PrestaShop's "Multi-User Customer Account" add-on is the closest native comparison, and it's a paid third-party module there too.
+
+ +
+
Self-service customer-group selection at registration
+ missing +
Groups exist and are assignable (HasCustomerGroups::bootHasCustomerGroups() auto-syncs default groups on creation), but nothing lets a customer request/select a group like "wholesale" at signup — that's currently a staff-only Filament action via CustomerResourceExtension.
+
+
+ +
+
+ 08 +

Loyalty, retention & data rights

+
+

Longer-tail account features — noted for completeness, not depth (data rights specifically overlaps a separate Privacy survey).

+ +
+
Loyalty / rewards points program
+ missing +
No points/loyalty model anywhere in lunarphp/core or boboko-core — Discount's BuyXGetY type is the closest primitive, but it's a promo mechanic, not an accruing balance. PrestaShop and WooCommerce both rely on third-party modules for this too (Knowband, Webkul, Yith).
+
+ +
+
Self-service data export / account deletion
+ missing +
The only related tool is boboko:anonymize — a local-environment-only dev command that scrubs users/lunar_customers for testing, not a customer-facing GDPR flow. WooCommerce's closest native equivalent is also a paid add-on (Data Privacy Manager); flagged briefly here, full treatment belongs to the separate Privacy survey.
+
+ +
+
Subscription / recurring-order management
+ missing +
No subscription model, billing-cycle field, or recurring-cart concept found in lunarphp/core. This is WooCommerce Subscriptions/Shopify-app territory on the platforms researched too — not a core-package feature anywhere.
+
+
+ +
+ Compiled 2026-08-28 — chips backed by web research (Shopify/WooCommerce/PrestaShop feature claims) are noted inline by platform name; all other claims are direct reads of vendor/lunarphp/core/src, boboko-core's src/, and 3dealer's app//resources/views/routes. + boboko-core / docs +
+ +
diff --git a/docs/scratch/discounts-feature-survey.html b/docs/scratch/discounts-feature-survey.html new file mode 100644 index 0000000..9147f01 --- /dev/null +++ b/docs/scratch/discounts-feature-survey.html @@ -0,0 +1,527 @@ +Discounts Feature Survey + + +
+ +
+

boboko-core · competitive spec sheet

+

What discounts & promotions elsewhere can do that boboko can’t yet

+

A feature-by-feature audit of Lunar's Discount engine against promotion tooling in Shopify, WooCommerce, and PrestaShop. Each row is graded against the underlying Lunar source, not the docs.

+
+ have + partial + missing +
+
+ +
+
+ 01 +

Core discount mechanics

+
+

The two shipped discount types and the machinery that decides whether they fire.

+ +
+
+
+ Percentage / fixed-amount off cart or line items + have +
+

Built in as Lunar\DiscountTypes\AmountOff. applyPercentage() and applyFixedValue() distribute the discount across eligible lines, tracking per-currency fixed values (data.fixed_values.{code}) so the amount is currency-aware, not a single converted number.

+
+
+
+ Buy X get Y (free or discounted) + have +
+

Built in as Lunar\DiscountTypes\BuyXGetY. Condition lines and reward lines are configured separately via discountableConditions/discountableRewards; getRewardQuantity() computes how many reward units a given condition quantity earns, with an optional max_reward_qty cap.

+
+
+
+ Coupon-code discounts + have +
+

checkDiscountConditions() compares strtoupper($cart->coupon_code) against $discount->coupon; Discounts::validateCoupon() exposes a standalone check. Coupon is cast via CouponString on the model.

+
+
+
+ Automatic (no-code) discounts + have +
+

A blank coupon column makes a discount apply to every eligible cart with no code entered — DiscountManager::getDiscounts() queries whereNull('coupon')->orWhere('coupon', '') when the cart carries no coupon code.

+
+
+
+ Minimum cart spend condition + have +
+

checkDiscountConditions() reads data.min_prices.{currency} and compares it against $lines->sum('subTotal.value'). Configurable per-currency in the admin form's "Minimum cart amount" fieldset — but only enforced by AmountOff, see row below.

+
+
+
+ Scoping to products, variants, collections, brands (incl. exclusions) + have +
+

AmountOff::getEligibleLines() filters/rejects cart lines against discountableLimitations/discountableExclusions plus collections()/brands() pivot rows typed limitation or exclusion. Configured through five separate Filament relation managers on the discount record.

+
+
+
+ +
+
+ 02 +

Timing, status, and usage limits

+
+

Whether a discount is currently live, and how hard its usage caps are enforced.

+ +
+
+
+ Scheduled / expiring discount windows + have +
+

Discount::getStatusAttribute() derives active/pending/expired/scheduled from starts_at/ends_at; the Filament table badges this status column directly (green/gray/red/blue via DiscountResource::getTableColumns()).

+
+
+
+ Global max-uses cap + have +
+

Discount::scopeUsable() filters query-side (uses < max_uses OR max_uses IS NULL) before a discount is even fetched; checkDiscountConditions() re-checks it in AmountOff. markAsUsed() increments uses and attaches the user via discount_user.

+
+
+
+ Per-user max-uses cap + partial +
+

checkDiscountConditions() calls usesByUser() only when $cart->user exists — a guest checkout cannot be capped per-customer since there's no user_id to key against, only customer_id. Wholesale/B2B carts often complete without a Laravel User attached, so the cap silently no-ops for them.

+
+
+
+ Usage/eligibility checks on Buy X Get Y + missing +
+

BuyXGetY::apply() never calls checkDiscountConditions() — grep the method body, it's absent. A coupon-gated, min-spend-gated, or max-uses-capped BOGO discount ignores all three conditions; only the min-quantity/reward math runs. AmountOff::apply() calls it correctly by contrast.

+
+
+
+ +
+
+ 03 +

Multiple discounts, priority, and stacking

+
+

What happens when more than one discount could legally apply to the same cart.

+ +
+ The stop field is dead code. It's a real column, cast as boolean on the model, and it's a live toggle in the Filament admin form (DiscountResource::getStopFormComponent()) — but a repo-wide grep of both lunarphp/core and lunarphp/lunar for reads of $discount->stop outside the model and the form turns up nothing. DiscountManager::apply() is a plain unconditional foreach over every fetched discount; nothing ever breaks the loop. Staff can toggle a setting that has zero runtime effect. +
+ +
+
+
+ Priority ordering between discounts + have +
+

DiscountManager::getDiscounts() ends with orderBy('priority', 'desc')->orderBy('id'), and the admin form exposes low/medium/high (1/5/10) presets. This genuinely controls apply order.

+
+
+
+ Stopping further discounts once one applies ("exclusive" discount) + missing +
+

See callout above — stop is unread at runtime. Every active, eligible discount is applied every time; there is no way to make one discount exclusive of the rest short of writing a custom AbstractDiscountType that inspects $cart->discounts itself.

+
+
+
+ Per-class combination rules (product vs. order vs. shipping discounts) + missing +
+

Shopify models discounts as Product/Order/Shipping classes with an explicit "Combines with" toggle per pair. Lunar has no discount class concept at all — AmountOff and BuyXGetY are the only two types and neither declares a class or combination policy.

+
+
+
+ Customer-facing stacking transparency (which discounts combined, and why) + partial +
+

$cart->discountBreakdown (a collection of DiscountBreakdown value objects, one per applied discount with its affected lines) gives a storefront the raw data to render "2 promotions applied," but no UI ships to render it — it's a data structure a storefront app must build its own component against.

+
+
+
+ "Best deal wins" line-level conflict resolution + have +
+

Both AmountOff::applyFixedValue() and applyPercentage() explicitly skip a line when $line->discountTotal->value > $amount — "if this line already has a greater discount value, don't add this one as they already have a better deal." This is a real per-line max-discount guard, just not a whole-cart exclusivity rule.

+
+
+
+ +
+
+ 04 +

Volume, tiers, and bundles

+
+

"Buy more, save more" mechanics — and the separate pricing layer that actually implements some of them in Lunar.

+ +
+ Tiered/volume pricing exists — but it's not a Discount. PricingManager::get() filters a purchasable's Price rows for min_quantity > 1 AND $this->qty >= $price->min_quantity and picks the cheapest matching price break. This is quantity-break pricing baked into the price table itself, resolved at Pricing::for($variant)->qty($n)->get() time — it never touches the Discount model, coupon system, or discount breakdown at all. A storefront gets the discounted unit price with no visible "discount applied" line. +
+ +
+
+
+ Per-SKU quantity price breaks + have +
+

Via the Price model's min_quantity/pricing pipeline described above, not Discount. Configured directly on product variant pricing in the admin, no separate promotion object needed.

+
+
+
+ Cart-wide tiered discount ("spend $100, save 10%; spend $200, save 20%") + missing +
+

AmountOff takes one flat percentage or fixed value per discount record; there is no multi-tier threshold structure in data. Reaching this today means creating several separate Discount rows, each with its own min_prices floor, and hoping only the intended one wins (compounded by the stop gap in section 03).

+
+
+
+ Bundle / kit discount (buy this set, get a fixed bundle price) + missing +
+

No bundle or kit concept anywhere in lunarphp/core's catalog or discount models. Shopify/WooCommerce/PrestaShop all support this via dedicated bundle apps or plugins layered on the same primitive Lunar lacks — a discount keyed to a co-purchased product set rather than any single line.

+
+
+
+ Free-gift-with-purchase (a distinct SKU added free, not a percentage off an existing line) + have +
+

BuyXGetY's automatically_add_rewards flag drives processAutomaticRewards(), which inserts a brand-new CartLine for a randomly selected reward product and zeroes its price via discountTotal. $cart->freeItems tracks which purchasables were added this way.

+
+
+
+ +
+
+ 05 +

Customer targeting

+
+

Lunar has two genuinely different mechanisms here that solve overlapping-looking problems — conflating them is the easiest mistake to make.

+ +
+ CustomerGroup pricing and Discount customer-group scoping are not the same feature. Pricing::for($variant)->customerGroups($groups)->get() resolves a different base price per customer group directly from the Price table (wholesale sees $8, retail sees $10 — two rows, no discount object, no coupon, nothing to "apply"). Discount::customerGroups() is a separate pivot (customer_group_discount, via the HasCustomerGroups trait) that scopes whether a promotion is visible/enabled to a group at all, with its own starts_at/ends_at/enabled/visible per-pivot-row scheduling. One is differential pricing; the other is promotion eligibility. Both exist and both work, but they're wired into completely separate code paths. +
+ +
+
+
+ Differential pricing per customer group (wholesale/VIP base price) + have +
+

PricingManager::get(): $potentialGroupPrice filters Price rows with a matching customer_group_id and picks the cheapest; falls back to $basePrice when no group price exists.

+
+
+
+ Restricting a discount/coupon to specific customer groups + have +
+

DiscountManager::getDiscounts() applies ->customerGroup($this->customerGroups) via the shared HasCustomerGroups trait's scopeCustomerGroup(), configured on the discount's own "Availability" sub-page (ManageDiscountAvailability) alongside channel restriction.

+
+
+
+ Restricting a discount to specific named customers + have +
+

Discount::customers() pivot (customer_discount), checked in checkDiscountConditions(): if the discount has any tied customers, a cart without a matching customer_id fails eligibility outright. Managed via CustomerLimitationRelationManager in the admin.

+
+
+
+ First-purchase / welcome discount + missing +
+

Lunar does compute an order-level new_customer boolean (Jobs\Orders\MarkAsNewCustomer, ! $previousOrder) — but it's a post-order reporting flag surfaced only in the Filament order table/dashboard chart. Nothing reads it during ApplyDiscounts; there's no "is this customer's first order" condition available to a Discount at checkout time.

+
+
+
+ Referral discounts (reward both referrer and referee) + missing +
+

No referral concept anywhere in lunarphp/core or lunarphp/lunar — not a model, job, or config key. Common as a bolt-on in WooCommerce/Shopify via loyalty apps (e.g. WPLoyalty's referral-points module); would need to be built from scratch on top of Discount::customers() at best.

+
+
+
+ Loyalty points redeemable as a discount + missing +
+

No points ledger, balance, or redemption model exists in Lunar core. A loyalty program (points-to-discount conversion, VIP-tier multipliers) is a third-party plugin layer in every researched competitor, not core commerce logic — same gap here, but Lunar offers no AbstractDiscountType hook obviously suited to "redeem N points" either, since discount eligibility has no notion of a spendable balance.

+
+
+
+ +
+
+ 06 +

Extensibility

+
+

What it takes to reach a feature Lunar doesn't ship, without forking the package.

+ +
+
+
+ Registering a custom discount type + have +
+

Discounts::addType(MyType::class) appends to DiscountManager::$types (seeded with just AmountOff::class, BuyXGetY::class). A new type extends AbstractDiscountType and implements apply(CartContract $cart) — the same contract the two built-ins use, so it participates in the same unconditional-foreach loop from section 03.

+
+
+
+ Admin UI for a custom discount type + partial +
+

Requires additionally implementing Lunar\Admin\Base\LunarPanelDiscountInterface (lunarPanelSchema()/lunarPanelOnFill()/lunarPanelOnSave()) for DiscountResource::getDefaultForm() to render a config section for it. The interface exists and is wired in, but there is no shipped example implementation to copy from beyond AmountOff/BuyXGetY, which are hard-coded into the form rather than using the interface themselves.

+
+
+
+ +
+

Compiled 2026-08-28 · boboko-core / docs

+

Section 01–03 and 05–06 rows are grounded directly in vendor/lunarphp/core/src and vendor/lunarphp/lunar/src source reads (file/method citations inline). Section 02's per-user cap and section 04's pricing-vs-discount distinction are likewise direct source reads. Comparative claims about Shopify, WooCommerce, and PrestaShop feature sets and terminology (discount classes, cart-rule compatibility, loyalty/referral plugins) are sourced from current public documentation and app-store listings via web research, not from reading those platforms' source.

+
+ +
diff --git a/docs/scratch/orders-feature-survey.html b/docs/scratch/orders-feature-survey.html new file mode 100644 index 0000000..ac10bd1 --- /dev/null +++ b/docs/scratch/orders-feature-survey.html @@ -0,0 +1,450 @@ +Order Feature Survey + + + +
+ +
+
boboko / order · competitive survey
+

What order management elsewhere can do that boboko can't yet

+

+ Where the Checkout survey stopped — the instant Order exists — this + one starts. A feature-by-feature pass across Shopify, WooCommerce, PrestaShop, and + (briefly) Magento's post-placement order layer — sourced, not recalled from memory — + checked against what Lunar's Order model and the + already-shipped Filament ManageOrder page actually support + today. For deciding what the new Order module needs to own, not a + build order. +

+
+ ● have + ◐ partial + ○ missing +
+
+ +
+
+ 01 +

Status model

+
+

One field, or several axes — and who's allowed to move it.

+ +
+
Payment status independent of a single overall status
+ partial +
The data exists — ManageOrder::paymentStatus() derives a real value from transactions()/captureTotal()/refundTotal()/intentTotal() — but it's a computed display value on the admin page, not a stored column or something the rest of the system (mailers, automations) can key off. Shopify and Magento both make payment status a first-class, independently-queryable dimension; here it's derived on the fly, once, in one Filament page.
+
+ +
+
Fulfillment status independent of overall status
+ missing +
No equivalent of paymentStatus() exists for shipment/fulfillment state — Order has no shipments() relation of its own at all; it's added dynamically by Modules\Core\Shipping\Providers\ShippingServiceProvider::resolveRelationUsing(), outside Order's own boundary (see docs/checkout.md, "Where Order would likely absorb work"). Every platform researched (Shopify, Woo, PrestaShop, Magento) treats "has this shipped" as derivable from child records, not a manually-set field — Lunar has the child records (Shipment) but no derived status method reading them.
+
+ +
+
Staff-editable order status with a picker/action
+ have +
ManageOrder ships a working UpdateStatusAction out of the box, backed by config('lunar.orders.statuses') — a flat, merchant-configured list, each entry carrying a label/color/favourite flag. Closer to WooCommerce's single linear field than Shopify's multi-axis split.
+
+ +
+
Status rows carry behavior (auto-send email, generate invoice, restock)
+ partial +
Each status entry in config('lunar.orders.statuses') already declares mailers and notifications arrays — the PrestaShop-style shape is there in config — but per the Checkout survey's finding, nothing in core actually reads and dispatches from those keys on a transition. The data model for "status carries behavior" exists; the behavior doesn't.
+
+ +
+
Order-status-changed event other code can react to
+ missing +
Same gap the Checkout survey flagged for order creation: no OrderStatusUpdated/equivalent exists anywhere in core. UpdateStatusAction just writes the column. Anything wanting to react to a status change — a confirmation email, a webhook, re-deriving payment/fulfillment status — has to hook the raw Eloquent Order::updated() event and diff status itself.
+
+
+ +
+
+ 02 +

Fulfillment & shipment tracking

+
+

Turning a placed order into a package that moves.

+ +
+
Shipment as its own record, separate from the order
+ have +
Modules\Core\Shipping\Models\Shipment (carrier, tracking reference, label-printed timestamp, manifest reference) already exists and belongs to Order. Built this session, ahead of most gaps in this survey — the record shape is closer to Magento's per-shipment entity than Woo's "no shipment entity at all."
+
+ +
+
Multiple shipments per order (partial/split fulfillment)
+ partial +
Shipment has no quantity-per-line or order_line_id concept — it's one shipment record per carrier voucher, with a parent_reference for ACS's own multipart-voucher case (one physical order split into multiple packages by the carrier), not a per-line-item fulfillment split decided by staff. Closer to "multiple packages for one shipment" than Magento's true per-line partial-shipment model.
+
+ +
+
Create-shipment action from the order admin screen
+ have +
Modules\Core\Shipping\Extensions\OrderViewExtension adds a working "Create Shipment" header action to ManageOrder, resolving a CarrierFulfillmentInterface by the order's chosen shipping method and calling createShipment() — genuinely wired, not a stub. Currently lives under Shipping, flagged in docs/checkout.md as conceptually an Order concern.
+
+ +
+
Tracking number + carrier surfaced on the order itself
+ have +
Shipment.tracking_reference/carrier exist and are populated by createShipment(); PollShipmentTrackingJob (scheduled every 30 minutes) keeps ShipmentInfo checkpoints current via CarrierFulfillmentInterface::trackShipment(). Genuinely ahead of PrestaShop's thin order_carrier.tracking_number field — this has a real checkpoint history, not just one string.
+
+ +
+
"Shipped"/"delivered" status auto-derived from tracking
+ missing +
The tracking checkpoints exist (ShipmentInfo, TrackingStatus enum including Delivered) but nothing writes them back onto Order.status — a delivered shipment doesn't move the order out of whatever status it was already in. Every platform researched treats "delivered" as a status a customer/staff can see on the order, not something buried one relation away.
+
+ +
+
Shipping/delivery notification emails (shipped, out-for-delivery, delivered)
+ missing +
Research: Shopify fires four separate templated notifications across this window alone (shipping confirmation, out-for-delivery, delivered, plus edited-order). None of the pieces exist here — no order-status-changed event (01) to trigger from, and no mailer wired to PollShipmentTrackingJob's own status updates either.
+
+
+ +
+
+ 03 +

Payments: capture, refund, cancellation

+
+

Money moving back out, and orders that never should have been placed.

+ +
+
Refund action from the order screen, amount-scoped
+ have +
ManageOrder's refund action already exists — picks a transaction, an amount (validated against availableToRefund()), and notes, then calls the driver's own Transaction::refund(). This is genuinely native, matching Woo/Magento's line-item-adjacent (if not line-item-exact) refund UX.
+
+ +
+
Capture action for auth-then-capture payment flows
+ have +
ManageOrder's capture action + requiresCapture()/canBeRefunded() guard methods already exist, delegating to Transaction::capture() — this is the Stripe "authorize now, capture later" flow's admin-side half, already built ahead of most gaps here.
+
+ +
+
Refund tied to specific line items (not just a dollar amount)
+ missing +
The refund action takes a transaction + amount, with no line-item selection or restock decision — WooCommerce and Magento both make "which items, how many, restock or not" the primary refund UI; here it's one number against one transaction, closer to a manual adjustment than a structured partial return.
+
+ +
+
Order cancellation as a distinct action (vs. just changing status)
+ missing +
No dedicated "cancel" action exists on ManageOrder — a cancellation today would just be picking a "cancelled"-labeled entry from the generic status dropdown (01), with no automatic refund trigger, no stock-release logic, and no distinction from any other manual status edit.
+
+ +
+
Refund/capture reflected back into an order-level payment status
+ partial +
Same gap as 01's payment-status finding — paymentStatus() recomputes correctly from transactions when the admin page loads, but a refund doesn't push the order into a refunded/partially-refunded overall status the way Shopify's displayFinancialStatus does automatically.
+
+
+ +
+
+ 04 +

Returns (RMA)

+
+

The one area every researched platform treats as optional, not core.

+ +
+
Return-merchandise-authorization flow (customer requests, staff approves)
+ missing +
No Return/RMA model, status set, or request flow exists anywhere in this codebase. Consistent with the research: Shopify is the only platform of the four with this genuinely native; PrestaShop ships it off-by-default; Magento gates it behind the paid Adobe Commerce tier; WooCommerce lacks it entirely. Safe to treat as a real gap, not an urgent one.
+
+ +
+
Return shipping label generation
+ missing +
Depends entirely on the RMA flow above existing first — CarrierFulfillmentInterface already has the label-printing primitive (printLabel()) a return label would reuse, so the carrier-side plumbing isn't the blocker, the RMA request/approval model is.
+
+
+ +
+
+ 05 +

Order editing

+
+

Changing a placed order — and where every platform draws the line.

+ +
+
Editing guardrails keyed to fulfillment state
+ missing +
No line-item add/remove exists on a placed order at all today (unlike Shopify/Woo/PrestaShop, which all allow it up to some fulfillment-keyed cutoff, then force a return instead) — so there's no guardrail to speak of yet because there's no editing to guard. Whatever gets built here should key the cutoff to Shipment existing, per the pattern all four researched platforms converge on.
+
+ +
+
Editable shipping/billing address after placement
+ missing +
OrderAddress rows are snapshotted at creation (see Checkout survey, 02) and nothing in ManageOrder exposes editing them afterward — every platform researched treats address edits as lower-risk than line-item edits and allows them more freely; this codebase currently allows neither.
+
+ +
+
Tag editing on a placed order
+ have +
ManageOrder's edit_tags action already works — the one piece of native post-placement editing that exists today, via HasTags on the Order model.
+
+
+ +
+
+ 06 +

Notes & audit trail

+
+

The one thing every researched platform treats as non-negotiable.

+ +
+
Append-only change history (who changed what, when)
+ have +
Order already uses Spatie's LogsActivity trait — every save is recorded with a diff, same underlying mechanism already relied on elsewhere in this codebase (staff activity log, translation history). Structurally equivalent to PrestaShop's order_history table, just via a different package.
+
+ +
+
Internal staff notes, separate from system-generated log entries
+ missing +
The activity log above captures field changes automatically, but there's no free-text "leave a note for the next person" field — every platform researched has this as a distinct feed from the automatic history (Woo's Order Notes, Shopify's Timeline comments, Magento's Comments History), usually with a private-vs-customer-visible toggle. Nothing here yet.
+
+ +
+
Customer-visible note-to-customer, sent as a message
+ missing +
Depends on both the internal-notes feature above and a working mailer (01/02) — genuinely blocked on more foundational gaps, not just unbuilt on its own.
+
+
+ +
+ Compiled 2026-09-01 — sources cited inline; vendor/lunarphp/lunar and this codebase's own src/ reads are marked by file/class name, Shopify/WooCommerce/PrestaShop/Magento claims are marked "Research." + boboko-core / docs +
+ +
diff --git a/docs/scratch/payments-feature-survey.html b/docs/scratch/payments-feature-survey.html new file mode 100644 index 0000000..cb29969 --- /dev/null +++ b/docs/scratch/payments-feature-survey.html @@ -0,0 +1,448 @@ +Payments Feature Survey + + + + + + + +
+ +
+

boboko-core · competitive gap survey · 03

+

What payments elsewhere can do that boboko can't yet

+

+ Lunar's payment layer (Lunar\Facades\Payments, Transaction, the offline + driver) is wired for a single "pay on delivery / bank transfer" flow. Everything downstream of + that — cards, wallets, saved methods, self-service refunds, retries — is either scaffolded in + Lunar core and unused here, or absent from the stack entirely. This is a research survey, not a + build plan. +

+
+ 4 have + 9 partial + 14 missing +
+
+ +
+
+ 01 +

Payment method breadth

+
+

boboko currently ships one payment type: cash-in-hand via the offline driver. Every card/wallet/BNPL path below is theoretically pluggable but has zero live implementation.

+
+ +
+
Offline / pay-on-accounthave
+
The only configured type in config/lunar/payments.php (3dealer's published copy): 'cash-in-hand' => ['driver' => 'offline', 'authorized' => 'payment-offline'], backed by Lunar\PaymentTypes\OfflinePayment.
+
+ +
+
Card payments (Stripe/other gateway)missing
+
lunarphp/stripe is not present in either boboko-core/vendor/lunarphp or 3dealer/vendor/lunarphp, and not listed in either composer.json. docs/lunar.md's Stripe section documents Lunar's general capability, not something wired into this project.
+
+ +
+
Digital wallets (Apple Pay, Google Pay, Shop Pay)missing
+
Depends entirely on a card gateway (Stripe Payment Request Button or similar) that isn't installed. Shopify bundles Apple Pay, Google Pay, and Shop Pay as one-tap checkout by default.
+
+ +
+
Buy-now-pay-later (Klarna, Afterpay, Affirm)missing
+
No BNPL driver or config entry anywhere in the repo. Shopify bundles Klarna natively in eligible regions with Pay-in-4, Pay-Later, and financing tiers; WooCommerce and PrestaShop both offer it as installable gateway plugins.
+
+ +
+
Bank transfer / open banking (SEPA, Pay by Bank)missing
+
Not represented as a distinct payment type; only the generic cash-in-hand offline flow exists, which is manual reconciliation rather than an automated bank-transfer rail.
+
+ +
+
Crypto / stablecoin checkoutmissing
+
No driver, no research finding of it being used in this stack. Industry-wide it's still marginal — stablecoin payment volume is roughly 0.02% of global payments in 2026 per Nuvei's trend report — so this is low-priority even elsewhere.
+
+ +
+
Pluggable driver architecture for adding methodshave
+
Lunar\Managers\PaymentManager extends Laravel's Manager; Payments::extend('custom', fn ($app) => ...) registers a new driver, and any class extending Lunar\PaymentTypes\AbstractPayment implementing authorize()/capture()/refund() plugs in. The scaffolding is solid — nothing beyond offline is plugged into it yet.
+
+ +
+
+ +
+
+ 02 +

Capture, refund & transaction lifecycle

+
+

The core primitives (intent/capture/refund, partial amounts, transaction chaining) exist in Lunar and are exposed in the Filament admin — but nothing calls them outside cash-in-hand, and none of it is customer-facing.

+
+ +
+
Authorize / capture / refund contracthave
+
Lunar\Base\PaymentTypeInterface defines authorize(), capture(Transaction $t, $amount), refund(Transaction $t, int $amount, $notes); Transaction::capture()/refund() forward to the transaction's own driver() via Payments::driver($this->driver).
+
+ +
+
Manual vs. automatic capture policypartial
+
The interface supports separate authorize/capture steps (intent vs. capture transaction types), but OfflinePayment::capture() just returns new PaymentCapture(true) unconditionally — there's no real deferred-capture gateway wired up to exercise the distinction.
+
+ +
+
Partial capturepartial
+
Admin Filament action passes an arbitrary $data['amount'] to $transaction->capture(bcmul($data['amount'], $record->currency->factor)) in ManageOrder.php — the plumbing supports partial amounts, but only staff can trigger it, and only against a real (non-offline) driver would it mean anything.
+
+ +
+
Partial / staged refundshave
+
Same file: the "refund" Filament action computes $response = $transaction->refund(bcmul($data['amount'], ...), $data['notes']), and isPartiallyRefunded() / order status logic (partial-refund, refunded) compares refundTotal against captureTotal/intentTotal. This genuinely works today through the offline driver's no-op refund().
+
+ +
+
Multiple payment attempts per orderpartial
+
Transaction.parent_transaction_id chains captures to intents and refunds to captures, and nothing in the model stops multiple transaction rows per order — but no code path in this repo actually retries a failed attempt with a second transaction; it's schema support, not a driven flow.
+
+ +
+
Transaction audit trailhave
+
Lunar\Observers\TransactionObserver::created() logs every transaction (amount, type, status, card_type, last_four, reference, notes) via Spatie activity log automatically — this is real and unconditional, independent of driver.
+
+ +
+
Webhook handling for async payment eventsmissing
+
Lunar's Stripe package registers a stripe/webhook route, but that package isn't installed here, so there is no webhook endpoint of any kind in this project today.
+
+ +
+
Payment attempt events for downstream hookshave
+
Lunar\Events\PaymentAttemptEvent is dispatched from OfflinePayment::authorize() with the resulting PaymentAuthorize DTO — a real, listenable event, though only one driver currently fires it.
+
+ +
+
+ +
+
+ 03 +

Customer-facing payment experience

+
+

Everything a shopper would touch directly — saved cards, one-click repeat purchase, self-service refunds — is absent. Lunar's payment layer is staff/checkout-oriented, not account-oriented.

+
+ +
+
Saved payment methods on customer accountmissing
+
No vault/tokenization model exists anywhere in Lunar\Models — no PaymentMethod/Card model, no field on Customer. 2026 trend research (Nuvei, Checkout.com) treats network-tokenized saved cards as baseline for one-click checkout.
+
+ +
+
One-click repeat purchasemissing
+
Depends on saved payment methods, which don't exist. No "reorder" or "buy again" affordance found in boboko-core or 3dealer.
+
+ +
+
Customer self-service refund requestsmissing
+
The only refund entry point is the Filament staff action in ManageOrder.php (Actions\Action::make('refund')), gated behind admin auth. WooCommerce/PrestaShop ecosystems commonly expose a customer-initiated return/refund request flow; nothing equivalent exists here.
+
+ +
+
Split / partial payment plans (pay-in-installments at checkout)missing
+
Distinct from BNPL-as-a-gateway: this is a native "split into N charges" checkout option, seen as marketplace split-payment modules in the PrestaShop ecosystem. No equivalent concept in Lunar's cart/order/payment pipeline.
+
+ +
+
3D Secure / SCA authenticationmissing
+
3DS is a property of the card gateway integration (e.g. Stripe PaymentIntents), which isn't installed. WooPayments explicitly advertises 3DS/SCA compatibility with visible card-brand + last-four confirmation as a baseline expectation in 2026.
+
+ +
+
Fraud detection / risk scoringmissing
+
No fraud-scoring hook in PaymentTypeInterface or the offline driver. getPaymentChecks() exists as an extension point (Lunar\Base\DataTransferObjects\PaymentChecks, an iterable of pass/fail PaymentCheck DTOs) but AbstractPayment::getPaymentChecks() just returns an empty collection — real fraud tooling (Stripe Radar-style) isn't behind it.
+
+ +
+
Payment check / validation extension pointpartial
+
Transaction::paymentChecks() → driver's getPaymentChecks($transaction) is real, typed infrastructure for surfacing checks (e.g. "AVS matched") in the admin UI — but the default implementation is a no-op, so nothing populates it today.
+
+ +
+
+ +
+
+ 04 +

Currency, subscriptions & recurring billing

+
+

Lunar's multi-currency model covers pricing display, not multi-currency payment settlement; recurring billing/dunning has no representation at all.

+
+ +
+
Multi-currency pricing displayhave
+
Lunar\Models\Currency (code, exchange_rate, decimal_places, default) with sync_prices-gated conversion, documented in docs/lunar.md "Channels and Currencies" — this is genuinely wired, cart/pricing layer already uses it.
+
+ +
+
Multi-currency payment processing (charge in customer's currency)partial
+
Pricing can display and calculate in any configured currency, but no payment driver in this project actually settles a charge — so whether a real gateway would charge in-currency is untested; the pricing half is there, the processing half isn't proven.
+
+ +
+
Recurring billing / subscriptionsmissing
+
No subscription model, no recurring-charge scheduler anywhere in Lunar\Models or boboko-core. This is a one-time-purchase order/cart model end to end.
+
+ +
+
Failed-payment retry / dunningmissing
+
No retry scheduling, no dunning email sequence, no soft-decline handling anywhere in the payment layer — there's nothing to retry against since there's no recurring billing and no live gateway. WooPayments' dunning (1-3 day delayed retry on soft declines) is the comparison point.
+
+ +
+
PCI compliance / tokenized card storagemissing
+
No card data is collected or stored anywhere in this codebase (offline driver never touches card fields), so there's no PCI-scope exposure today — but also no tokenized-vault capability to build saved cards or 3DS on top of when a real gateway is added.
+
+ +
+
+ +
+

Compiled 2026-08-28 · boboko-core / docs

+

Section 01 (driver architecture) and section 02 (transaction lifecycle, refund/capture, observer, events) are grounded in direct reads of vendor/lunarphp/core/src/{Managers,PaymentTypes,Models,Observers,Events,Base} and vendor/lunarphp/lunar/src/Filament/Resources/OrderResource/Pages/ManageOrder.php, plus the published config/lunar/payments.php in 3dealer — not from docs/lunar.md alone, which was cross-checked and found to describe Lunar's general Stripe capability rather than anything installed in this project.

+

Sections 03 and 04, and the competitive framing throughout, draw on 2026 web research covering Shopify, WooCommerce/WooPayments, and PrestaShop payment modules, plus general industry trend reporting (Nuvei, Checkout.com, Mastercard). Those claims are marked by comparison language ("Shopify bundles...", "WooPayments advertises...") rather than citation to this repo.

+
+ +
diff --git a/docs/scratch/privacy-feature-survey.html b/docs/scratch/privacy-feature-survey.html new file mode 100644 index 0000000..a5dfe97 --- /dev/null +++ b/docs/scratch/privacy-feature-survey.html @@ -0,0 +1,492 @@ +Privacy Feature Survey + + + +
+ +
+
boboko / privacy & compliance · competitive survey
+

What privacy & compliance elsewhere can do that boboko can't yet

+

+ A feature-by-feature pass across GDPR/CCPA compliance tooling used by Shopify, + WooCommerce, and dedicated consent-management platforms — sourced, not recalled + from memory — checked against master and the substantial, + unmerged Privacy branch ("Feature: Creating Privacy + Basics") already built in this repo. For deciding what to finish and merge + next, not a build order. +

+
+ ● have + ◐ partial + ○ missing +
+
+ Most "partial" rows below are fully coded on the unmerged Privacy + branch (53 files, +3127/‑24 across two commits: 9f540cb, + 59303cf) but not on master — treated as partial, not + have, until it merges. boboko:anonymize is the one privacy-adjacent + command that already lives on master today. +
+
+ +
+
+ 01 +

Right of access & erasure

+
+

GDPR Art. 15 (access) and Art. 17 (erasure) — the two rights every DSAR tool is built around.

+ +
+
Data export request (right of access)
+ partial +
On Privacy branch only: PrivacyService::requestExportForCustomer()/requestExportForUser() queue ExportDataSubjectJob, which gathers every registered provider's data and writes a CSV-per-provider zip via WriteExportToCsvListener. Not on master.
+
+ +
+
Data erasure request (right to be forgotten)
+ partial +
On Privacy branch only: PrivacyService::requestErasureForCustomer()/requestErasureForUser(), extensible via config('core.privacy.providers') — the same config-array-registration pattern as NotificationRegistry, keyed off Modules\Core\Privacy\Contracts\PersonalDataProvider.
+
+ +
+
Cancellable grace period before erasure
+ partial +
On Privacy branch only: 30-day default (core.privacy.grace_period_days), reverted automatically on login via CancelErasureOnLoginListener — same pattern Shopify's own account-deletion flow uses. No native platform documents this as a first-party primitive; it's usually left to a third-party app.
+
+ +
+
Immediate erasure for regulator/legal requests
+ partial +
On Privacy branch only: requestImmediateErasureForCustomer()/ForUser(), typed to accept only Staff $requestedBy so a self-service path cannot reach it even by accident.
+
+ +
+
Multi-tenant erasure scoping (business account vs. individual login)
+ partial +
On Privacy branch only, and a genuinely uncommon feature: PrivacyService splits every operation into Customer-scope vs. User-scope, plus a sole-owner cascade (CascadeCustomerErasureListener) when erasing the last linked User orphans a Customer. No researched competitor product handles B2B multi-seat erasure this explicitly.
+
+ +
+
Right to rectification (self-service data correction)
+ missing +
No dedicated flow found on either branch — Art. 16 is generally satisfied today only incidentally, by a customer editing their own profile/address through existing account forms, not a tracked rectification request.
+
+ +
+
Dummy data anonymization for local dev
+ have +
On master: src/Command/AnonymizeCommand.php (boboko:anonymize) — scrubs users/lunar_customers, environment-guarded to local only. Distinct from GDPR erasure; the Privacy branch README diff explicitly flags this is not the compliance tool.
+
+
+ +
+
+ 02 +

Anonymization, pseudonymization & retention

+
+

Deletion isn't the only lawful outcome — these are three different operations, often confused with each other.

+ +
+
Legal-retention pseudonymization (orders/invoices)
+ partial +
On Privacy branch only: OrderDataProvider::eraseForCustomer() clears PII fields but keeps order rows/totals/tax data intact, citing GDPR Art. 17(3)(b)'s legal-obligation exception — reports ErasureOutcome::Pseudonymized, not Erased, distinctly.
+
+ +
+
Per-provider retention policy, owned by the data's own module
+ partial +
On Privacy branch only: PersonalDataProvider deliberately has no central taxonomy — each provider (CustomerDataProvider, AddressDataProvider, OrderDataProvider, CartDataProvider, ReviewDataProvider) decides erase vs. pseudonymize vs. skip for its own table. docs/privacy.md flags ReviewDataProvider's scope choice as needing review before relying on it.
+
+ +
+
Automatic data retention / auto-deletion after N days
+ missing +
Neither branch has a scheduled sweep that erases stale data on its own — every erasure on the Privacy branch is triggered by an explicit request, not a retention-policy timer (e.g. "delete guest carts after 2 years," "purge OTP logs after 90 days").
+
+ +
+
Audit trail of what was erased/exported and why
+ partial +
On Privacy branch only: DataErasureRequest.report stores the full per-provider outcome as a snapshot (not a live lookup), specifically so the audit record stays readable after the underlying data is gone.
+
+
+ +
+
+ 03 +

Consent & cookies

+
+

What a visitor is asked before tracking starts, and whether that choice is recorded anywhere.

+ +
+
Cookie consent banner (categorized: essential/analytics/marketing)
+ missing +
No code on either branch. Shopify ships a first-party Customer Privacy API recognizing four consent signals (analytics, marketing, preferences, sale-of-data); WooCommerce relies entirely on third-party plugins for this.
+
+ +
+
Granular marketing-consent tracking (email/SMS opt-in, per channel)
+ missing +
Not modeled anywhere in Modules\Core — no consent flag found on the Customer/User models on either branch.
+
+ +
+
Timestamped, versioned consent log (audit trail per visitor)
+ missing +
Standard feature of dedicated CMPs (OneTrust, Enzuzo, Consentmo) — a logged record of which policy version a visitor consented to and when. Nothing comparable exists in this codebase; the Privacy branch's audit trail covers erasure/export requests only, not consent events.
+
+ +
+
Google Consent Mode v2 / IAB TCF v2.3 integration
+ missing +
Storefront/analytics-layer concern, not present in boboko-core at all — would live in the 3dealer storefront, not this package.
+
+
+ +
+
+ 04 +

Policy & agreement management

+
+

Terms of service and privacy policy as tracked, versioned documents — not just static pages.

+ +
+
Terms-of-service / privacy-policy versioning
+ missing +
No version-tracked policy document model on either branch — best practice researched: store version hashes or dated text alongside each acceptance record, review at least annually.
+
+ +
+
Per-user acceptance tracking (clickwrap audit trail)
+ missing +
No record of "which policy version did this customer accept, and when" anywhere in Modules\Core. Researched as a standard requirement for surviving a legal dispute or regulatory inquiry.
+
+ +
+
Re-acceptance prompt on material policy change
+ missing +
Depends on the versioning row above existing first — nothing to gate a re-prompt on today.
+
+
+ +
+
+ 05 +

Payment data & PCI-DSS scope

+
+

Whether cardholder data ever actually reaches boboko's own infrastructure.

+ +
+
Card data never touches application servers (tokenization)
+ have +
Verified from source: docs/lunar.md "Stripe integration" — payment flows through Lunar's Stripe driver (Lunar\Stripe\Facades\Stripe, fetchOrCreateIntent()/PaymentIntents), so PAN never lands in a boboko/Lunar database. Researched: this pattern alone can cut PCI-DSS scope by roughly 90% per industry sources.
+
+ +
+
Self-attested SAQ-A eligibility documentation
+ missing +
The technical precondition (no card data touching the server) is met, but nothing in docs/ documents or asserts SAQ-A eligibility for a consuming app's own compliance paperwork.
+
+
+ +
+
+ 06 +

Regional & regulatory coverage

+
+

Beyond GDPR — the other regimes a storefront selling outside the EU may need.

+ +
+
CCPA "Do Not Sell/Share My Info" opt-out
+ missing +
No opt-out flag or page found on either branch. Shopify's Customer Privacy API models this as a distinct fourth consent signal ("sale of data") alongside analytics/marketing/preferences — boboko has no equivalent signal at all yet.
+
+ +
+
Geo-targeted regulatory detection (GDPR vs. CCPA vs. LGPD banner)
+ missing +
Third-party CMPs (Consentmo, UniConsent) auto-detect visitor region to show the applicable banner/rights. No geo-based privacy-regime logic anywhere in this codebase.
+
+ +
+
Age verification / minor-data restrictions (COPPA-adjacent)
+ missing +
No age gate or minor-specific data handling found on either branch.
+
+
+ +
+
+ 07 +

Incident & vendor accountability

+
+

What happens when something goes wrong, or when a third party is handling data on the shop's behalf.

+ +
+
Data breach notification workflow
+ missing +
No incident-tracking model or notification path found on either branch — GDPR Art. 33/34's 72-hour authority-notification and affected-subject-notification duties have no tooling here today.
+
+ +
+
Subprocessor / third-party vendor disclosure list
+ missing +
No subprocessor registry in code — Stripe is the one third-party data processor identifiable from docs/lunar.md, but nothing formally tracks or discloses it as a subprocessor.
+
+ +
+
Data processing agreement (DPA) tracking per vendor
+ missing +
Not applicable to application code directly, but no config or doc references a DPA registry either — purely a legal/ops artifact today, not represented in boboko-core at all.
+
+
+ +
+ Compiled 2026-08-28 — have/partial statuses sourced from direct reads of master and the unmerged Privacy branch (commits 9f540cb, 59303cf) via git show; competitor/regulatory claims sourced from web research, cited inline. + boboko-core / docs +
+ +
diff --git a/docs/scratch/products-collections-feature-survey.html b/docs/scratch/products-collections-feature-survey.html new file mode 100644 index 0000000..239aa6d --- /dev/null +++ b/docs/scratch/products-collections-feature-survey.html @@ -0,0 +1,508 @@ +Products & Collections Feature Survey + + + +
+ +
+
boboko / products & collections · competitive survey
+

What products & collections elsewhere can do that boboko can't yet

+

+ A feature-by-feature pass across Shopify, WooCommerce, PrestaShop, and general + 2026 storefront UX trends — checked against what + Modules\Core\Catalog actually ships in boboko-core + and what 3dealer's storefront actually calls. Unlike the rest of this survey + series, this concern is not a blank slate: a real Meilisearch-backed catalog + layer (listing, filtering, facets, search, collections, a product-option-type + system) was built this session. The gaps here are mostly about storefront wiring + and discovery/merchandising UX, not backend plumbing. +

+
+ Read this first: the category page's sort dropdown, price + slider, in-stock checkbox, and sidebar search box are all visually present but + functionally dead — none of them submit a request or call a filter. The backend + methods they'd need (ProductService::facets(), + priceRange(), list()'s sort param) already exist and + work; nothing in CategoryController passes them through yet. +
+
+ ● have + ◐ partial + ○ missing +
+
31 features surveyed — 8 have · 10 partial · 13 missing
+
+ +
+
+ 01 +

Core listing & filtering plumbing

+
+

The Meilisearch-backed layer everything else in this survey sits on top of — this is where most of this session's real build lives.

+ +
+
Paginated product listing, index-backed (not DB reads)
+ have +
ProductService::list() reads Product::search('') via Meilisearch and returns a real LengthAwarePaginator — used end-to-end by CategoryController::show() and rendered by x-product-grid.
+
+ +
+
Filter by collection (including descendant collections)
+ have +
ProductFilters::collectionId matches ProductIndexer's collection_ids field, which unions a product's direct collections with all ancestors — so a parent-category page picks up products attached only to a leaf subcategory. Wired in CategoryController.
+
+ +
+
Filter by brand, price range, stock status
+ partial +
ProductFilters supports brand, minPrice/maxPrice, inStockOnly, fully implemented in ProductService::buildFilter() — but category/show.blade.php's price slider and in-stock checkbox are hardcoded markup with no form submission; CategoryController never constructs a ProductFilters with any of these three.
+
+ +
+
Faceted counts for a filter sidebar (brand, stock, etc.)
+ partial +
ProductService::facets() returns value→count via Meilisearch facetDistribution, correctly scoped to co-applied filters — but nothing storefront-side calls it. No brand/attribute facet list renders anywhere in category/show.blade.php.
+
+ +
+
Price-range slider backed by real min/max
+ partial +
ProductService::priceRange() reads Meilisearch facetStats for a correct, filter-scoped min/max — the sidebar instead shows a static "€10 - €50" label with a non-functional apply button.
+
+ +
+
Sort (price asc/desc, newest)
+ partial +
ProductSort enum + ProductIndexer::getSortableFields() (price, created_at) work end-to-end in ProductService::list(sort: ...) — the storefront's sort <select> is explicitly commented {{-- Dummy — not wired to real sorting yet --}} and includes a "popularity" option with no backing signal at all.
+
+ +
+
Free-text product search
+ partial +
ProductSearchService::search() is a complete, locale-aware, fallback-safe implementation (attributesToSearchOn targeting current + default locale) — but no search route exists in 3dealer (routes/web.php only has product.show/category.show), and both the header search icon and the sidebar search box are inert buttons/inputs.
+
+ +
+
Single-product lookup by slug or id, index-only
+ have +
ProductService::getById()/getBySlug(), both zero-database-read lookups against the slugs/id filterable fields. ProductController::show() uses getById() directly.
+
+
+ +
+
+ 02 +

Collections & navigation

+
+

Category tree browsing, breadcrumbs, and merchandising — what turns a flat product list into a navigable store.

+ +
+
Category tree browsing (root / children / by group)
+ have +
CollectionService::list() with CollectionFilters(rootOnly/parentId/groupId), backed by CollectionIndexer's nested-set parent_id/_lft fields — no database read needed to build a nav tree.
+
+ +
+
Top-nav category dropdown
+ have +
components/header.blade.php renders a CSS-only hover dropdown from a $categories list passed into the layout, linking to category.show.
+
+ +
+
Breadcrumb navigation
+ partial +
CollectionIndexer indexes a full root-first ancestors array ({id, name}) specifically so a breadcrumb needs zero extra queries — but category/show.blade.php and product/show.blade.php both build a flat two-level x-breadcrumb (Home → this category/product) by hand, never reading ancestors. A product under a three-deep category shows no intermediate levels.
+
+ +
+
Category landing page merchandising (banner, pinned/featured products)
+ missing +
category/show.blade.php renders only the collection name/description above a plain product grid — no banner image field, no "featured in this category" pinning above organic results. CollectionIndexer's thumbnail field exists but isn't read on the category page at all (only used, if anywhere, for nav-level imagery).
+
+ +
+
Sub-category faceting (filter by attribute within a category)
+ missing +
No attribute-value facet (size, material, etc.) is indexed as filterable on ProductIndexer beyond brand and in_stock — a category page can't offer "filter dresses by size" the way Shopify/WooCommerce faceted nav does; would need new filterable fields on custom product attributes plus sidebar UI.
+
+ +
+
Product count shown per category
+ partial +
CollectionIndexer computes product_count (including descendant collections) at index time by querying the product index directly — correct and cheap, but nothing in category/show.blade.php or the nav dropdown displays it.
+
+
+ +
+
+ 03 +

Product detail page

+
+

What a shopper sees once they land on a single product — media, variants, reviews, cross-sell.

+ +
+
Multi-image gallery with lightbox
+ have +
product/show.blade.php's product-gallery Stimulus controller — thumbnail rail, main image, full popover lightbox with prev/next/counter — fed from ProductIndexer's full media array (not just a single thumbnail).
+
+ +
+
Variant selection via color swatches
+ have +
End-to-end: ColorOptionType lets an admin attach a hex code to an option value → ProductIndexer::mapVariant() embeds meta.hex per variant → x-ui.color-swatch renders real swatch buttons wired to a product-form Stimulus controller that swaps price/image on selection.
+
+ +
+
Swatches for non-color attributes (pattern, texture, material)
+ partial +
The ProductOptionTypeInterface system is explicitly built to be extensible — a PatternOptionType or MaterialOptionType is a new class plus a Filament form, no core change needed — but only ColorOptionType is registered, and x-ui.color-swatch itself hardcodes a background-color swatch, not a generic swatch renderer.
+
+ +
+
Customer reviews with ratings, photos, staff replies
+ have +
ProductReview model, fully indexed (items/count/average_rating, PII-safe), live-reindexed on review create/update/delete via ReviewServiceProvider, and rendered in product/show.blade.php's Reviews tab with x-review-card/x-review-form.
+
+ +
+
Structured data / schema.org Product markup
+ missing +
No application/ld+json or itemscope markup anywhere in 3dealer's views. Rich results (price/rating/availability in Google Shopping) are a significant organic-CTR lever per 2026 SEO guidance — the product page already has every field (price, rating, stock) a Product schema block would need, just not emitted.
+
+ +
+
Related products / "customers also bought" / cross-sell
+ missing +
Raw Lunar already models this (Lunar\Base\Enums\ProductAssociation::CROSS_SELL/UP_SELL/ALTERNATE, $product->associate()/associations() — see docs/lunar.md "Products and Variants") but nothing in Modules\Core\Catalog surfaces it, and the "Σχετικά προϊόντα" block at the bottom of product/show.blade.php is four fully hardcoded fake products with href => '#'.
+
+ +
+
Recently-viewed products
+ missing +
No session/cookie tracking of viewed products anywhere in 3dealer or core — a standard discovery module on both Shopify and WooCommerce storefronts per current UX research.
+
+ +
+
Product badges (new / sale / bestseller)
+ missing +
No badge concept on ProductIndexer's document and no badge markup on x-ui.product-card — would need either a computed signal (e.g. "new" from created_at, "sale" from compare_price already indexed per-variant) or an admin-set tag, neither wired to a visual badge today.
+
+ +
+
Size chart / fit guide
+ missing +
No size-chart content field on Product/ProductType and no UI for it on the product page. Not especially relevant to 3dealer's current catalog (3D-printed goods), but a real gap for any apparel-leaning store built on this core.
+
+ +
+
Stock notification ("notify me when back in stock")
+ missing +
in_stock is indexed and known per-product (ProductIndexer::toSearchableArray()), but there's no subscription model, email trigger, or UI for a shopper to ask to be notified — the signal exists, nothing acts on it.
+
+ +
+
Product Q&A section
+ missing +
No question/answer model anywhere in core — only the separate review system (ProductReview) exists, which is a distinct concept (post-purchase rating, not pre-purchase Q&A).
+
+
+ +
+
+ 04 +

Emerging discovery & merchandising UX

+
+

2026 trend-adjacent features, mostly backed on other platforms by paid apps/plugins rather than core — useful for calibrating how unusual these gaps are.

+ +
+
Quick-view modal (preview from listing grid, no page load)
+ missing +
x-ui.product-card links straight to product.show with a hover-revealed "add to cart" button only — no modal/preview interaction. Current UX research flags quick-view modals as a common INP (responsiveness) failure point, so the absence isn't purely a gap to close blindly.
+
+ +
+
Infinite scroll as an alternative to pagination
+ missing +
category/show.blade.php uses classic x-ui.pagination against the real paginator from ProductService::list() — works correctly, just page-based rather than scroll-based. Research is genuinely mixed on whether infinite scroll is even preferable for conversion/SEO, so this is a parity note, not a clear gap.
+
+ +
+
Product comparison tool (side-by-side spec table)
+ missing +
Not in boboko-core, and notably not native on Shopify or WooCommerce either — both rely on third-party apps (Bear Specs & Compare, Equate, WooCommerce's own paid "Advanced Product Comparison" extension). A real gap, but not one competitors solve in-platform for free.
+
+ +
+
Product bundles / kits
+ missing +
No bundle/kit concept (a purchasable grouping of several variants as one line item) anywhere in Lunar\Models\Product/ProductVariant or Modules\Core\Catalog.
+
+ +
+
360°/video product media, AR try-on
+ partial +
ProductIndexer's media array is just Spatie media-library images (url/thumb) — no video or 360° asset type modeled, and no AR integration. The gallery component (product-gallery Stimulus controller) is generic enough to extend to a video slide without a rewrite, but nothing does today.
+
+ +
+
Variant-specific SEO URLs (distinct slug per color/size)
+ partial +
Lunar's HasUrls/Url model supports per-locale slugs per product (indexed in ProductIndexer's slugs field), but there's no per-variant URL — selecting a color swatch changes displayed price/image via product-form client-side state, not the URL, so a specific variant can't be linked or indexed separately.
+
+
+ +
+ Compiled 2026-08-28 — Modules\Core\Catalog source, docs, and 3dealer storefront claims are direct reads; 2026 UX-trend, quick-view/infinite-scroll, and product-comparison-tooling claims are sourced from web research and marked accordingly in context. + boboko-core / docs +
+ +
diff --git a/docs/scratch/shipping-feature-survey.html b/docs/scratch/shipping-feature-survey.html new file mode 100644 index 0000000..ccccbc7 --- /dev/null +++ b/docs/scratch/shipping-feature-survey.html @@ -0,0 +1,465 @@ +Shipping Feature Survey + + + +
+ +
+
boboko / shipping · competitive survey
+

What shipping elsewhere can do that boboko can't yet

+

+ A feature-by-feature pass across Shopify, WooCommerce, and PrestaShop's shipping + layer — sourced, not recalled from memory — checked against what + Lunar core's ShippingManifest and the + lunarphp/table-rate-shipping add-on actually support + today, and what's actually wired up in boboko-core and 3dealer right now. + For deciding what to design next, not a build order. +

+
+ ● have + ◐ partial + ○ missing +
+
+ +
+
+ 01 +

Core plumbing

+
+

The mechanism Lunar core provides for offering and applying a shipping charge — everything else in this survey is built on top of it.

+ +
+
Pluggable shipping option providers
+ have +
Lunar\Base\ShippingModifier abstract class + ShippingManifest::addOption() — any package can register options onto the manifest via a pipeline of modifiers (ShippingModifiers::getModifiers()).
+
+ +
+
Shipping applied to cart totals during calculate()
+ have +
Lunar\Pipelines\Cart\ApplyShipping — reads ShippingManifest::getShippingOption($cart) or a manual shippingOptionOverride, writes a ShippingBreakdown and shippingSubTotal onto the cart before CalculateTax runs.
+
+ +
+
Cart-level shippable check
+ have +
Cart::isShippable() — true if any line's purchasable (e.g. ProductVariant::isShippable()) is shippable; a digital-only cart skips the shipping-address requirement entirely.
+
+ +
+
Selecting a shipping option on the cart
+ have +
Cart::setShippingOption() → SetShippingOption action, validated by ShippingOptionValidator, triggers a recalculate. Nothing in 3dealer's storefront calls it yet — no shipping step exists in the UI.
+
+ +
+
Order-time shipping line snapshot
+ have +
Lunar\Pipelines\Order\Creation\CreateShippingLine writes an immutable shipping-type order line from the cart's shipping breakdown at checkout — survives later rate changes.
+
+
+ +
+
+ 02 +

Rate configuration (table-rate-shipping add-on)

+
+

lunarphp/table-rate-shipping is installed (composer.json, pinned ^1.3) and its ShippingPlugin is registered in CorePlugin::boot() — so 3dealer inherits it automatically, it doesn't need its own registration.

+ +
+
Geographic shipping zones (country / state / postcode)
+ have +
ShippingZone model, type unrestricted|countries|states|postcodes; ShippingZoneResolver::get() matches a cart's address against zone scope, falling back to any unrestricted zone.
+
+ +
+
Flat-rate shipping
+ have +
Drivers\ShippingMethods\FlatRate::resolve() — one price per cart subtotal via Pricing::for($shippingRate).
+
+ +
+
Weight- or total-tiered rates ("ship by")
+ have +
Drivers\ShippingMethods\ShipBy::resolve() — data['charge_by'] is cart_total or weight, tiered via priceBreaks, with customer-group price overrides taking priority.
+
+ +
+
Free-shipping threshold
+ have +
Drivers\ShippingMethods\FreeShipping::resolve() — data['minimum_spend'] (per-currency array supported), optional use_discount_amount to check against post-discount subtotal.
+
+ +
+
In-store pickup / collection
+ have +
Drivers\ShippingMethods\Collection::resolve() — zero-price option, flagged collect: true on the ShippingOption. Single implicit "store" — no concept of which location, no per-location stock or hours.
+
+ +
+
Per-product shipping exclusions by zone
+ have +
ShippingExclusionList + ShippingZone::shippingExclusions() — every driver checks it before resolving and returns null if any cart line's product is excluded from that zone.
+
+ +
+
Per-customer-group rate visibility
+ have +
ShippingMethod::customerGroups() pivot carries visible, enabled, starts_at, ends_at — scheduling and audience-gating a rate is already modeled.
+
+ +
+
Filament admin UI for zones/methods/rates
+ have +
ShippingZoneResource, ShippingMethodResource, ShippingExclusionListResource ship with the add-on — usable as soon as the Filament plugin is registered, which it is via CorePlugin.
+
+ +
+
Storefront checkout step to pick a rate
+ missing +
No shipping views exist in 3dealer's resources/views beyond a passing mention in components/footer.blade.php — the whole backend above is unwired to any customer-facing UI.
+
+
+ +
+
+ 03 +

Carrier integration

+
+

Real carriers quoting and printing on Lunar's behalf, rather than merchant-defined flat/tiered rates.

+ +
+
Real-time carrier rate shopping (USPS/UPS/FedEx/DHL)
+ missing +
No driver in table-rate-shipping calls an external carrier API — all four shipped drivers (FlatRate, ShipBy, FreeShipping, Collection) compute from local data. Shopify's CarrierService API is the model for this: shop sends weight/dims/destination, carrier returns live rates at checkout.
+
+ +
+
Product/variant weight & dimensions for rating
+ partial +
ProductVariant has weight_value/weight_unit (referenced in ShipBy's weight tier and docs/lunar.md) but no length/width/height fields exist in core migrations — enough for weight-tier rating, not enough for carrier-grade dimensional/volumetric quotes.
+
+ +
+
Shipping label generation & printing (staff-facing)
+ missing +
No label concept anywhere in core or the add-on. Shopify has this built in for US merchants (USPS/UPS labels from admin or mobile); WooCommerce/PrestaShop lean on Shippo/EasyPost-style apps.
+
+ +
+
Return / exchange label generation
+ missing +
No returns concept exists in Lunar core at all — this sits behind both "labels" and "returns," neither of which exists yet.
+
+ +
+
Shipment tracking numbers on orders
+ missing +
OrderShippingZone pivot table records which zone an order matched, but no field anywhere stores a carrier tracking number or shipment status.
+
+
+ +
+
+ 04 +

Fulfillment logistics

+
+

Where an order physically ships from, and whether it can ship from more than one place.

+ +
+
Multi-warehouse / multi-location inventory
+ missing +
No warehouse, location, or fulfillment-center model anywhere in vendor/lunarphp/core or lunar — stock is a flat quantity on the variant. WooCommerce needs Calcurates or WooCommerce Warehouses add-ons for this; it's genuinely not a Lunar concept at all.
+
+ +
+
Split shipment (one order, multiple packages/warehouses)
+ missing +
Downstream of multi-warehouse — with a single implicit stock pool, there's nothing to split by. CreateShippingLine writes exactly one shipping line per order.
+
+ +
+
Multiple pickup locations (choose a specific store)
+ missing +
The Collection driver models pickup as a single yes/no rate per zone — no location entity to pick from, no per-location hours/capacity.
+
+ +
+
Local delivery (distinct from carrier shipping or pickup)
+ missing +
No radius/zone-based "we deliver it ourselves" driver — only ShipBy/FlatRate (carrier-agnostic priced shipping) and Collection (pickup) exist as concepts.
+
+ +
+
Delivery date / time-slot selection at checkout
+ missing +
No date/time field on ShippingOption, CartAddress, or the order shipping line. WooCommerce needs a dedicated delivery-date-picker plugin for this too — not a gap unique to Lunar, but still open here.
+
+
+ +
+
+ 05 +

International & risk

+
+

What happens when a shipment crosses a border, or something goes wrong in transit.

+ +
+
Customs documentation / HS codes per product
+ missing +
No HS-code or customs-description field found on Product/ProductVariant migrations. Every international shipment needs one per line item to clear customs — researched requirement, not yet modeled anywhere in Lunar.
+
+ +
+
Duties/taxes collected at checkout (DDP)
+ missing +
Lunar's CalculateTax pipeline step handles sales tax/VAT on the cart itself, not import duty estimation for cross-border orders. DDP vs. DDU is the standard framing (seller-collects-upfront vs. customer-pays-on-delivery) — neither is modeled.
+
+ +
+
Country/zone-restricted shipping
+ have +
ShippingZone type countries/states/postcodes already scopes which rates apply where — the building block international shipping would sit on top of.
+
+ +
+
Shipping insurance / package protection at checkout
+ missing +
No insurance line-item concept in core. On Shopify this is exclusively third-party (ShipInsure, Route, Simply Shipping Protection) — not a platform-native feature there either, so the gap is normal, not distinctive.
+
+
+ +
+ Compiled 2026-08-28 — inline citations from vendor/lunarphp/core and vendor/lunarphp/table-rate-shipping source are direct reads; DDP/DDU, carrier-API, label, and warehouse claims are sourced from web research on Shopify/WooCommerce/PrestaShop, marked accordingly by context. + boboko-core / docs +
+ +
diff --git a/docs/shopify-import.md b/docs/shopify-import.md index 8534085..5a477db 100644 --- a/docs/shopify-import.md +++ b/docs/shopify-import.md @@ -2,6 +2,9 @@ Findings from comparing a real Shopify product export CSV against Lunar's schema (`vendor/lunarphp/core`), plus the resulting implementation plan for `MigrateImport\Shopify\ShopifyExportImporter`. +Need to discard everything and re-import from scratch (e.g. after a schema/indexer change that +only applies to newly-created rows)? See `docs/shopify-reimport.md`. + ## Idempotency problem Nothing in Lunar tracks "this record came from external system X, ID Y." Re-running an import with no external-ID tracking would duplicate every product on each run. diff --git a/docs/shopify-reimport.md b/docs/shopify-reimport.md new file mode 100644 index 0000000..a5de9b3 --- /dev/null +++ b/docs/shopify-reimport.md @@ -0,0 +1,149 @@ +# Wiping products before a clean Shopify re-import + +A runbook for discarding every imported product (and everything that hangs off one — +variants, prices, media, reviews, options/values, the Meilisearch documents) and re-running +`ShopifyExportImporter` from scratch. Useful after a schema/indexer change that only applies to +newly-created rows (see "Why a wipe, not an update" below), or when the export CSV itself changed +enough that stale products need to go, not just be updated in place. + +Every command below is a `tinker --execute=` one-liner run inside the app container — adjust the +exec prefix (`./bin/dc-core.sh exec app ...`, `docker compose exec app ...`, etc.) for your setup. + +--- + +## Why a wipe, not an update + +`ShopifyExportImporter`'s resolvers are mostly `firstOrCreate` — re-running the importer against +an *existing* database updates matched rows but leaves already-created ones exactly as they were. +That's the right behavior for routine re-imports (an updated price, a new variant), but it means a +change to what gets set **at creation time only** — e.g. `ProductOptionResolver` now also setting +`label`, not just `name`, on a `ProductOption` — never reaches a `ProductOption` row that already +exists. A wipe forces every row to go through creation again, picking up such fixes. + +--- + +## 1. Delete every product + +Cascades to `ProductVariant`, prices, and Spatie media rows — verified live (see +`shopify-import.md`'s own history/commit log for context). Also removes each product's Meilisearch +document automatically, via Scout's own delete hook fired on `forceDelete()` — no separate +`scout:flush` needed. + +```php +\Lunar\Models\Product::withTrashed()->get()->each->forceDelete(); +``` + +**Let this run to completion.** Interrupting it mid-loop (e.g. Ctrl+C on the tinker session) stops +after whichever product it was on, leaving the rest undeleted — safe to just re-run the same +command again afterward, since already-deleted products are simply skipped. + +Verify: + +```php +\Lunar\Models\Product::withTrashed()->count(); // 0 +``` + +### Requires: `product_reviews.product_id` cascades on delete + +`product_reviews` (boboko-core's own table, not Lunar's) originally had no `ON DELETE` clause on +its `product_id` foreign key — deleting a reviewed product threw a constraint violation instead of +the review going with it. Fixed by +`database/migrations/2026_09_03_000001_add_cascade_delete_to_product_reviews_product_id.php`. Make +sure this migration has actually run (`php artisan migrate`) before step 1, or a product with +reviews will fail to delete. + +--- + +## 2. Delete product options and values + +Not touched by step 1 (`ProductOption`/`ProductOptionValue` aren't scoped to one product — they're +shared across the catalog, per `ProductOptionResolver::resolveOption()`'s `shared: true`). Safe to +delete in full once every product (and therefore every variant referencing an option value via the +`product_option_value_product_variant` pivot) is gone — deleting values while variants still +reference them throws the same kind of FK violation step 1 guards against. + +```php +\Lunar\Models\ProductOptionValue::query()->delete(); +\Lunar\Models\ProductOption::query()->delete(); +``` + +Verify: + +```php +\Lunar\Models\ProductOption::count(); // 0 +\Lunar\Models\ProductOptionValue::count(); // 0 +``` + +--- + +## 3. Clear the import mappings + +Without this, the importer's `ImportMapping::resolve(...)` calls still find the (now-deleted) +mappings' rows absent, so this step is really about not leaving stale mapping rows pointing at +nothing — `ImportMapping` rows aren't foreign-keyed to the models they map (`morphTo`, no +constraint), so leaving them wouldn't break the re-import, but a stale mapping for a product that +no longer exists is dead weight. + +```php +\Modules\Core\MigrateImport\Models\ImportMapping::where('source', 'shopify')->delete(); +``` + +Verify: + +```php +\Modules\Core\MigrateImport\Models\ImportMapping::where('source', 'shopify')->count(); // 0 +``` + +--- + +## 4. Re-run the importer + +`boboko:migrate:import` dispatches `RunMigrateImportJob` onto the queue — **not synchronous** — +so a queue worker must actually be running (`php artisan queue:work`, or your dev queue container) +or the job just sits queued. + +```bash +php artisan boboko:migrate:import --source=shopify --type=export --file= +``` + +The `--file` value must be an **absolute path** inside the container (e.g. +`/var/www/html/storage/app/private/imports/shopify/products_export.csv`) when running +non-interactively — a path relative to `storage/app/private/imports` only resolves correctly when +the command can fall back to its interactive prompt, which isn't available in a scripted/non-TTY +run. + +Watch the queue worker's own log output for `FAIL` entries (see `docs/lunar.md` or your compose +setup for how logs are routed to `docker compose logs`) — a clean run shows every +`Laravel\Scout\Jobs\MakeSearchable` / `Spatie\MediaLibrary\Conversions\Jobs\PerformConversionsJob` +line ending `DONE`, never `FAIL`. + +--- + +## 5. Re-sync Meilisearch and reindex + +```bash +php artisan lunar:meilisearch:setup +php artisan lunar:meilisearch:tune-product-search +php artisan lunar:search:index "Lunar\Models\Product" --refresh +``` + +`--refresh` re-syncs filterable/sortable index settings *and* reindexes every document — it does +not reset `typoTolerance`/`prefixSearch` (confirmed live: both survived a `--refresh` run +unchanged), so `tune-product-search` only needs re-running here for completeness/if it hadn't +already been applied, not because `--refresh` would have clobbered it. + +--- + +## Verifying the result + +```php +// Product count should match the CSV's actual unique `Handle` count, not +// whatever the database held before the wipe — those aren't the same number +// if stale/manually-added products existed alongside the CSV-sourced ones. +\Lunar\Models\Product::count(); + +// Spot-check that at least one variant picked up its own image (see +// shopify-import.md's "Images" section) — 0 is only correct if the CSV +// genuinely has no `Variant Image` values populated. +\Lunar\Models\ProductVariant::has('images')->count(); +``` diff --git a/lang/el/countries.php b/lang/el/countries.php new file mode 100644 index 0000000..ead97b9 --- /dev/null +++ b/lang/el/countries.php @@ -0,0 +1,21 @@ +name) — core has no + * storefront UI of its own to wire this into (see docs/lunar.md). + * + * Only Greece is covered — this store operates within Greece; add further + * countries here as needed. + */ +return [ + 'Greece' => 'Ελλάδα', +]; diff --git a/lang/el/states.php b/lang/el/states.php new file mode 100644 index 0000000..fea5880 --- /dev/null +++ b/lang/el/states.php @@ -0,0 +1,52 @@ + 'Περιφερειακή Ενότητα Αχαΐας', + 'Aetolia-Acarnania Regional Unit' => 'Περιφερειακή Ενότητα Αιτωλοακαρνανίας', + 'Arcadia Prefecture' => 'Νομός Αρκαδίας', + 'Argolis Regional Unit' => 'Περιφερειακή Ενότητα Αργολίδας', + 'Attica Region' => 'Περιφέρεια Αττικής', + 'Boeotia Regional Unit' => 'Περιφερειακή Ενότητα Βοιωτίας', + 'Central Greece Region' => 'Περιφέρεια Στερεάς Ελλάδας', + 'Central Macedonia' => 'Κεντρική Μακεδονία', + 'Chania Regional Unit' => 'Περιφερειακή Ενότητα Χανίων', + 'Corfu Prefecture' => 'Νομός Κέρκυρας', + 'Corinthia Regional Unit' => 'Περιφερειακή Ενότητα Κορινθίας', + 'Crete Region' => 'Περιφέρεια Κρήτης', + 'Drama Regional Unit' => 'Περιφερειακή Ενότητα Δράμας', + 'East Attica Regional Unit' => 'Περιφερειακή Ενότητα Ανατολικής Αττικής', + 'East Macedonia and Thrace' => 'Ανατολική Μακεδονία και Θράκη', + 'Epirus Region' => 'Περιφέρεια Ηπείρου', + 'Euboea' => 'Εύβοια', + 'Grevena Prefecture' => 'Νομός Γρεβενών', + 'Imathia Regional Unit' => 'Περιφερειακή Ενότητα Ημαθίας', + 'Ioannina Regional Unit' => 'Περιφερειακή Ενότητα Ιωαννίνων', + 'Ionian Islands Region' => 'Περιφέρεια Ιονίων Νήσων', + 'Karditsa Regional Unit' => 'Περιφερειακή Ενότητα Καρδίτσας', + 'Kastoria Regional Unit' => 'Περιφερειακή Ενότητα Καστοριάς', + 'Kefalonia Prefecture' => 'Νομός Κεφαλληνίας', + 'Kilkis Regional Unit' => 'Περιφερειακή Ενότητα Κιλκίς', + 'Kozani Prefecture' => 'Νομός Κοζάνης', + 'Laconia' => 'Λακωνία', + 'Larissa Prefecture' => 'Νομός Λάρισας', + 'Lefkada Regional Unit' => 'Περιφερειακή Ενότητα Λευκάδας', + 'Pella Regional Unit' => 'Περιφερειακή Ενότητα Πέλλας', + 'Peloponnese Region' => 'Περιφέρεια Πελοποννήσου', + 'Phthiotis Prefecture' => 'Νομός Φθιώτιδας', + 'Preveza Prefecture' => 'Νομός Πρέβεζας', + 'Serres Prefecture' => 'Νομός Σερρών', + 'South Aegean' => 'Νότιο Αιγαίο', + 'Thessaloniki Regional Unit' => 'Περιφερειακή Ενότητα Θεσσαλονίκης', + 'West Greece Region' => 'Περιφέρεια Δυτικής Ελλάδας', + 'West Macedonia Region' => 'Περιφέρεια Δυτικής Μακεδονίας', +]; diff --git a/resources/views/auth/filament/pages/login.blade.php b/resources/views/auth/filament/pages/login.blade.php index 352c696..5facf94 100644 --- a/resources/views/auth/filament/pages/login.blade.php +++ b/resources/views/auth/filament/pages/login.blade.php @@ -2,7 +2,7 @@ @if (! $otpSent)
-
+
@else -
+

A login code was sent to {{ $email }}.

diff --git a/resources/views/order/infolists/transaction.blade.php b/resources/views/order/infolists/transaction.blade.php new file mode 100644 index 0000000..0131675 --- /dev/null +++ b/resources/views/order/infolists/transaction.blade.php @@ -0,0 +1,127 @@ +@php + $transaction = $getRecord(); + $notes = $transaction->notes ?: ($transaction->meta['notes'] ?? null); +@endphp + +@once + @php + $renderPaymentIcons(); + @endphp +@endonce +
type){ + 'refund' => 'border-orange-300', + 'intent' => 'border-sky-300', + 'capture' => 'border-green-300', + default => 'border-gray-300', + }, + '!border-red-500 bg-red-50' => !$transaction->success, + 'bg-gray-50' => $transaction->success, + ]) +> +
+
+ {{ $transaction->driver }} // + {{ $transaction->reference }} +
+ +
+
+
+ + {{ $transaction->status }} + +
+ +
+ + + +
+ + @if($transaction->last_four) +

+ + ∗∗∗∗ ∗∗∗∗ ∗∗∗∗ + + + + {{ (string) $transaction->last_four }} + +

+ @endif +
+ + !$transaction->success, + match($transaction->type){ + 'refund' => "text-orange-500", + default => "text-gray-900 dark:text-gray-100", + }, + ]) + > + @if($transaction->type == 'refund')-@endif{{ $transaction->amount->formatted }} + +
+ +
+
+
+ +
+ {{ $transaction->created_at->format('jS F Y h:ia') }} +
+ +
+ @foreach($transaction->paymentChecks() as $check) + + {{ $check->label }}: {{ $check->message }} + + @endforeach +
+
+ + @if($notes) +
+
+ +
+ +

{{ $notes }}

+
+ @endif +
+ +
!$transaction->success, + match($transaction->type){ + 'refund' => "bg-orange-50 dark:bg-orange-400/10 border-orange-300 text-orange-600 dark:text-orange-400", + 'intent' => "bg-sky-50 dark:bg-sky-400/10 border-sky-300 text-sky-600 dark:text-sky-400", + 'capture' => "bg-green-50 dark:bg-green-400/10 border-green-300 text-green-600 dark:text-green-400", + default => "bg-gray-50 dark:bg-gray-400/10 border-gray-300 text-gray-600 dark:text-gray-400", + }, + ]) + > + @if(!$transaction->success) + {{ __('lunarpanel::order.transactions.failed') }} + @else + {{ __('lunarpanel::order.transactions.'.$transaction->type) }} + @endif +
+
diff --git a/resources/views/order/notifications/captured.blade.php b/resources/views/order/notifications/captured.blade.php new file mode 100644 index 0000000..06b97e2 --- /dev/null +++ b/resources/views/order/notifications/captured.blade.php @@ -0,0 +1,3 @@ +

Hi,

+ +

Payment of {{ $amount }} for your order {{ $reference }} has been captured.

diff --git a/resources/views/order/notifications/completed.blade.php b/resources/views/order/notifications/completed.blade.php new file mode 100644 index 0000000..d5df044 --- /dev/null +++ b/resources/views/order/notifications/completed.blade.php @@ -0,0 +1,3 @@ +

Hi,

+ +

Your order {{ $reference }} is complete. Thanks for shopping with us!

diff --git a/resources/views/order/notifications/delivered.blade.php b/resources/views/order/notifications/delivered.blade.php new file mode 100644 index 0000000..5e3f1d4 --- /dev/null +++ b/resources/views/order/notifications/delivered.blade.php @@ -0,0 +1,3 @@ +

Hi,

+ +

Good news — your order {{ $reference }} has been delivered.

diff --git a/resources/views/order/notifications/dispatched.blade.php b/resources/views/order/notifications/dispatched.blade.php new file mode 100644 index 0000000..b89cf17 --- /dev/null +++ b/resources/views/order/notifications/dispatched.blade.php @@ -0,0 +1,3 @@ +

Hi,

+ +

Your order {{ $reference }} is on its way.

diff --git a/resources/views/order/notifications/pickup-ready.blade.php b/resources/views/order/notifications/pickup-ready.blade.php new file mode 100644 index 0000000..0fefc06 --- /dev/null +++ b/resources/views/order/notifications/pickup-ready.blade.php @@ -0,0 +1,3 @@ +

Hi,

+ +

Your order {{ $reference }} is ready for pickup in store.

diff --git a/resources/views/order/notifications/placed.blade.php b/resources/views/order/notifications/placed.blade.php new file mode 100644 index 0000000..0e1b7aa --- /dev/null +++ b/resources/views/order/notifications/placed.blade.php @@ -0,0 +1,11 @@ +

Hi,

+ +

Thanks for your order! Your order {{ $reference }} is confirmed.

+ +
    + @foreach ($lines as $line) +
  • {{ $line->quantity }} × {{ $line->description }} — {{ $line->total?->formatted }}
  • + @endforeach +
+ +

Total: {{ $total }}

diff --git a/resources/views/order/notifications/refunded.blade.php b/resources/views/order/notifications/refunded.blade.php new file mode 100644 index 0000000..59228a2 --- /dev/null +++ b/resources/views/order/notifications/refunded.blade.php @@ -0,0 +1,3 @@ +

Hi,

+ +

A refund of {{ $amount }} has been issued for your order {{ $reference }}.

diff --git a/resources/views/order/notifications/status-updated.blade.php b/resources/views/order/notifications/status-updated.blade.php new file mode 100644 index 0000000..fbcd470 --- /dev/null +++ b/resources/views/order/notifications/status-updated.blade.php @@ -0,0 +1,3 @@ +

Hi,

+ +

Your order {{ $reference }} is now: {{ $statusLabel }}

diff --git a/src/Auth/Exceptions/OtpThrottledException.php b/src/Auth/Exceptions/OtpThrottledException.php new file mode 100644 index 0000000..246b841 --- /dev/null +++ b/src/Auth/Exceptions/OtpThrottledException.php @@ -0,0 +1,20 @@ +getComponents()) ->reject(fn ($component) => method_exists($component, 'getName') && $component->getName() == 'password') ->values() ->all(); - return $form->schema($schema); + return $form->components($schema); } } diff --git a/src/Auth/Filament/Pages/Login.php b/src/Auth/Filament/Pages/Login.php index 883aa4b..d431ffd 100644 --- a/src/Auth/Filament/Pages/Login.php +++ b/src/Auth/Filament/Pages/Login.php @@ -15,7 +15,7 @@ class Login extends SimplePage { use WithRateLimiting; - protected static string $view = 'core::auth.filament.pages.login'; + protected string $view = 'core::auth.filament.pages.login'; public ?string $email = ''; public ?string $otp = ''; @@ -78,7 +78,7 @@ class Login extends SimplePage ]); } - if ($staff instanceof FilamentUser && !$staff->canAccessPanel(Filament::getCurrentPanel())) { + if ($staff instanceof FilamentUser && !$staff->canAccessPanel(Filament::getCurrentOrDefaultPanel())) { throw ValidationException::withMessages([ 'email' => 'You do not have access to this panel.', ]); diff --git a/src/Auth/Http/Middleware/EnsureSessionNotRevoked.php b/src/Auth/Http/Middleware/EnsureSessionNotRevoked.php new file mode 100644 index 0000000..824262b --- /dev/null +++ b/src/Auth/Http/Middleware/EnsureSessionNotRevoked.php @@ -0,0 +1,50 @@ +sessions->currentSession(); + + if ($session && $session->isRevoked()) { + Auth::logout(); + $request->session()->invalidate(); + $request->session()->regenerateToken(); + + abort(401, 'Your session has been revoked. Please log in again.'); + } + + $session?->update(['last_used_at' => now()]); + + return $next($request); + } +} diff --git a/src/Auth/Models/UserSession.php b/src/Auth/Models/UserSession.php new file mode 100644 index 0000000..219b7da --- /dev/null +++ b/src/Auth/Models/UserSession.php @@ -0,0 +1,33 @@ + 'datetime', + 'revoked_at' => 'datetime', + ]; + + public function user(): BelongsTo + { + $model = config('auth.providers.users.model'); + + return $this->belongsTo($model); + } + + public function isRevoked(): bool + { + return $this->revoked_at !== null; + } +} diff --git a/src/Auth/Services/UserOtpService.php b/src/Auth/Services/UserOtpService.php index aaa8b18..0b535b1 100644 --- a/src/Auth/Services/UserOtpService.php +++ b/src/Auth/Services/UserOtpService.php @@ -2,18 +2,76 @@ namespace Modules\Core\Auth\Services; +use Illuminate\Contracts\Auth\Authenticatable; +use Illuminate\Http\Request; +use Illuminate\Support\Facades\Auth; +use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\Event; use Illuminate\Support\Facades\Mail; +use Illuminate\Support\Facades\RateLimiter; use Modules\Core\Auth\Events\UserAuthenticated; +use Modules\Core\Auth\Exceptions\OtpThrottledException; use Modules\Core\Auth\Mail\UserOtpMail; +/** + * The storefront's passwordless login — a shopper supplies only an email + * (Shopify-style), gets a 6-digit code, and validate() authenticates the + * `web` guard via Auth::login(). + * + * That alone is enough to merge/associate any active guest cart into the + * now-known customer — Auth::login() fires Illuminate\Auth\Events\Login, + * which Lunar's own Lunar\Listeners\CartSessionAuthListener (registered + * unconditionally in LunarServiceProvider::boot(), no opt-in needed) + * already listens to, calling CartSession::associate() with + * config('lunar.cart.auth_policy') — 'merge' by default, 'override' if a + * consumer changes that config. Deliberately no cart-association call + * here: doing our own on top would run a SECOND merge attempt with a + * hardcoded policy that ignores whatever the consumer configured. + * + * generateAndSend()'s find-or-create already triggers the full + * Customer/User pairing cascade for a genuinely new email — see + * Modules\Core\Auth\Events\UserCreated's own docblock and + * Modules\Core\Customer\Listeners\CreateCustomerForUser. + * + * Two independent throttles, both configured under core.auth.otp — see + * config/core.php's own comment for why they're separate: max_attempts + * caps wrong guesses against ONE code; generation_limit caps how often a + * NEW code can be requested for the same email at all (closes both the + * "regenerate to reset my guess count" loophole and mail-bombing one + * inbox). + * + * validate() also records a UserSessionService entry for the new login — + * see that class's own docblock for the "logout everywhere" registry + * this feeds (Modules\Core\Auth\Http\Middleware\EnsureSessionNotRevoked + * is the enforcement half; a consuming app must add it to its own + * middleware stack). $request is optional purely so this service stays + * callable from a context with no HTTP request at all (a console + * command, a test) — user-agent/ip are simply not recorded when omitted. + */ class UserOtpService { private const EXPIRY_MINUTES = 10; private const CODE_LENGTH = 6; + public function __construct( + private readonly UserSessionService $sessions, + ) {} + + /** + * @throws OtpThrottledException if this email has requested too many + * codes within core.auth.otp.generation_decay_minutes + */ public function generateAndSend(string $email): bool { + $limiterKey = $this->generationLimiterKey($email); + $maxGenerations = (int) config('core.auth.otp.generation_limit', 3); + + if (RateLimiter::tooManyAttempts($limiterKey, $maxGenerations)) { + throw new OtpThrottledException(RateLimiter::availableIn($limiterKey)); + } + + RateLimiter::hit($limiterKey, (int) config('core.auth.otp.generation_decay_minutes', 10) * 60); + $model = config('auth.providers.users.model'); $user = $model::firstOrCreate(['email' => $email]); @@ -21,6 +79,7 @@ class UserOtpService $user->otp_code = $code; $user->otp_expires_at = now()->addMinutes(self::EXPIRY_MINUTES); + $user->otp_attempts = 0; $user->save(); Mail::to($user->email)->send(new UserOtpMail($user->name ?? $user->email, $code)); @@ -28,25 +87,70 @@ class UserOtpService return true; } - public function validate(string $email, string $code) + /** + * A wrong code counts against core.auth.otp.max_attempts and, once + * reached, invalidates the code entirely — the shopper must request + * a fresh one via generateAndSend() (itself throttled independently + * — see this class's own docblock) rather than being able to keep + * guessing against a still-live code for the rest of its 10-minute + * expiry window. + */ + public function validate(string $email, string $code, ?Request $request = null): ?Authenticatable { $model = config('auth.providers.users.model'); - $user = $model::where('email', $email)->first(); - if (! $user) { + // lockForUpdate() + a transaction make the read-check-increment-save + // below atomic across concurrent requests for the same user — without + // it, two guesses fired in parallel can each read the same + // pre-increment otp_attempts value and both save past + // max_attempts, letting an attacker exceed the lockout by + // parallelizing requests instead of sending them serially. + $result = DB::transaction(function () use ($model, $email, $code) { + $user = $model::where('email', $email)->lockForUpdate()->first(); + + if (! $user || ! $user->otp_expires_at || now()->isAfter($user->otp_expires_at)) { + return null; + } + + if (! hash_equals((string) $user->otp_code, $code)) { + $user->otp_attempts++; + + if ($user->otp_attempts >= (int) config('core.auth.otp.max_attempts', 5)) { + $user->otp_code = null; + $user->otp_expires_at = null; + $user->otp_attempts = 0; + } + + $user->save(); + + return null; + } + + $user->otp_code = null; + $user->otp_expires_at = null; + $user->otp_attempts = 0; + $user->save(); + + return $user; + }); + + if (! $result) { return null; } - if (! $user->otp_expires_at || $user->otp_code != $code || now()->isAfter($user->otp_expires_at)) { - return null; - } + RateLimiter::clear($this->generationLimiterKey($email)); - $user->otp_code = null; - $user->otp_expires_at = null; - $user->save(); + Auth::login($result); - Event::dispatch(new UserAuthenticated($user)); + $this->sessions->record($result, $request); - return $user; + Event::dispatch(new UserAuthenticated($result)); + + return $result; + } + + private function generationLimiterKey(string $email): string + { + return 'otp-generate:'.strtolower($email); } } diff --git a/src/Auth/Services/UserSessionService.php b/src/Auth/Services/UserSessionService.php new file mode 100644 index 0000000..d1f36b1 --- /dev/null +++ b/src/Auth/Services/UserSessionService.php @@ -0,0 +1,105 @@ + $user->getAuthIdentifier(), + 'token' => $token, + 'user_agent' => $request?->userAgent(), + 'ip_address' => $request?->ip(), + 'last_used_at' => now(), + ]); + + session([self::SESSION_TOKEN_KEY => $token]); + + return $session; + } + + /** + * Revokes every OTHER active session for $user — the current one + * (matched by the token in the CURRENT session payload) is left + * alone, matching Laravel's own logoutOtherDevices() semantics + * (there just isn't a password to re-verify against here — this is a + * passwordless account, so revocation is simply "every row that + * isn't the one making this request"). + * + * Known, deliberately accepted gap: this requires only a currently + * valid session, not a freshly-completed login — so anyone holding + * an already-authenticated session (e.g. someone who sits down at an + * account left logged in on a shared/public PC) can use this to + * evict the real owner's OTHER sessions just as easily as the real + * owner could use it to evict an intruder's. A stricter version would + * require a fresh OTP re-verification (e.g. within the last few + * minutes) before allowing this call. Left as-is for now — revisit if + * this turns out to matter in practice, rather than building + * abuse-resistance against a threat model nobody's confirmed is real + * for this storefront. + */ + public function revokeOtherSessions(Authenticatable $user): int + { + $currentToken = session(self::SESSION_TOKEN_KEY); + + return UserSession::query() + ->where('user_id', $user->getAuthIdentifier()) + ->whereNull('revoked_at') + ->when($currentToken, fn ($query) => $query->where('token', '!=', $currentToken)) + ->update(['revoked_at' => now()]); + } + + /** + * Revokes EVERY session for $user, current one included — for a + * "this account may be compromised" response, not a routine logout. + */ + public function revokeAllSessions(Authenticatable $user): int + { + return UserSession::query() + ->where('user_id', $user->getAuthIdentifier()) + ->whereNull('revoked_at') + ->update(['revoked_at' => now()]); + } + + /** + * @return UserSession|null null if the CURRENT session has no + * recorded token at all (e.g. a session predating this feature, or + * one Auth::login() established outside UserOtpService) — treated + * as valid by EnsureSessionNotRevoked rather than rejected, since + * there's nothing to have been revoked. + */ + public function currentSession(): ?UserSession + { + $token = session(self::SESSION_TOKEN_KEY); + + if (! $token) { + return null; + } + + return UserSession::where('token', $token)->first(); + } +} diff --git a/src/Cart/Commands/DetectAbandonedCarts.php b/src/Cart/Commands/DetectAbandonedCarts.php new file mode 100644 index 0000000..3169c86 --- /dev/null +++ b/src/Cart/Commands/DetectAbandonedCarts.php @@ -0,0 +1,89 @@ +recovery_consent = true — CartAbandoned/ + * CheckoutAbandoned exist specifically to drive future recovery-email + * sends (Checkout\Services\CheckoutService::setRecoveryConsent() is where + * that consent is actually recorded), and a non-consenting cart's + * abandonment must never be dispatched at all, not merely filtered later + * at send time — see docs referenced above for the legal reasoning. This + * consent filter stays here rather than on Modules\Core\Cart\Services\ + * CartLifecycleService, whose two "abandoned" queries this command builds + * on — dispatch eligibility is this command's own concern, not part of + * what "abandoned" means to a staff member browsing the admin panel. (The + * non-empty-lines requirement, by contrast, IS part of what "abandoned" + * means either way, so it lives on CartLifecycleService::abandonedCarts() + * itself, not here.) + */ +class DetectAbandonedCarts extends Command +{ + protected $signature = 'boboko:cart:detect-abandoned'; + + protected $description = 'Dispatch CartAbandoned/CheckoutAbandoned for carts that just crossed the abandonment threshold.'; + + public function handle(CartLifecycleService $lifecycle): void + { + $cartsAbandoned = 0; + $checkoutsAbandoned = 0; + + $lifecycle->abandonedCarts(Cart::query()) + ->where('meta->recovery_consent', true) + ->chunkById(200, function ($carts) use (&$cartsAbandoned) { + foreach ($carts as $cart) { + Event::dispatch(new CartAbandoned($cart)); + + $cartsAbandoned++; + } + }); + + $lifecycle->abandonedCheckouts(Cart::query()) + ->where('meta->recovery_consent', true) + ->with(['orders' => fn ($query) => $query->whereNull('placed_at')]) + ->chunkById(200, function ($carts) use (&$checkoutsAbandoned) { + foreach ($carts as $cart) { + $order = $cart->orders->first(); + + if ($order === null) { + continue; + } + + Event::dispatch(new CheckoutAbandoned($cart, $order)); + + $checkoutsAbandoned++; + } + }); + + $this->components->info("Dispatched CartAbandoned for {$cartsAbandoned} cart(s), CheckoutAbandoned for {$checkoutsAbandoned} checkout(s)."); + } +} diff --git a/src/Cart/Events/CartCleared.php b/src/Cart/Events/CartCleared.php new file mode 100644 index 0000000..388bba7 --- /dev/null +++ b/src/Cart/Events/CartCleared.php @@ -0,0 +1,18 @@ + $lines + * Snapshot of every line that was in the cart before clearing — Cart::clear() + * deletes all rows directly, so nothing here can be fresh CartLine instances. + */ + public function __construct( + public readonly Cart $cart, + public readonly array $lines, + ) {} +} diff --git a/src/Cart/Events/CartCouponApplied.php b/src/Cart/Events/CartCouponApplied.php new file mode 100644 index 0000000..3a77cd0 --- /dev/null +++ b/src/Cart/Events/CartCouponApplied.php @@ -0,0 +1,13 @@ +active()->where('updated_at', '<=', static::abandonedCutoff())->count(); + } + + public static function lifecycle(): CartLifecycleService + { + return app(CartLifecycleService::class); + } + + /** + * `Cart::scopeActive()` (not-yet-converted-to-an-order carts) mixes two very + * different things together: a cart someone is actively shopping in right now, + * and one that's genuinely been left behind. Lunar tracks no time-based + * staleness signal of its own — `Cart::updated_at` plus a configurable + * threshold (`config('core.cart.abandoned_after')`, default 1 hour) is what + * this resource uses to tell them apart. A cart with no recent activity is + * "Abandoned"; anything more recent is "Ongoing". + */ + public static function abandonedCutoff(): Carbon + { + return static::lifecycle()->abandonedCutoff(); + } + + public static function table(Table $table): Table + { + return $table + ->columns([ + TextColumn::make('id') + ->label('Cart') + ->sortable(), + TextColumn::make('customer.full_name') + ->label('Customer') + ->placeholder('—') + ->searchable() + ->url(fn (Cart $record) => $record->customer_id !== null + ? CustomerResource::getUrl('view', ['record' => $record->customer_id]) + : null), + TextColumn::make('user.email') + ->label('User') + ->placeholder('—') + ->searchable(), + TextColumn::make('lines_count') + ->label('Lines') + ->counts('lines') + ->sortable(), + TextColumn::make('lines_sum_quantity') + ->label('Items') + ->sum('lines', 'quantity') + ->sortable(), + TextColumn::make('currency.code') + ->label('Currency'), + TextColumn::make('updated_at') + ->label('Last activity') + ->dateTime() + ->sortable(), + ]) + ->recordActions([ + ViewAction::make(), + ]) + ->defaultSort('updated_at', 'desc'); + } + + public static function getPages(): array + { + return [ + 'index' => ListCarts::route('/'), + 'view' => ViewCart::route('/{record}'), + ]; + } + + public static function canCreate(): bool + { + return false; + } +} diff --git a/src/Cart/Filament/Resources/CartResource/Pages/ListCarts.php b/src/Cart/Filament/Resources/CartResource/Pages/ListCarts.php new file mode 100644 index 0000000..1d15f05 --- /dev/null +++ b/src/Cart/Filament/Resources/CartResource/Pages/ListCarts.php @@ -0,0 +1,51 @@ + Tab::make('Abandoned Cart') + ->modifyQueryUsing(fn (Builder $query) => $lifecycle->abandonedCarts($query)), + 'abandoned_checkout' => Tab::make('Abandoned Checkout') + ->modifyQueryUsing(fn (Builder $query) => $lifecycle->abandonedCheckouts($query)), + 'ongoing' => Tab::make('Ongoing') + ->modifyQueryUsing(fn (Builder $query) => $lifecycle->ongoing($query)), + 'completed' => Tab::make('Completed') + ->modifyQueryUsing(fn (Builder $query) => $lifecycle->completed($query)), + ]; + } +} diff --git a/src/Cart/Filament/Resources/CartResource/Pages/ViewCart.php b/src/Cart/Filament/Resources/CartResource/Pages/ViewCart.php new file mode 100644 index 0000000..f4a4bbb --- /dev/null +++ b/src/Cart/Filament/Resources/CartResource/Pages/ViewCart.php @@ -0,0 +1,207 @@ +label('View Customer') + ->icon('heroicon-o-user') + ->url(fn (Cart $record) => CustomerResource::getUrl('view', ['record' => $record->customer_id])) + ->visible(fn (Cart $record) => $record->customer_id !== null), + ]; + } + + /** + * Cart's computed properties (subTotal/total/etc.) are plain public properties + * populated as a side effect of the pipeline calculate() runs — never persisted, + * so they don't exist on a plain Eloquent-fetched record. Calculated once here + * (a single view page load), not per-row in the list table, since running the + * full pipeline for every row of a paginated table would be expensive for no + * real benefit — see docs/lunar.md's Cart gotchas. + * + * Eager-loads what the Lines section (below) reads off each line's + * purchasable — name, thumbnail, options — the same relations Lunar's + * own OrderItemsTable loads for an order's line items (`with(['purchasable'])`, + * see vendor/lunarphp/lunar/.../OrderItemsTable::getDefaultTable()) — so + * rendering the product grid doesn't N+1 per line. + */ + protected function resolveRecord(int|string $key): Cart + { + /** @var Cart $cart */ + $cart = parent::resolveRecord($key); + + $cart->load('lines.purchasable', 'shippingAddress.country'); + + EloquentCollection::make($cart->lines->pluck('purchasable')->filter(fn ($p) => $p instanceof ProductVariant)) + ->loadMissing(['product.thumbnail', 'images', 'values']); + + return $cart->calculate(); + } + + public function infolist(Schema $schema): Schema + { + return $schema + ->components([ + Section::make('Cart') + ->columns(3) + ->schema([ + TextEntry::make('id'), + TextEntry::make('customer.full_name') + ->label('Customer') + ->placeholder('—') + ->url(fn (Cart $record) => $record->customer_id !== null + ? CustomerResource::getUrl('view', ['record' => $record->customer_id]) + : null), + TextEntry::make('user.email') + ->label('User') + ->placeholder('—'), + TextEntry::make('currency.code') + ->label('Currency'), + TextEntry::make('completedOrderPlacedAt') + ->label('Ordered at') + ->state(fn (Cart $record) => $record->orders()->whereNotNull('placed_at')->value('placed_at')) + ->dateTime() + ->placeholder('Not ordered'), + TextEntry::make('updated_at') + ->label('Last activity') + ->dateTime(), + ]), + Section::make('Lines') + ->schema([ + RepeatableEntry::make('lines') + ->hiddenLabel() + ->schema([ + ImageEntry::make('image') + ->hiddenLabel() + ->state(fn (CartLine $record) => $record->purchasable instanceof ProductVariant + ? $record->purchasable->getThumbnail()?->getUrl('small') + : null) + ->defaultImageUrl(fn () => 'data:image/svg+xml;base64,'.base64_encode( + Blade::render('') + )) + ->imageSize(48), + TextEntry::make('description') + ->label('Product') + // ProductVariant::getDescription()/getOption() are typed + // string but internally read translateAttribute()/ + // translate(), which return null for a product/option + // with no attribute data set for the active locale — + // reading the underlying relations directly here avoids + // that TypeError rather than calling through them. + ->state(fn (CartLine $record) => $record->purchasable instanceof ProductVariant + ? ($record->purchasable->product?->translateAttribute('name') ?? '—') + : '—') + ->url(fn (CartLine $record) => $record->purchasable instanceof ProductVariant + ? EditProduct::getUrl(['record' => $record->purchasable->product_id]) + : null) + ->weight('bold'), + TextEntry::make('options') + ->label('Options') + ->state(fn (CartLine $record) => $record->purchasable instanceof ProductVariant + ? ($record->purchasable->values->map(fn ($value) => $value->translate('name'))->filter()->join(', ') ?: null) + : null) + ->placeholder('—') + ->badge(), + TextEntry::make('purchasable.sku') + ->label('SKU') + ->placeholder('—'), + TextEntry::make('quantity'), + TextEntry::make('unitPrice') + ->label('Unit price') + ->formatStateUsing(fn (CartLine $record) => $record->unitPrice?->formatted() ?? '—'), + TextEntry::make('total') + ->label('Line total') + ->formatStateUsing(fn (CartLine $record) => $record->total?->formatted() ?? '—'), + ]) + ->columns(4), + ]), + Section::make('Shipping') + ->columns(3) + ->schema([ + TextEntry::make('shippingAddress.shipping_option') + ->label('Shipping method') + // The raw identifier (e.g. "acs") is all a + // CartAddress row stores — the human-readable + // name only exists on the resolved + // Lunar\DataTypes\ShippingOption, which is what + // shippingBreakdown's items are keyed/named + // from below, so fall back to that name rather + // than showing the bare identifier. + ->formatStateUsing(fn (Cart $record, ?string $state) => $state + ? ($record->shippingBreakdown?->items->get($state)?->name ?? $state) + : null) + ->placeholder('Not selected'), + TextEntry::make('shippingAddress.country.name') + ->label('Shipping to') + ->placeholder('—'), + TextEntry::make('shippingTotal') + ->label('Shipping total') + ->formatStateUsing(fn (Cart $record) => $record->shippingTotal?->formatted() ?? '—') + ->weight('bold'), + RepeatableEntry::make('shippingBreakdownItems') + ->label('Breakdown') + ->columnSpanFull() + // shippingBreakdown->items is a plain (non-Eloquent) + // Collection of Lunar\Base\ValueObjects\Cart\ + // ShippingBreakdownItem — e.g. the carrier rate and, + // separately, Modules\Core\Payment\Pipelines\Cart\ + // ApplyPaymentMethodFee's own line item when the + // selected payment method carries a fee (see + // CHANGELOG 0.16.3) — both show up here individually + // rather than only as the summed shippingTotal above. + ->state(fn (Cart $record) => $record->shippingBreakdown?->items->values() ?? []) + ->schema([ + TextEntry::make('name') + ->hiddenLabel(), + TextEntry::make('price') + ->hiddenLabel() + ->formatStateUsing(fn ($state) => $state?->formatted() ?? '—') + ->alignEnd(), + ]) + ->columns(2) + ->visible(fn (Cart $record) => (bool) $record->shippingBreakdown?->items->isNotEmpty()), + ]) + ->visible(fn (Cart $record) => $record->shippingAddress !== null), + Section::make('Totals') + ->columns(3) + ->schema([ + TextEntry::make('subTotal') + ->label('Subtotal') + ->formatStateUsing(fn (Cart $record) => $record->subTotal?->formatted() ?? '—'), + TextEntry::make('discountTotal') + ->label('Discount') + ->formatStateUsing(fn (Cart $record) => $record->discountTotal?->formatted() ?? '—'), + TextEntry::make('taxTotal') + ->label('Tax') + ->formatStateUsing(fn (Cart $record) => $record->taxTotal?->formatted() ?? '—'), + TextEntry::make('total') + ->label('Total') + ->formatStateUsing(fn (Cart $record) => $record->total?->formatted() ?? '—') + ->weight('bold'), + ]), + ]); + } +} diff --git a/src/Cart/Pipelines/ZeroSavedForLaterPrice.php b/src/Cart/Pipelines/ZeroSavedForLaterPrice.php new file mode 100644 index 0000000..af5fcb3 --- /dev/null +++ b/src/Cart/Pipelines/ZeroSavedForLaterPrice.php @@ -0,0 +1,33 @@ +meta['saved_for_later'] ?? false) { + $currency = $cartLine->cart->currency; + + $cartLine->unitPrice = new Price(0, $currency, 1); + $cartLine->unitPriceInclTax = new Price(0, $currency, 1); + } + + return $next($cartLine); + } +} diff --git a/src/Cart/Services/CartLifecycleService.php b/src/Cart/Services/CartLifecycleService.php new file mode 100644 index 0000000..71f312b --- /dev/null +++ b/src/Cart/Services/CartLifecycleService.php @@ -0,0 +1,99 @@ +recovery_consent`) and non-empty-lines + * filtering stay in DetectAbandonedCarts, not here — those are specific to + * whether a recovery event should fire, not to what "abandoned" means. Staff + * browsing the admin panel should see every abandoned cart, consenting or + * not. + * + * `unrecoverableCutoff()` is a second, older threshold + * (`core.cart.unrecoverable_after`, default 90 days) applied as a lower + * bound on both abandoned*() methods below: a cart past it is too old to be + * a realistic recovery target (pricing/stock/tax have likely moved on), so + * it drops out of "Abandoned Cart"/"Abandoned Checkout" entirely rather than + * staying flagged as an actionable abandonment forever. It does not appear + * in `ongoing()`/`completed()` either — this is about the abandoned-cart + * pipeline specifically, not a retention/deletion policy (no rows are + * touched here). + */ +class CartLifecycleService +{ + public function abandonedCutoff(): Carbon + { + return now()->sub(config('core.cart.abandoned_after', '1 hour')); + } + + public function unrecoverableCutoff(): Carbon + { + return now()->sub(config('core.cart.unrecoverable_after', '90 days')); + } + + /** + * Not yet converted to an order (scopeActive()), with recent activity — + * someone plausibly shopping right now, not (yet) left behind. + */ + public function ongoing(Builder $query): Builder + { + return $query->active()->where('updated_at', '>', $this->abandonedCutoff()); + } + + /** + * No order started at all, stale, not yet past the unrecoverable cap, and + * actually has something in it — the weaker of the two abandoned states + * (see docs/cart.md's "Abandoned Cart vs Abandoned Checkout"). An empty + * cart (created but nothing ever added — e.g. a bot, or a session that + * never shopped) was never really "abandoned"; there's nothing to + * recover, so it's excluded rather than counted as a false positive. + */ + public function abandonedCarts(Builder $query): Builder + { + return $query->whereDoesntHave('orders') + ->whereHas('lines') + ->where('updated_at', '<=', $this->abandonedCutoff()) + ->where('updated_at', '>', $this->unrecoverableCutoff()); + } + + /** + * A draft order exists (checkout was started) but was never placed, + * stale, and not yet past the unrecoverable cap — the stronger of the + * two abandoned states. + */ + public function abandonedCheckouts(Builder $query): Builder + { + return $query->whereHas('orders', fn (Builder $query) => $query->whereNull('placed_at')) + ->where('updated_at', '<=', $this->abandonedCutoff()) + ->where('updated_at', '>', $this->unrecoverableCutoff()); + } + + /** + * Has an order that was actually placed, not just drafted. + */ + public function completed(Builder $query): Builder + { + return $query->whereHas('orders', fn (Builder $query) => $query->whereNotNull('placed_at')); + } +} diff --git a/src/Cart/Services/CartService.php b/src/Cart/Services/CartService.php new file mode 100644 index 0000000..7d8ddc6 --- /dev/null +++ b/src/Cart/Services/CartService.php @@ -0,0 +1,250 @@ +recalculate() — so a caller gets fresh totals in the same call, + * no second fetch needed. + */ +class CartService +{ + /** + * The current session's cart, or null if none exists yet. Does NOT + * auto-create one — see currentOrCreate() for that. + */ + public function current(): ?Cart + { + return CartSession::current(); + } + + /** + * The current session's cart, creating one if none exists yet — the right + * call for "add to cart" style flows where a cart must exist by the time + * the method returns. + */ + public function currentOrCreate(): Cart + { + return CartSession::manager(); + } + + public function addLine(Purchasable $purchasable, int $quantity = 1, array $meta = []): Cart + { + $cart = $this->currentOrCreate()->add($purchasable, $quantity, $meta); + + $line = app(config('lunar.cart.actions.get_existing_cart_line', GetExistingCartLine::class)) + ->execute($cart, $purchasable, $meta); + + if ($line !== null) { + Event::dispatch(new CartLineAdded($cart, $line)); + } + + return $cart; + } + + public function updateLine(int $cartLineId, int $quantity, ?array $meta = null): Cart + { + $before = CartLine::findOrFail($cartLineId); + $old = ['quantity' => $before->quantity, 'meta' => $before->meta->toArray()]; + + $cart = $this->currentOrCreate()->updateLine($cartLineId, $quantity, $meta); + + $line = $cart->lines->firstWhere('id', $cartLineId); + + if ($line !== null) { + Event::dispatch(new CartLineUpdated($cart, $line, $old)); + } + + return $cart; + } + + public function removeLine(int $cartLineId): Cart + { + $line = CartLine::findOrFail($cartLineId); + $snapshot = $this->snapshotLine($line); + + $cart = $this->currentOrCreate()->remove($cartLineId); + + Event::dispatch(new CartLineRemoved($cart, $snapshot)); + + return $cart; + } + + public function clear(): Cart + { + $cart = $this->currentOrCreate(); + $snapshots = $cart->lines->map($this->snapshotLine(...))->all(); + + $cart = $cart->clear(); + + Event::dispatch(new CartCleared($cart, $snapshots)); + + return $cart; + } + + /** + * Sets the cart's coupon code, which the ApplyDiscounts pipeline step picks + * up on the next calculate() — there's no dedicated Lunar action for this + * (unlike add/update/remove, coupon_code is a plain cast attribute), so + * this is the closest thing to one for a consuming app to call. + * + * Validated via Discounts::validateCoupon() (does a matching, currently + * active, non-exhausted Discount exist?) before it's set — CouponString's + * cast only normalizes casing, it doesn't validate anything, so setting + * coupon_code directly would silently accept a bogus code and just not + * discount anything once calculated. + * + * @throws InvalidCouponException if the code doesn't match a valid, active, + * non-exhausted Discount + */ + public function applyCoupon(string $code): Cart + { + if (! Discounts::validateCoupon($code)) { + throw new InvalidCouponException($code); + } + + $cart = $this->currentOrCreate(); + $cart->coupon_code = $code; + $cart->save(); + $cart = $cart->recalculate(); + + Event::dispatch(new CartCouponApplied($cart, $cart->coupon_code)); + + return $cart; + } + + public function removeCoupon(): Cart + { + $cart = $this->currentOrCreate(); + $code = $cart->coupon_code; + + if ($code === null) { + return $cart; + } + + $cart->coupon_code = null; + $cart->save(); + $cart = $cart->recalculate(); + + Event::dispatch(new CartCouponRemoved($cart, $code)); + + return $cart; + } + + /** + * Lines currently counted toward the cart's totals — everything except + * ones flagged meta.saved_for_later (see savedLines()). This is the set a + * cart page's main list / checkout would iterate, since a saved line + * isn't pending purchase. + * + * @return Collection + */ + public function activeLines(?Cart $cart = null): Collection + { + $cart ??= $this->currentOrCreate(); + + return $cart->lines->reject(fn (CartLine $line) => $line->meta['saved_for_later'] ?? false)->values(); + } + + /** + * Lines a shopper has deliberately parked rather than deleted — excluded + * from Cart totals (see Modules\Core\Cart\Pipelines\ZeroSavedForLaterPrice) + * and from activeLines(). A cart page's "Saved for later" section iterates + * this set. + * + * @return Collection + */ + public function savedLines(?Cart $cart = null): Collection + { + $cart ??= $this->currentOrCreate(); + + return $cart->lines->filter(fn (CartLine $line) => $line->meta['saved_for_later'] ?? false)->values(); + } + + /** + * Moves a line OUT of the purchasable cart without deleting it — it stays + * on the cart (still visible, still re-addable) but is excluded from + * totals via meta.saved_for_later, zeroed by ZeroSavedForLaterPrice before + * Lunar's own CalculateLines sums the cart (which has no meta-based + * exclusion of its own). + */ + public function saveForLater(int $cartLineId): Cart + { + $line = CartLine::findOrFail($cartLineId); + $meta = [...$line->meta->toArray(), 'saved_for_later' => true]; + + $cart = $this->currentOrCreate()->updateLine($cartLineId, $line->quantity, $meta); + + $line = $cart->lines->firstWhere('id', $cartLineId); + + if ($line !== null) { + Event::dispatch(new CartLineSaved($cart, $line)); + } + + return $cart; + } + + /** + * The reverse of saveForLater() — moves a line back into the purchasable + * cart, counted in totals again. + */ + public function moveToCart(int $cartLineId): Cart + { + $line = CartLine::findOrFail($cartLineId); + $meta = [...$line->meta->toArray(), 'saved_for_later' => false]; + + $cart = $this->currentOrCreate()->updateLine($cartLineId, $line->quantity, $meta); + + $line = $cart->lines->firstWhere('id', $cartLineId); + + if ($line !== null) { + Event::dispatch(new CartLineMovedToCart($cart, $line)); + } + + return $cart; + } + + /** + * @return array{id: int, purchasable_type: string, purchasable_id: int, quantity: int, meta: array} + */ + private function snapshotLine(CartLine $line): array + { + return [ + 'id' => $line->id, + 'purchasable_type' => $line->purchasable_type, + 'purchasable_id' => $line->purchasable_id, + 'quantity' => $line->quantity, + 'meta' => $line->meta->toArray(), + ]; + } +} diff --git a/src/Catalog/Contracts/ProductOptionTypeInterface.php b/src/Catalog/Contracts/ProductOptionTypeInterface.php new file mode 100644 index 0000000..09f6688 --- /dev/null +++ b/src/Catalog/Contracts/ProductOptionTypeInterface.php @@ -0,0 +1,34 @@ + + */ + public function getMetaForm(): array; +} diff --git a/src/Catalog/Contracts/RecommendationRule.php b/src/Catalog/Contracts/RecommendationRule.php new file mode 100644 index 0000000..c512531 --- /dev/null +++ b/src/Catalog/Contracts/RecommendationRule.php @@ -0,0 +1,39 @@ + $exclude + * @return Collection at most $limit products + */ + public function recommend(Product $product, int $limit, array $exclude): Collection; +} diff --git a/src/Catalog/DTOs/CollectionFilters.php b/src/Catalog/DTOs/CollectionFilters.php new file mode 100644 index 0000000..3d1044e --- /dev/null +++ b/src/Catalog/DTOs/CollectionFilters.php @@ -0,0 +1,24 @@ + $availableTags every distinct tag value + * present on at least one product matching the listing's OTHER + * filters (collection/price/stock — never the tag filter itself, so + * selecting a tag doesn't collapse the list down to just that tag). + * Sorted alphabetically. Empty if no product in scope has any tag. + */ + public function __construct( + public readonly LengthAwarePaginator $products, + public readonly PriceSliderBounds $priceBounds, + public readonly array $availableTags = [], + ) {} +} diff --git a/src/Catalog/Enums/CollectionSort.php b/src/Catalog/Enums/CollectionSort.php new file mode 100644 index 0000000..a4887d0 --- /dev/null +++ b/src/Catalog/Enums/CollectionSort.php @@ -0,0 +1,24 @@ + '_lft:asc', + self::Name => 'name:asc', + self::Newest => 'created_at:desc', + }; + } +} diff --git a/src/Catalog/Enums/ProductSort.php b/src/Catalog/Enums/ProductSort.php new file mode 100644 index 0000000..71cc99c --- /dev/null +++ b/src/Catalog/Enums/ProductSort.php @@ -0,0 +1,26 @@ + 'price:asc', + self::PriceDesc => 'price:desc', + self::Newest => 'created_at:desc', + }; + } +} diff --git a/src/Catalog/Events/ProductDeleted.php b/src/Catalog/Events/ProductDeleted.php new file mode 100644 index 0000000..136fcb4 --- /dev/null +++ b/src/Catalog/Events/ProductDeleted.php @@ -0,0 +1,23 @@ +all()) + ->keys() + ->mapWithKeys(fn (string $key) => [$key => Str::headline($key)]) + ->all(); + + if ($options === []) { + return $schema; + } + + return $schema->components([ + ...$schema->getComponents(), + Select::make('meta.option_type') + ->label('Option Type') + ->options($options) + ->helperText('Controls which meta fields appear when editing this option\'s values.') + ->native(false), + ]); + } +} diff --git a/src/Catalog/Filament/Extensions/ValuesRelationManagerExtension.php b/src/Catalog/Filament/Extensions/ValuesRelationManagerExtension.php new file mode 100644 index 0000000..827fa9c --- /dev/null +++ b/src/Catalog/Filament/Extensions/ValuesRelationManagerExtension.php @@ -0,0 +1,34 @@ +caller->getOwnerRecord(); + + $type = ProductOptionTypeManager::get()->resolve($option->meta['option_type'] ?? null); + + if ($type === null) { + return $schema; + } + + return $schema->components([ + ...$schema->getComponents(), + ...$type->getMetaForm(), + ]); + } +} diff --git a/src/Catalog/Listeners/ReindexProductsRecommendingProduct.php b/src/Catalog/Listeners/ReindexProductsRecommendingProduct.php new file mode 100644 index 0000000..957cf2d --- /dev/null +++ b/src/Catalog/Listeners/ReindexProductsRecommendingProduct.php @@ -0,0 +1,64 @@ +searchable() dispatches Scout's own (queued, if + * SCOUT_QUEUE is configured) reindex job per matched product — this + * listener itself does no synchronous Meilisearch writing. + */ +class ReindexProductsRecommendingProduct +{ + public function handleSaved(ProductSaved $event): void + { + $this->reindexReferencingProducts($event->product->id); + } + + public function handleDeleted(ProductDeleted $event): void + { + $this->reindexReferencingProducts($event->productId); + } + + private function reindexReferencingProducts(int $productId): void + { + $hits = Product::search('') + ->options([ + 'filter' => "recommendations.id = \"{$productId}\"", + 'attributesToRetrieve' => ['id'], + // Meilisearch's own hitsPerPage default (20) would silently + // drop referencing products past that count — this is a + // reverse lookup, not a paginated storefront result, so it + // needs every match, up to Meilisearch's hard limit. + 'hitsPerPage' => 1000, + ]) + ->raw()['hits'] ?? []; + + $ids = collect($hits)->pluck('id')->unique()->values(); + + if ($ids->isEmpty()) { + return; + } + + Product::whereIn('id', $ids)->get()->each->searchable(); + } +} diff --git a/src/Catalog/Observers/ProductOptionReindexObserver.php b/src/Catalog/Observers/ProductOptionReindexObserver.php new file mode 100644 index 0000000..5b47c45 --- /dev/null +++ b/src/Catalog/Observers/ProductOptionReindexObserver.php @@ -0,0 +1,68 @@ +reindexProductsForOption($option->id); + } + + public function optionDeleted(ProductOption $option): void + { + $this->reindexProductsForOption($option->id); + } + + public function valueSaved(ProductOptionValue $value): void + { + $this->reindexProductsForValues([$value->id]); + } + + public function valueDeleted(ProductOptionValue $value): void + { + $this->reindexProductsForValues([$value->id]); + } + + private function reindexProductsForOption(int $optionId): void + { + $valueIds = ProductOptionValue::where('product_option_id', $optionId)->pluck('id'); + + $this->reindexProductsForValues($valueIds->all()); + } + + private function reindexProductsForValues(array $valueIds): void + { + if ($valueIds === []) { + return; + } + + $prefix = config('lunar.database.table_prefix'); + + $variantIds = DB::table("{$prefix}product_option_value_product_variant") + ->whereIn('value_id', $valueIds) + ->pluck('variant_id'); + + if ($variantIds->isEmpty()) { + return; + } + + $productIds = ProductVariant::whereIn('id', $variantIds)->pluck('product_id')->unique(); + + Product::whereIn('id', $productIds)->get()->each->searchable(); + } +} diff --git a/src/Catalog/OptionTypes/ColorOptionType.php b/src/Catalog/OptionTypes/ColorOptionType.php new file mode 100644 index 0000000..10600b2 --- /dev/null +++ b/src/Catalog/OptionTypes/ColorOptionType.php @@ -0,0 +1,29 @@ +label('Color') + ->required(), + ]; + } +} diff --git a/src/Catalog/ProductFilters.php b/src/Catalog/ProductFilters.php deleted file mode 100644 index 5701d01..0000000 --- a/src/Catalog/ProductFilters.php +++ /dev/null @@ -1,20 +0,0 @@ -get() model hydration anywhere in this service. Callers get plain arrays of the - * indexed document, not Eloquent models. - * - * Full-text query search lives separately in Modules\Core\Search\ProductSearchService; - * this service is for browsing/filtering without a search term. - */ -class ProductService -{ - /** - * @return array{data: array, meta: array} - */ - public function list(?ProductFilters $filters = null, int $perPage = 24, int $page = 1): array - { - $paginator = Product::search('') - ->options([ - 'filter' => $this->buildFilter($filters), - ]) - ->paginateRaw(perPage: $perPage, page: $page); - - return [ - 'data' => collect($this->hitsFrom($paginator)) - ->map(fn (array $product) => $this->withLocalizedFields($product)) - ->all(), - 'meta' => [ - 'total' => $paginator->total(), - 'per_page' => $paginator->perPage(), - 'current_page' => $paginator->currentPage(), - 'last_page' => $paginator->lastPage(), - ], - ]; - } - - /** - * Look up a single product by its URL slug (any locale - slugs are indexed across - * all languages, see Modules\Core\Search\ProductIndexer). Returns the full indexed - * product document, or null if no product has that slug. - */ - public function getBySlug(string $slug): ?array - { - return $this->findOneWhere('slugs = "'.addcslashes($slug, '"\\').'"'); - } - - /** - * Look up a single product by its primary key. Returns the full indexed product - * document, or null if no product has that id. - */ - public function getById(int $id): ?array - { - return $this->findOneWhere("id = \"{$id}\""); - } - - private function findOneWhere(string $filter): ?array - { - $paginator = Product::search('') - ->options(['filter' => $filter]) - ->paginateRaw(perPage: 1, page: 1); - - $product = $this->hitsFrom($paginator)[0] ?? null; - - return $product !== null ? $this->withLocalizedFields($product) : null; - } - - /** - * Resolves the current-locale `name`/`description` from the indexer's - * per-locale `name_{locale}`/`description_{locale}` fields, falling back to - * the store's default language (Language::default, see - * LocaleMiddleware::defaultLocale()) when the current locale has no - * translation - e.g. a product with no English copy yet still shows its - * Greek name/description on /en/ rather than rendering blank. - * - * Deliberately not config('app.locale') - App::setLocale() overwrites that - * config value on every request, so by request time it's just whatever the - * current locale already is, not a stable fallback. - */ - private function withLocalizedFields(array $product): array - { - $locale = App::getLocale(); - $fallbackLocale = LocaleMiddleware::defaultLocale(); - - $product['name'] = $product['name_'.$locale] ?? $product['name_'.$fallbackLocale] ?? null; - $product['description'] = $product['description_'.$locale] ?? $product['description_'.$fallbackLocale] ?? null; - - return $product; - } - - /** - * For the Meilisearch driver, Scout's paginateRaw() puts the whole raw response - * (hits, query, processingTimeMs, ...) in items(), not a plain list of hits - the - * actual documents are under the 'hits' key. - */ - private function hitsFrom(LengthAwarePaginator $paginator): array - { - $rawResponse = $paginator->items(); - - return collect($rawResponse['hits'] ?? [])->values()->all(); - } - - private function buildFilter(?ProductFilters $filters): ?string - { - if ($filters === null) { - return null; - } - - $clauses = Collection::make([ - $filters->collectionId !== null ? "collections = \"{$filters->collectionId}\"" : null, - $filters->brand !== null ? 'brand = "'.addcslashes($filters->brand, '"\\').'"' : null, - $filters->minPrice !== null ? "price >= {$filters->minPrice}" : null, - $filters->maxPrice !== null ? "price <= {$filters->maxPrice}" : null, - ])->filter(); - - return $clauses->isEmpty() ? null : $clauses->join(' AND '); - } -} diff --git a/src/Catalog/Recommendations/RandomRule.php b/src/Catalog/Recommendations/RandomRule.php new file mode 100644 index 0000000..c55621f --- /dev/null +++ b/src/Catalog/Recommendations/RandomRule.php @@ -0,0 +1,27 @@ +whereKeyNot($exclude) + ->inRandomOrder() + ->limit($limit) + ->get(); + } +} diff --git a/src/Catalog/Recommendations/SameCategoryRule.php b/src/Catalog/Recommendations/SameCategoryRule.php new file mode 100644 index 0000000..b07c09e --- /dev/null +++ b/src/Catalog/Recommendations/SameCategoryRule.php @@ -0,0 +1,39 @@ +collections->first(); + + if ($collection === null) { + return collect(); + } + + return $collection->products() + ->whereKeyNot($exclude) + ->inRandomOrder() + ->limit($limit) + ->get(); + } +} diff --git a/src/Catalog/Services/CollectionIndexer.php b/src/Catalog/Services/CollectionIndexer.php new file mode 100644 index 0000000..29eb4ef --- /dev/null +++ b/src/Catalog/Services/CollectionIndexer.php @@ -0,0 +1,91 @@ +with(['urls', 'media', 'ancestors']); + } + + public function toSearchableArray(Model $model): array + { + /** @var Collection $model */ + $data = parent::toSearchableArray($model); + + $data['parent_id'] = $model->parent_id; + $data['_lft'] = $model->_lft; + $data['_rgt'] = $model->_rgt; + $data['collection_group_id'] = $model->collection_group_id; + $data['slugs'] = $model->urls->pluck('slug')->unique()->values()->all(); + $data['thumbnail'] = $model->getThumbnailImage() ?: null; + $data['ancestors'] = $model->ancestors + ->sortBy('_lft') + ->map(fn ($ancestor) => [ + 'id' => $ancestor->id, + 'name' => $ancestor->translateAttribute('name'), + ]) + ->values() + ->all(); + $data['product_count'] = Product::search('') + ->options(['filter' => "collection_ids = \"{$model->id}\""]) + ->paginateRaw(perPage: 1, page: 1) + ->total(); + + return $data; + } +} diff --git a/src/Catalog/Services/CollectionService.php b/src/Catalog/Services/CollectionService.php new file mode 100644 index 0000000..001c239 --- /dev/null +++ b/src/Catalog/Services/CollectionService.php @@ -0,0 +1,147 @@ + $this->buildFilter($filters)]; + + if ($sort !== null) { + $options['sort'] = [$sort->toMeilisearchSort()]; + } + + $paginator = CollectionModel::search('') + ->options($options) + ->paginateRaw(perPage: $perPage, page: $page); + + $data = collect($this->hitsFrom($paginator)) + ->map(fn (array $collection) => $this->withLocalizedFields($collection)) + ->all(); + + return new LengthAwarePaginator( + items: $data, + total: $paginator->total(), + perPage: $paginator->perPage(), + currentPage: $paginator->currentPage(), + options: ['path' => LengthAwarePaginator::resolveCurrentPath()], + ); + } + + /** + * Look up a single collection by its URL slug (any locale). Returns the full + * indexed collection document, or null if no collection has that slug. + */ + public function getBySlug(string $slug): ?array + { + return $this->findOneWhere('slugs = "'.addcslashes($slug, '"\\').'"'); + } + + /** + * Look up a single collection by its primary key. Returns the full indexed + * collection document, or null if no collection has that id. + */ + public function getById(int $id): ?array + { + return $this->findOneWhere("id = \"{$id}\""); + } + + private function findOneWhere(string $filter): ?array + { + $paginator = CollectionModel::search('') + ->options(['filter' => $filter]) + ->paginateRaw(perPage: 1, page: 1); + + $collection = $this->hitsFrom($paginator)[0] ?? null; + + return $collection !== null ? $this->withLocalizedFields($collection) : null; + } + + /** + * Resolves every translated Collection attribute's current-locale value — same + * logic as ProductService::withLocalizedFields(), see there for the full + * reasoning (AttributeManifest-driven, store-default-locale fallback, raw + * per-locale keys stripped after resolving). + */ + private function withLocalizedFields(array $collection): array + { + $locale = App::getLocale(); + $fallbackLocale = $this->languages->defaultLocale(); + $availableLocales = $this->languages->availableLocales(); + + foreach ($this->translatedAttributeHandles() as $handle) { + $collection[$handle] = $collection[$handle.'_'.$locale] ?? $collection[$handle.'_'.$fallbackLocale] ?? null; + + foreach ($availableLocales as $availableLocale) { + unset($collection[$handle.'_'.$availableLocale]); + } + } + + return $collection; + } + + /** + * @return array + */ + private function translatedAttributeHandles(): array + { + return $this->attributes->getSearchableAttributes((new CollectionModel)->getMorphClass()) + ->filter(fn ($attribute) => $attribute->type === TranslatedText::class) + ->pluck('handle') + ->all(); + } + + /** + * For the Meilisearch driver, Scout's paginateRaw() puts the whole raw response + * in items(), not a plain list of hits — see ProductService's identical note. + */ + private function hitsFrom(LengthAwarePaginatorContract $paginator): array + { + $rawResponse = $paginator->items(); + + return collect($rawResponse['hits'] ?? [])->values()->all(); + } + + private function buildFilter(?CollectionFilters $filters): ?string + { + if ($filters === null) { + return null; + } + + $clauses = Collection::make([ + $filters->parentId !== null ? "parent_id = \"{$filters->parentId}\"" + : ($filters->rootOnly ? 'parent_id IS NULL' : null), + $filters->groupId !== null ? "collection_group_id = \"{$filters->groupId}\"" : null, + ])->filter(); + + return $clauses->isEmpty() ? null : $clauses->join(' AND '); + } +} diff --git a/src/Catalog/Services/ProductIndexer.php b/src/Catalog/Services/ProductIndexer.php new file mode 100644 index 0000000..0ed4516 --- /dev/null +++ b/src/Catalog/Services/ProductIndexer.php @@ -0,0 +1,274 @@ +with([ + 'collections', + 'collections.ancestors', + 'media', + 'tags', + 'urls', + 'variants.images', + 'variants.prices', + 'variants.values.option', + ]); + } + + public function toSearchableArray(Model $model): array + { + /** @var Product $model */ + $data = parent::toSearchableArray($model); + + $currency = Currency::getDefault(); + $reviews = ProductReview::where('product_id', $model->id)->with('media')->get(); + + $data['collections'] = $model->collections->map(fn ($collection) => [ + 'id' => $collection->id, + 'name' => $collection->translateAttribute('name'), + ])->all(); + $data['collection_ids'] = $model->collections + ->flatMap(fn ($collection) => [$collection->id, ...$collection->ancestors->pluck('id')]) + ->unique() + ->values() + ->all(); + $data['slugs'] = $model->urls->pluck('slug')->unique()->values()->all(); + $data['skus'] = $model->variants->pluck('sku')->filter()->unique()->values()->all(); + $data['tags'] = $model->tags->pluck('value')->all(); + $data['media'] = $model->media->map(fn (Media $media) => $this->mapMedia($media))->all(); + $data['variants'] = $model->variants->map(fn (ProductVariant $variant) => $this->mapVariant($variant, $currency))->all(); + $data['price'] = $this->cheapestPrice($model, $currency); + $data['reviews'] = [ + 'items' => $reviews->map(fn (ProductReview $review) => $this->mapReview($review))->all(), + 'count' => $reviews->count(), + 'average_rating' => $reviews->isEmpty() ? null : round($reviews->avg('rating'), 1), + ]; + $data['channel_ids'] = $model->channels() + ->wherePivot('enabled', true) + ->pluck('lunar_channels.id') + ->toArray(); + $data['in_stock'] = $model->variants->contains( + fn (ProductVariant $variant) => $variant->canBeFulfilledAtQuantity(1) + ); + $data['recommendations'] = app(RecommendationService::class) + ->recommend($model) + ->load(['media', 'variants.prices']) + ->map(fn (Product $recommendation) => [ + 'id' => $recommendation->id, + 'name' => $recommendation->translateAttribute('name'), + 'price' => $this->cheapestPrice($recommendation, $currency), + 'image' => $recommendation->media->first() ? $this->mapMedia($recommendation->media->first())['thumb'] : null, + ]) + ->all(); + + return $data; + } + + private function mapVariant(ProductVariant $variant, Currency $currency): array + { + return [ + 'id' => $variant->id, + 'sku' => $variant->sku, + 'gtin' => $variant->gtin, + 'mpn' => $variant->mpn, + 'ean' => $variant->ean, + 'stock' => $variant->stock, + 'backorder' => $variant->backorder, + 'unit_quantity' => $variant->unit_quantity, + 'purchasable' => $variant->purchasable, + 'shippable' => $variant->shippable, + 'tax_ref' => $variant->tax_ref, + 'dimensions' => [ + 'length' => ['value' => $variant->length_value, 'unit' => $variant->length_unit], + 'width' => ['value' => $variant->width_value, 'unit' => $variant->width_unit], + 'height' => ['value' => $variant->height_value, 'unit' => $variant->height_unit], + 'weight' => ['value' => $variant->weight_value, 'unit' => $variant->weight_unit], + 'volume' => ['value' => $variant->volume_value, 'unit' => $variant->volume_unit], + ], + 'options' => $variant->values->map(fn ($value) => [ + 'option' => $this->translatedName($value->option->name), + 'handle' => $value->option->handle, + 'value' => $this->translatedName($value->name), + 'meta' => $value->meta, + ])->all(), + 'prices' => $variant->prices->map(fn (Price $price) => [ + 'currency_id' => $price->currency_id, + 'customer_group_id' => $price->customer_group_id, + 'price' => $price->price->decimal(), + 'compare_price' => $price->compare_price?->decimal(), + 'min_quantity' => $price->min_quantity, + ])->all(), + 'media' => $variant->images->map(fn (Media $media) => $this->mapMedia($media))->all(), + ]; + } + + /** + * Public-safe fields only — reviewer_email is PII with no storefront use and is + * deliberately excluded, unlike every other column on the review. reply/replied_at + * (the staff response) are included since they're meant to be shown alongside the + * review on the storefront. + */ + private function mapReview(ProductReview $review): array + { + return [ + 'id' => $review->id, + 'title' => $review->title, + 'body' => $review->body, + 'rating' => $review->rating, + 'reviewed_at' => $review->reviewed_at?->timestamp, + 'reviewer_name' => $review->reviewer_name, + 'reply' => $review->reply, + 'replied_at' => $review->replied_at?->timestamp, + 'location' => $review->location, + 'media' => $review->media->map(fn (Media $media) => $this->mapMedia($media))->all(), + ]; + } + + /** + * ProductOption/ProductOptionValue's `name` is a plain locale-keyed array cast + * (AsArrayObject) directly on the column — unlike Product/Collection/Brand, it is + * not stored in attribute_data. Lunar's translateAttribute() only reads + * attribute_data, so it silently returns null for these two models; this reads + * the array directly instead. Falls back to the first available locale if the + * current one is missing. Not a general replacement for translateAttribute() — + * every other translated field in this indexer (product/collection name and + * description) genuinely is attribute_data-backed and translateAttribute() is + * correct for those. + */ + private function translatedName(mixed $name): ?string + { + $names = is_array($name) ? $name : (array) $name; + + return $names[app()->getLocale()] ?? reset($names) ?: null; + } + + private function mapMedia(Media $media): array + { + return [ + 'id' => $media->id, + 'url' => $media->getUrl(), + 'thumb' => $media->getUrl('small'), + ]; + } + + /** + * The cheapest variant's base price (no customer group) in the default currency, + * as a float in major units — e.g. 19.99, not 1999. Null if the product has no + * variant with a price in that currency yet, so it's excluded from price filters + * rather than sorting to the bottom as if it were free. + */ + private function cheapestPrice(Product $model, Currency $currency): ?float + { + $price = $model->variants + ->flatMap(fn ($variant) => $variant->prices) + ->filter(fn ($price) => $price->currency_id === $currency->id && $price->customer_group_id === null) + ->min(fn ($price) => $price->price->value); + + return $price !== null ? $price / (10 ** $currency->decimal_places) : null; + } +} diff --git a/src/Catalog/Services/ProductOptionTypeManager.php b/src/Catalog/Services/ProductOptionTypeManager.php new file mode 100644 index 0000000..2b45683 --- /dev/null +++ b/src/Catalog/Services/ProductOptionTypeManager.php @@ -0,0 +1,68 @@ +register([...])` from its + * own service provider `boot()`, rather than listing classes in a published config + * file. + */ +class ProductOptionTypeManager +{ + private static ?self $instance = null; + + /** @var array> */ + private array $types = []; + + private function __construct() {} + + public static function get(): static + { + if (static::$instance === null) { + static::$instance = new static(); + } + + return static::$instance; + } + + /** + * @param array> $types + */ + public function register(array $types): void + { + foreach ($types as $class) { + $this->types[$class::getKey()] = $class; + } + } + + public function unregister(string $key): void + { + unset($this->types[$key]); + } + + public function resolve(?string $key): ?ProductOptionTypeInterface + { + if ($key === null || ! isset($this->types[$key])) { + return null; + } + + return app($this->types[$key]); + } + + /** + * @return array> + */ + public function all(): array + { + return $this->types; + } +} diff --git a/src/Catalog/Services/ProductSearchService.php b/src/Catalog/Services/ProductSearchService.php new file mode 100644 index 0000000..b4790b6 --- /dev/null +++ b/src/Catalog/Services/ProductSearchService.php @@ -0,0 +1,124 @@ + $this->searchableFields(), + 'filter' => $this->filterBuilder->build($filters), + ]; + + if ($sort !== null) { + $options['sort'] = [$sort->toMeilisearchSort()]; + } + + $paginator = Product::search($query) + ->options($options) + ->paginateRaw(perPage: $perPage, page: $page); + + $data = collect($this->localizer->hitsFrom($paginator)) + ->map(fn (array $product) => $this->localizer->withLocalizedFields($product)) + ->all(); + + $products = new LengthAwarePaginator( + items: $data, + total: $paginator->total(), + perPage: $paginator->perPage(), + currentPage: $paginator->currentPage(), + options: ['path' => LengthAwarePaginator::resolveCurrentPath()], + ); + + $priceBounds = $this->products->priceSliderBounds($filters, $filters?->minPrice, $filters?->maxPrice, $query); + $availableTags = $this->products->availableTags($filters, $query); + + return new ProductListingResult($products, $priceBounds, $availableTags); + } + + /** + * Targets every configured store language's fields, not just the current + * request locale plus the store default — a shopper browsing in Greek + * typing an English word (or vice versa) should still match a product + * whose only translation for that text happens to be in a third + * language. There's no per-request "current locale" concept in this + * method any more: which fields exist to search on is a property of the + * store's configured languages, not of who's asking. + * + * Also targets variants.options.value directly — a variant's option + * value (e.g. "Κάπτεν Γαμέρικα" on a "Name" option) is how ProductIndexer + * already indexes it (see mapVariant()), but it isn't one of Lunar's own + * attributes, so it can't come from AttributeManifest the way name/ + * description do; it's a structural field of the document, added here + * directly instead. Not locale-suffixed like the attribute-manifest + * fields — option values are stored as one already-resolved string per + * variant (see ProductIndexer::translatedName()), not per-locale. + * + * @return array + */ + private function searchableFields(): array + { + $handles = AttributeManifest::getSearchableAttributes(Product::morphName()) + ->pluck('handle'); + + $locales = Language::all()->pluck('code'); + + $attributeFields = $handles + ->crossJoin($locales) + ->map(fn (array $pair) => "{$pair[0]}_{$pair[1]}"); + + return $attributeFields + ->push('variants.options.value') + ->values() + ->all(); + } +} diff --git a/src/Catalog/Services/ProductService.php b/src/Catalog/Services/ProductService.php new file mode 100644 index 0000000..c3ba915 --- /dev/null +++ b/src/Catalog/Services/ProductService.php @@ -0,0 +1,297 @@ +get() model hydration anywhere in this service. Callers get plain arrays + * of the indexed document, not Eloquent models. + * + * Full-text query search lives separately in Modules\Core\Catalog\Services\ + * ProductSearchService; this service is for browsing/filtering without a search term. + */ +class ProductService +{ + public function __construct( + private readonly ProductDocumentLocalizer $localizer, + private readonly ProductFilterBuilder $filterBuilder, + ) {} + + /** + * One call for everything a listing page needs: the product page AND + * the price slider's bounds — a controller used to have to call this + * plus priceSliderBounds() separately and glue the results together + * itself; that orchestration now happens in here instead. Still issues + * two Meilisearch requests under the hood (the product search, and a + * separate price-facet-stats query — see priceSliderBounds()'s + * docblock for why they can't be merged into one without changing the + * slider's own UX), but the caller only ever makes one call. + * + * $filters->minPrice/$filters->maxPrice double as both the applied + * product filter AND the "is the slider actually narrowed" comparison + * in priceSliderBounds() — the same values, used two ways, so nothing + * new needs to be threaded through separately. + * + * The paginator itself is a real LengthAwarePaginator (not Scout's own + * paginateRaw() result - see "Meilisearch driver quirk" below) so a + * controller/view gets normal pagination behaviour ($products->links(), + * JSON serialization, etc.) without ever touching the raw Meilisearch + * response directly. + */ + public function list(?ProductFilters $filters = null, int $perPage = 24, int $page = 1, ?ProductSort $sort = null): ProductListingResult + { + $options = ['filter' => $this->filterBuilder->build($filters)]; + + if ($sort !== null) { + $options['sort'] = [$sort->toMeilisearchSort()]; + } + + $paginator = Product::search('') + ->options($options) + ->paginateRaw(perPage: $perPage, page: $page); + + $data = collect($this->localizer->hitsFrom($paginator)) + ->map(fn (array $product) => $this->localizer->withLocalizedFields($product)) + ->all(); + + $products = new LengthAwarePaginator( + items: $data, + total: $paginator->total(), + perPage: $paginator->perPage(), + currentPage: $paginator->currentPage(), + options: ['path' => LengthAwarePaginator::resolveCurrentPath()], + ); + + $priceBounds = $this->priceSliderBounds($filters, $filters?->minPrice, $filters?->maxPrice); + $availableTags = $this->availableTags($filters); + + return new ProductListingResult($products, $priceBounds, $availableTags); + } + + /** + * Every distinct `tags` value present on a product matching $filters, + * excluding $filters->tag itself — same "scoped but not self-collapsing" + * reasoning as priceRange() excluding `price` — so selecting a tag + * doesn't shrink the sidebar down to just that one tag. Sorted + * alphabetically; Meilisearch's facetDistribution has no defined order + * of its own. + * + * $query defaults to '' (every product, same as list()'s own default + * text query) — same reasoning as priceRange()'s own $query: pass the + * shopper's search text here too so a search page's own tag sidebar + * reflects only the products search actually matched. Public (not + * private, unlike the rest of this listing-only orchestration) so + * ProductSearchService::search() can reuse it directly rather than + * reimplementing the same facet call a second time. + * + * @return array + */ + public function availableTags(?ProductFilters $filters, string $query = ''): array + { + $filter = $this->filterBuilder->build($filters, exclude: ['tag']); + $tags = $this->rawFacets('tags', $filter, $query)['facetDistribution']['tags'] ?? []; + + return collect($tags)->keys()->sort()->values()->all(); + } + + /** + * Facet value counts for the given filter/field, scoped to the SAME filters + * `list()` would apply. Note this does NOT exclude `$field` itself from + * `$filters` — e.g. `facets('brand', new ProductFilters(brand: 'Acme'))` would + * scope the counts to only "Acme" already, collapsing every other brand's count + * to whatever remains under that filter. For a standard "faceted sidebar" (every + * brand's count reflecting collection/price/stock filters but NOT the brand + * filter itself), build a `$filters` that omits the field being faceted on and + * apply that field's own filter separately in the UI/query layer. + * + * `$field` must be one of ProductIndexer's filterable fields; only discrete-value + * fields make sense here (`brand`, `tags`, `in_stock`) — a numeric field like + * `price` would return one "facet" per exact price, not a usable range bucket. + * Use `priceRange()` for `price` instead. `facets('tags', $filters)` is how a + * category page gets "which tags actually appear on products in this category" — + * pass a $filters that omits `tag` (see `build()`'s $exclude) so the tag list + * itself doesn't collapse to whichever tag is already selected. + * + * @return array facet value => matching product count + */ + public function facets(string $field, ?ProductFilters $filters = null): array + { + return $this->rawFacets($field, $this->filterBuilder->build($filters))['facetDistribution'][$field] ?? []; + } + + /** + * The min/max `price` across products matching the given filters (minus + * `minPrice`/`maxPrice` themselves, same "scoped but not self-collapsing" + * reasoning as `facets()` — a price slider's own bounds shouldn't shrink to + * whatever range is currently selected). Backed by Meilisearch's `facetStats`, + * not `facetDistribution` — the right feature for a numeric field's range, + * where `facets('price')` would otherwise return one entry per exact price. + * + * $query defaults to '' (every product, same as list()'s own default text + * query) — pass the shopper's search text here too so a search page's own + * price slider spans only the products that search actually matched, + * rather than the whole catalog's price range. + * + * @return array{min: ?float, max: ?float} null/null if no product matches + */ + public function priceRange(?ProductFilters $filters = null, string $query = ''): array + { + $filter = $this->filterBuilder->build($filters, exclude: ['price']); + $stats = $this->rawFacets('price', $filter, $query)['facetStats']['price'] ?? null; + + return [ + 'min' => $stats['min'] ?? null, + 'max' => $stats['max'] ?? null, + ]; + } + + /** + * priceRange() rounded to whole euros (floor/ceil, so the slider's ends + * are never tighter than what's actually in range) plus whether + * $selectedMinPrice/$selectedMaxPrice actually narrow it — the same + * "floor/ceil + is this a real filter" rule CategoryController and + * SearchController each used to duplicate inline. $selectedMinPrice/ + * $selectedMaxPrice are the currently-applied filter values (e.g. + * CategoryListing::$minPrice), not part of $filters itself, since + * $filters here must already exclude price the way priceRange() expects. + */ + public function priceSliderBounds( + ?ProductFilters $filters, + ?float $selectedMinPrice, + ?float $selectedMaxPrice, + string $query = '', + ): PriceSliderBounds { + $priceRange = $this->priceRange($filters, $query); + + $floor = $priceRange['min'] !== null ? (int) floor($priceRange['min']) : null; + $ceil = $priceRange['max'] !== null ? (int) ceil($priceRange['max']) : null; + + $filtered = ($selectedMinPrice !== null && $selectedMinPrice > ($floor ?? PHP_INT_MIN)) + || ($selectedMaxPrice !== null && $selectedMaxPrice < ($ceil ?? PHP_INT_MAX)); + + return new PriceSliderBounds($floor, $ceil, $filtered); + } + + private function rawFacets(string $field, ?string $filter, string $query = ''): array + { + return Product::search($query) + ->options([ + 'filter' => $filter, + 'facets' => [$field], + 'hitsPerPage' => 0, + ]) + ->raw(); + } + + /** + * Look up a single product by its URL slug (any locale - slugs are indexed across + * all languages, see Modules\Core\Catalog\Services\ProductIndexer). Returns the full + * indexed product document, or null if no product has that slug. + */ + public function getBySlug(string $slug): ?array + { + return $this->findOneWhere('slugs = "'.addcslashes($slug, '"\\').'"'); + } + + /** + * Look up a single product by its primary key. Returns the full indexed product + * document, or null if no product has that id. + */ + public function getById(int $id): ?array + { + return $this->findOneWhere("id = \"{$id}\""); + } + + /** + * The id/price/image of every variant on a product document (from + * getById()/getBySlug()'s own 'variants' array) — the base price and + * thumbnail a variant picker/swatch list needs, without a caller + * reaching into $product['variants'][n]['prices'][0]/['media'][0] + * itself. Domain shaping (which price/image represents a variant), + * not presentation — a card's href/layout stays a storefront concern + * (e.g. App\Catalog\ProductCard in 3dealer), but "the variant's price + * is its first price row" is a rule about the data, true regardless of + * which app renders it. + * + * @param array $product A document from getById()/getBySlug(). + * @return array + */ + public function variantSummaries(array $product): array + { + return collect($product['variants'] ?? []) + ->map(fn (array $variant) => [ + 'id' => $variant['id'], + 'price' => $variant['prices'][0]['price'] ?? null, + 'image' => $variant['media'][0]['url'] ?? null, + ]) + ->values() + ->all(); + } + + /** + * $limit random products, still scoped to the index's own default + * visibility (channel/status), unlike Eloquent's Product::inRandomOrder() + * which has no notion of that filtering at all — a random pick can never + * surface a hidden/unpublished product this way. Meilisearch itself has + * no ORDER BY RANDOM() equivalent, so this pulls every matching id only + * (attributesToRetrieve: ['id'], the lightest possible request — no + * name/media/variants/etc. for documents that will mostly be discarded), + * shuffles in PHP, then fetches the full localized documents for just + * the $limit ids actually picked. + * + * @return array + */ + public function random(int $limit): array + { + $raw = Product::search('') + ->options(['attributesToRetrieve' => ['id']]) + ->raw(); + + $ids = collect($raw['hits'] ?? [])->pluck('id')->shuffle()->take($limit)->values(); + + if ($ids->isEmpty()) { + return []; + } + + // Meilisearch's `id IN [...]` doesn't preserve the given order — it's + // an unordered set filter, not a list to iterate — so the shuffle + // above would otherwise be silently undone by whatever order the + // re-fetch comes back in. Re-sort the fetched documents back into + // $ids's already-shuffled order instead of trusting the response's. + $products = collect($this->findAllWhere('id IN ['.$ids->implode(', ').']')) + ->keyBy('id'); + + return $ids->map(fn ($id) => $products->get($id))->filter()->values()->all(); + } + + private function findOneWhere(string $filter): ?array + { + $products = $this->findAllWhere($filter, limit: 1); + + return $products[0] ?? null; + } + + /** + * @return array + */ + private function findAllWhere(string $filter, int $limit = 1000): array + { + $paginator = Product::search('') + ->options(['filter' => $filter]) + ->paginateRaw(perPage: $limit, page: 1); + + return collect($this->localizer->hitsFrom($paginator)) + ->map(fn (array $product) => $this->localizer->withLocalizedFields($product)) + ->all(); + } +} diff --git a/src/Catalog/Services/RecommendationService.php b/src/Catalog/Services/RecommendationService.php new file mode 100644 index 0000000..986884c --- /dev/null +++ b/src/Catalog/Services/RecommendationService.php @@ -0,0 +1,47 @@ + + */ + public function recommend(Product $product, int $limit = 4): Collection + { + $recommendations = new Collection(); + + foreach (config('catalog.recommendation_rules', []) as $ruleClass) { + if ($recommendations->count() >= $limit) { + break; + } + + $exclude = [$product->id, ...$recommendations->pluck('id')]; + $remaining = $limit - $recommendations->count(); + + /** @var RecommendationRule $rule */ + $rule = app($ruleClass); + $recommendations = $recommendations->merge( + $rule->recommend($product, $remaining, $exclude) + ); + } + + return $recommendations->take($limit)->values(); + } +} diff --git a/src/Catalog/Support/ProductDocumentLocalizer.php b/src/Catalog/Support/ProductDocumentLocalizer.php new file mode 100644 index 0000000..fb43ebd --- /dev/null +++ b/src/Catalog/Support/ProductDocumentLocalizer.php @@ -0,0 +1,86 @@ +languages->defaultLocale(); + $availableLocales = $this->languages->availableLocales(); + + foreach ($this->translatedAttributeHandles() as $handle) { + $product[$handle] = $product[$handle.'_'.$locale] ?? $product[$handle.'_'.$fallbackLocale] ?? null; + + foreach ($availableLocales as $availableLocale) { + unset($product[$handle.'_'.$availableLocale]); + } + } + + return $product; + } + + /** + * For the Meilisearch driver, Scout's paginateRaw() puts the whole raw response + * (hits, query, processingTimeMs, ...) in items(), not a plain list of hits - the + * actual documents are under the 'hits' key. + */ + public function hitsFrom(LengthAwarePaginatorContract $paginator): array + { + $rawResponse = $paginator->items(); + + return collect($rawResponse['hits'] ?? [])->values()->all(); + } + + /** + * @return array + */ + private function translatedAttributeHandles(): array + { + return $this->attributes->getSearchableAttributes((new Product)->getMorphClass()) + ->filter(fn ($attribute) => $attribute->type === TranslatedText::class) + ->pluck('handle') + ->all(); + } +} \ No newline at end of file diff --git a/src/Catalog/Support/ProductFilterBuilder.php b/src/Catalog/Support/ProductFilterBuilder.php new file mode 100644 index 0000000..dddf401 --- /dev/null +++ b/src/Catalog/Support/ProductFilterBuilder.php @@ -0,0 +1,41 @@ + $exclude + * filter fields to leave out even if set on $filters — e.g. + * ProductService::priceRange() excludes 'price' so a price slider's own + * bounds don't shrink to whatever range is already selected on it. + */ + public function build(?ProductFilters $filters, array $exclude = []): ?string + { + if ($filters === null) { + return null; + } + + $clauses = Collection::make([ + 'collectionId' => $filters->collectionId !== null ? "collection_ids = \"{$filters->collectionId}\"" : null, + 'brand' => $filters->brand !== null ? 'brand = "'.addcslashes($filters->brand, '"\\').'"' : null, + 'tag' => $filters->tag !== null ? 'tags = "'.addcslashes($filters->tag, '"\\').'"' : null, + 'price' => Collection::make([ + $filters->minPrice !== null ? "price >= {$filters->minPrice}" : null, + $filters->maxPrice !== null ? "price <= {$filters->maxPrice}" : null, + ])->filter()->join(' AND ') ?: null, + 'inStockOnly' => $filters->inStockOnly ? 'in_stock = true' : null, + ])->except($exclude)->filter(); + + return $clauses->isEmpty() ? null : $clauses->join(' AND '); + } +} diff --git a/src/Checkout/Events/BillingAddressSet.php b/src/Checkout/Events/BillingAddressSet.php new file mode 100644 index 0000000..9dd48b4 --- /dev/null +++ b/src/Checkout/Events/BillingAddressSet.php @@ -0,0 +1,20 @@ +cart->currentOrCreate()->setShippingAddress($address); + + Event::dispatch(new ShippingAddressSet($cart, $address)); + + return $cart; + } + + public function setBillingAddress(array|Addressable $address): Cart + { + $cart = $this->cart->currentOrCreate()->setBillingAddress($address); + + Event::dispatch(new BillingAddressSet($cart, $address)); + + return $cart; + } + + /** + * The shopper's promotional/abandoned-cart-recovery opt-in — a + * cart-level decision, deliberately independent of setShippingAddress()/ + * setBillingAddress(): consent is given once, and must NOT be reset or + * re-asked just because the shopper later changes which address is on + * the cart (a different Addressable being set is not a withdrawal of + * consent). Only an explicit call to THIS method — the checkbox itself + * being submitted, checked or unchecked — ever changes it; calling it + * again with false is exactly how a later opt-out is recorded. + * + * Stored on Cart::meta (interim, per the legal design this implements — + * a real column/consent record is the eventual target) as + * recovery_consent (bool), recovery_consent_at (ISO 8601 timestamp, + * null when $consent is false), and recovery_consent_policy_version + * (config('legal.privacy_policy_version') at the moment of consent — + * so a later dispute is answered from what was actually agreed to, + * not whatever the policy says today). Separate from any future + * newsletter opt-in — recovery consent is its own scope, never merged + * with marketing-newsletter consent. + * + * Deliberately does not merge with the meta-writing pattern + * selectPaymentMethod() uses (read-merge-save in two separate + * statements) — this writes both meta keys in one save, since there's + * no dependency between recovery_consent and anything else needing to + * be persisted first. + */ + public function setRecoveryConsent(bool $consent): Cart + { + $cart = $this->cart->currentOrCreate(); + + $cart->meta = [ + ...($cart->meta?->toArray() ?? []), + 'recovery_consent' => $consent, + 'recovery_consent_at' => $consent ? now()->toIso8601String() : null, + 'recovery_consent_policy_version' => $consent ? config('legal.privacy_policy_version') : null, + ]; + $cart->save(); + + Event::dispatch(new RecoveryConsentSet($cart, $consent)); + + return $cart; + } + + /** + * Every shipping option currently available for the cart — already + * fully backed by the merged Shipping-Carriers work: this runs every + * registered Lunar\Shipping\Interfaces\ShippingRateInterface driver + * (ACS/Box Now live-rate quoting alongside table-rate-shipping's own + * flat-rate/free-shipping/collection drivers) through + * ShippingManifest's pipeline. No rate-resolution logic lives here — + * this is a thin pass-through. + * + * @return Collection + */ + public function getShippingOptions(): Collection + { + return ShippingManifest::getOptions($this->cart->currentOrCreate()); + } + + /** + * @throws InvalidShippingOptionException if $identifier doesn't resolve + * to a real, currently-available option for the cart + */ + public function selectShippingOption(string $identifier): Cart + { + $cartBefore = $this->cart->currentOrCreate(); + $option = ShippingManifest::getOption($cartBefore, $identifier); + + if ($option === null) { + throw new InvalidShippingOptionException($identifier); + } + + $cart = $cartBefore->setShippingOption($option); + + Event::dispatch(new ShippingOptionSelected($cart, $option)); + + return $cart; + } + + /** + * Every payment method currently offered to the storefront, ordered by + * Modules\Core\Payment\Models\PaymentMethod::position — a row is + * offered only when ALL three checks pass, each meaning something + * different to an admin diagnosing why a method isn't showing up (see + * docs/payments.md): + * 1. `enabled` — an admin turned it on. + * 2. its `driver` still resolves via PaymentDriverRegistry — the + * driver class hasn't been removed (see the `payment:sync-drivers` + * command, which sets `driver_missing_at` when this fails; a row + * with that set is excluded here regardless of `enabled`, so a + * vanished driver can never silently look "available"). + * 3. the resolved driver reports Configurable::isConfigured() — its + * own runtime requirements (e.g. an API key) are met. + * + * @return Collection + */ + public function getPaymentMethods(): Collection + { + return $this->paymentMethods->all() + ->filter(fn (PaymentMethod $method) => $method->enabled && $method->driver_missing_at === null) + ->filter(fn (PaymentMethod $method) => $this->paymentDrivers->resolve($method->driver)?->isConfigured() ?? false) + ->values(); + } + + /** + * Records which payment type the shopper picked (Cart::meta + * ['payment_method']) — read by Modules\Core\Payment\Pipelines\ + * Cart\ApplyPaymentMethodFee to add that method's own `data.fee` (if + * any) before recalculation. + * + * Also snapshots Cart::fingerprint() into meta, *after* saving the + * chosen type — the fingerprint has to reflect the final total + * including any payment-method-specific fee, which only exists once + * payment_method is set and the cart recalculates. Captured here, + * server-side, rather than asked of the storefront: this is the last + * moment before initiatePayment() that the shopper's reviewed total is + * known, and initiatePayment() reads it back internally instead of + * taking a fingerprint parameter — a storefront should never need to + * know Cart::fingerprint() exists. + * + * Does not itself call a payment driver — selecting a method and + * initiating payment against it are deliberately separate steps, same + * as selecting a shipping option happens before placing the order. + * + * @throws UnknownPaymentTypeException if $type isn't currently offered + * — see getPaymentMethods() for what that means + */ + public function selectPaymentMethod(string $type): Cart + { + if (! $this->getPaymentMethods()->contains('type', $type)) { + throw new UnknownPaymentTypeException($type); + } + + $cart = $this->cart->currentOrCreate(); + $cart->meta = [...($cart->meta?->toArray() ?? []), 'payment_method' => $type]; + $cart->save(); + + // Cart::calculate() no-ops if this cart instance was already + // calculated earlier in the request (Cart::isCalculated()) — which + // it will have been if the shopper switches payment method after + // the checkout page's first render already calculated it. Without + // recalculate() forcing a fresh run, the just-saved payment_method + // (and any fee tied to it, see ApplyPaymentMethodFee) would never + // be reflected — the summary would keep showing whichever method + // was calculated first. + $cart = $cart->recalculate(); + $cart->meta = [...($cart->meta?->toArray() ?? []), 'checkout_fingerprint' => $cart->fingerprint()]; + $cart->save(); + + Event::dispatch(new PaymentMethodSelected($cart, $type)); + + return $cart; + } + + /** + * The one storefront-facing "place this order and pay for it" call — + * the point where Checkout hands off to Payment. Ensures a draft + * Order exists (Cart::createOrder() — confirmed idempotent against a + * cart's own pre-existing, not-yet-placed-at draft; see + * vendor/lunarphp/core/src/Actions/Carts/CreateOrder.php), then + * resolves the payment method selected by selectPaymentMethod() and + * calls pay() or authorize() on its driver, per that method's own + * `capture_mode` column. + * + * Returns the driver's own PaymentResult UNCHANGED — this method does + * not wait for or resolve anything past what pay()/authorize() itself + * returns synchronously. A Pending result (an async gateway like + * Stripe requiring 3-D Secure/a redirect) is a normal, expected + * outcome, not an error — the caller (a storefront controller) is + * responsible for whatever the gateway needs next. + * + * The draft order's own $order->total (not the Cart's) is what gets + * passed as $amount — Order::$total is Lunar's own Price-cast + * attribute, already resolving the correct Currency via the order's + * own currency_code, and is the authoritative total once the draft + * row exists. + * + * $context passed to the driver is {cart_id, order_id} — the exact + * keys Modules\Core\Payment\Drivers\StripePaymentDriver:: + * rememberIntent() already reads. + * + * Same fingerprint precondition the old placeOrder() had: mandatory, + * not optional, checked before the draft is created. + * + * $termsAccepted is likewise mandatory, not optional data a caller + * might omit — an Order is a consumer contract, and its acceptance + * must be refused (TermsNotAcceptedException, before createOrder() is + * ever called — the order is never created-then-flagged) rather than + * assumed. $policyVersion is recorded alongside it on the created + * Order's own meta (terms_accepted, terms_accepted_at, + * terms_accepted_policy_version) — the order-level equivalent of + * setRecoveryConsent()'s cart-level record, and the durable audit + * trail for a later "what did the shopper actually agree to" + * dispute. Written directly here (not via a separate event/listener) + * since the Order row this attaches to doesn't exist before + * createOrder() runs, and nothing else needs to react to this + * specific write independently of the order simply existing. + * + * @param array $data passed through untouched to + * the driver's pay()/authorize() — e.g. Stripe's payment_method + * token. + * + * @throws UnknownPaymentTypeException if the cart's selected + * payment_method (from selectPaymentMethod()) is no longer offered + * — re-checked here, not just at selection time, since a method + * could be disabled (or its driver removed) in between + * @throws TermsNotAcceptedException if $termsAccepted is false + * @throws FingerprintMismatchException + * @throws CartException + */ + public function initiatePayment(string $fingerprint, bool $termsAccepted, string $policyVersion, array $data = []): PaymentResult + { + if (! $termsAccepted) { + throw new TermsNotAcceptedException; + } + + $cart = $this->cart->currentOrCreate(); + $cart->checkFingerprint($fingerprint); + + $type = $cart->meta['payment_method'] ?? null; + $method = $type !== null ? $this->getPaymentMethods()->firstWhere('type', $type) : null; + + if ($method === null) { + throw new UnknownPaymentTypeException((string) $type); + } + + $order = $cart->createOrder(); + + $order->meta = [ + ...($order->meta?->toArray() ?? []), + 'payment_method' => $type, + 'terms_accepted' => true, + 'terms_accepted_at' => now()->toIso8601String(), + 'terms_accepted_policy_version' => $policyVersion, + ]; + $order->save(); + + $driver = $this->paymentDrivers->resolve($method->driver); + $context = ['cart_id' => $cart->id, 'order_id' => $order->id]; + + return $method->capture_mode === 'authorize' + ? $driver->authorize($type, $order->total, $data, $context) + : $driver->pay($type, $order->total, $data, $context); + } +} diff --git a/src/Command/BackfillMissingSkusCommand.php b/src/Command/BackfillMissingSkusCommand.php new file mode 100644 index 0000000..6bbbbed --- /dev/null +++ b/src/Command/BackfillMissingSkusCommand.php @@ -0,0 +1,60 @@ +option('dry-run'); + + $query = ProductVariant::query()->whereNull('sku'); + $total = $query->count(); + + if ($total === 0) { + $this->info('No variants are missing a SKU.'); + + return; + } + + $this->info(($dryRun ? '[dry-run] ' : '') . "Backfilling SKUs for {$total} variant(s)..."); + + $bar = $this->output->createProgressBar($total); + $bar->start(); + + $query->chunkById(500, function ($variants) use ($dryRun, $bar) { + foreach ($variants as $variant) { + $sku = "SKU-P{$variant->product_id}-V{$variant->id}"; + + if ($dryRun) { + $this->newLine(); + $this->line("Variant {$variant->id}: sku => {$sku}"); + } else { + $variant->update(['sku' => $sku]); + } + + $bar->advance(); + } + }); + + $bar->finish(); + $this->newLine(); + $this->info($dryRun ? 'Dry run complete — no changes were written.' : 'Done.'); + } +} diff --git a/src/Command/CreateAdminCommand.php b/src/Command/CreateAdminCommand.php index a728930..a281c42 100644 --- a/src/Command/CreateAdminCommand.php +++ b/src/Command/CreateAdminCommand.php @@ -2,6 +2,7 @@ namespace Modules\Core\Command; +use Lunar\Admin\Models\Staff; use Lunar\Admin\Console\Commands\MakeLunarAdminCommand; use function Laravel\Prompts\text; @@ -31,7 +32,7 @@ class CreateAdminCommand extends MakeLunarAdminCommand required: true, validate: fn (string $email): ?string => match (true) { ! filter_var($email, FILTER_VALIDATE_EMAIL) => 'The email address must be valid.', - \Lunar\Admin\Models\Staff::where('email', $email)->exists() => 'A user with this email address already exists', + Staff::where('email', $email)->exists() => 'A user with this email address already exists', default => null, }, ), diff --git a/src/Command/ExportCommand.php b/src/Command/ExportCommand.php index 5a01855..4d6725a 100644 --- a/src/Command/ExportCommand.php +++ b/src/Command/ExportCommand.php @@ -2,6 +2,9 @@ namespace Modules\Core\Command; +use RecursiveIteratorIterator; +use RecursiveDirectoryIterator; +use FilesystemIterator; use Illuminate\Console\Command; use Illuminate\Support\Facades\Storage; use Modules\Core\ResultType\Error; @@ -88,10 +91,10 @@ class ExportCommand extends Command $zip->addFile($sqlFile, basename($sqlFile)); if (is_dir($filesDir)) { - $iterator = new \RecursiveIteratorIterator( - new \RecursiveDirectoryIterator( + $iterator = new RecursiveIteratorIterator( + new RecursiveDirectoryIterator( $filesDir, - \FilesystemIterator::SKIP_DOTS, + FilesystemIterator::SKIP_DOTS, ), ); foreach ($iterator as $file) { diff --git a/src/Command/InstallLunarCommand.php b/src/Command/InstallLunarCommand.php index e07d3a3..c20f636 100644 --- a/src/Command/InstallLunarCommand.php +++ b/src/Command/InstallLunarCommand.php @@ -18,7 +18,10 @@ use Lunar\Models\Product; use Lunar\Models\ProductType; use Lunar\Models\TaxClass; use Lunar\Models\TaxZone; -use Spatie\TranslationLoader\LanguageLine; +use Modules\Core\Localization\Models\LanguageLine; +use Modules\Core\Localization\Services\StorefrontLabels; +use Modules\Core\Localization\Services\TranslationService; +use Modules\Core\Payment\Models\PaymentMethod; /** * Overrides Lunar's own lunar:install to skip the interactive prompts (migrate @@ -32,7 +35,7 @@ class InstallLunarCommand extends Command protected $description = 'Seed the default Lunar store data (countries, channel, currency, tax zone, attributes, product type)'; - public function handle(): void + public function handle(TranslationService $translations): void { $this->components->info('Seeding default Lunar store data...'); @@ -63,6 +66,16 @@ class InstallLunarCommand extends Command ]); } + if (! Language::where('code', 'el')->exists()) { + $this->components->info('Adding Greek language'); + + Language::create([ + 'code' => 'el', + 'name' => 'Greek', + 'default' => false, + ]); + } + if (! Currency::whereDefault(true)->exists()) { $this->components->info('Adding a default currency (USD)'); @@ -242,10 +255,11 @@ class InstallLunarCommand extends Command } }); - if (! LanguageLine::where('group', 'storefront')->exists()) { - $this->components->info('Seeding storefront label translations'); - $this->seedStorefrontLabels(); - } + $this->components->info('Seeding storefront label translations'); + $this->seedStorefrontLabels($translations); + + $this->components->info('Seeding payment method settings'); + $this->seedPaymentMethods(); $this->components->info('Publishing Filament assets'); $this->call('filament:assets'); @@ -253,32 +267,68 @@ class InstallLunarCommand extends Command $this->components->info('Lunar default data seeded.'); } - private function seedStorefrontLabels(): void + /** + * Per-key upsert, not an all-or-nothing "only seed if the group is empty" guard — + * a key already present in the database (including one an admin has since edited + * via the Filament Languages resource) is left untouched; only keys missing + * entirely are created. This is what makes it safe to add new keys to + * StorefrontLabels later and re-run this on an already-installed store without + * either skipping the new keys (the old all-or-nothing guard) or reverting an + * admin's edits back to the hardcoded default (a naive updateOrCreate would). + */ + private function seedStorefrontLabels(TranslationService $translations): void { - $labels = [ - 'nav.home' => ['en' => 'Home', 'el' => 'Αρχική'], - 'nav.products' => ['en' => 'Products', 'el' => 'Προϊόντα'], - 'nav.cart' => ['en' => 'Cart', 'el' => 'Καλάθι'], - 'nav.account' => ['en' => 'Account', 'el' => 'Λογαριασμός'], - 'nav.back' => ['en' => 'Back', 'el' => 'Πίσω'], - 'cart.empty' => ['en' => 'Your cart is empty', 'el' => 'Το καλάθι σας είναι άδειο'], - 'cart.checkout' => ['en' => 'Checkout', 'el' => 'Ολοκλήρωση Παραγγελίας'], - 'cart.total' => ['en' => 'Total', 'el' => 'Σύνολο'], - 'cart.remove' => ['en' => 'Remove', 'el' => 'Αφαίρεση'], - 'product.add_to_cart' => ['en' => 'Add to Cart', 'el' => 'Προσθήκη στο Καλάθι'], - 'product.out_of_stock' => ['en' => 'Out of Stock', 'el' => 'Εξαντλήθηκε'], - 'product.price' => ['en' => 'Price', 'el' => 'Τιμή'], - 'auth.login' => ['en' => 'Log In', 'el' => 'Σύνδεση'], - 'auth.logout' => ['en' => 'Log Out', 'el' => 'Αποσύνδεση'], - 'search.placeholder' => ['en' => 'Search products…', 'el' => 'Αναζήτηση προϊόντων…'], - ]; + $labels = StorefrontLabels::all(); + + $existingKeys = LanguageLine::where('group', 'storefront') + ->whereIn('key', array_keys($labels)) + ->pluck('key'); foreach ($labels as $key => $text) { - LanguageLine::create([ - 'group' => 'storefront', - 'key' => $key, - 'text' => $text, - ]); + if ($existingKeys->contains($key)) { + continue; + } + + $translations->create('storefront', $key, $text); } } + + /** + * A single, deliberately opinionated starter row on fresh install — + * `PaymentMethod` is now fully admin-creatable/deletable (see + * docs/payments.md), so this is no longer "seed every config-defined + * type," it's "give a fresh store one reasonable payment method to + * start from instead of zero." Every value here is a plain literal in + * THIS command, not sourced from config or PaymentDriverRegistry — a + * driver has no business carrying opinions about what its captured + * order status should be called; that's a merchant decision. + * + * Skip-if-exists on `type`, same idempotent convention as + * seedStorefrontLabels() — an admin who has since edited or deleted + * this row (via the Filament Payment Methods resource) is left alone; + * re-running lunar:install never recreates a deleted starter row. + * + * Seeded disabled — shouldn't go live for shoppers before staff have + * actually reviewed it and turned it on via the Payment Methods + * resource. See CheckoutService::getPaymentMethods(). + */ + private function seedPaymentMethods(): void + { + if (PaymentMethod::where('type', 'cash-on-delivery')->exists()) { + return; + } + + PaymentMethod::create([ + 'type' => 'cash-on-delivery', + 'name' => [ + 'en' => 'Cash on Delivery', + 'el' => 'Αντικαταβολή', + ], + 'driver' => 'cash-on-delivery', + 'capture_mode' => 'pay', + 'position' => 0, + 'enabled' => false, + 'data' => [], + ]); + } } diff --git a/src/Command/SyncPaymentDriversCommand.php b/src/Command/SyncPaymentDriversCommand.php new file mode 100644 index 0000000..c8bd59e --- /dev/null +++ b/src/Command/SyncPaymentDriversCommand.php @@ -0,0 +1,52 @@ +each(function (PaymentMethod $method) use ($registry, &$missing, &$restored) { + $resolves = $method->driver !== null && $registry->resolve($method->driver) !== null; + + if (! $resolves && $method->driver_missing_at === null) { + $method->update(['driver_missing_at' => now()]); + $missing++; + } elseif ($resolves && $method->driver_missing_at !== null) { + $method->update(['driver_missing_at' => null]); + $restored++; + } + }); + + $this->components->info("Payment driver sync complete: {$missing} newly flagged, {$restored} restored."); + + return self::SUCCESS; + } +} diff --git a/src/Command/TuneProductSearchCommand.php b/src/Command/TuneProductSearchCommand.php new file mode 100644 index 0000000..e0687e1 --- /dev/null +++ b/src/Command/TuneProductSearchCommand.php @@ -0,0 +1,67 @@ +createMeilisearchDriver(); + + $index = $engine->getIndex((new Product)->searchableAs()); + + $this->components->info('Updating typo tolerance for product search...'); + + $task = $index->updateTypoTolerance([ + 'minWordSizeForTypos' => [ + 'oneTypo' => 8, + 'twoTypos' => 12, + ], + ]); + + $engine->waitForTask($task['taskUid']); + + $this->components->info('Disabling prefix search for product search...'); + + $task = $index->updatePrefixSearch('disabled'); + + $engine->waitForTask($task['taskUid']); + + $this->components->info('Product search index tuned.'); + } +} diff --git a/src/CorePlugin.php b/src/CorePlugin.php index 348553d..0187933 100644 --- a/src/CorePlugin.php +++ b/src/CorePlugin.php @@ -2,6 +2,8 @@ namespace Modules\Core; +use Lunar\Admin\Filament\Resources\OrderResource\Pages\ManageOrder; +use Lunar\Admin\Filament\Resources\OrderResource\Pages\Components\OrderItemsTable; use Filament\Contracts\Plugin; use Filament\Panel; use Illuminate\Database\Eloquent\Relations\HasMany; @@ -10,25 +12,44 @@ use Illuminate\Support\Facades\Mail; use Lunar\Admin\Filament\Resources\CustomerResource; use Lunar\Admin\Filament\Resources\CustomerResource\Pages\EditCustomer; use Lunar\Admin\Filament\Resources\CustomerResource\Pages\ViewCustomer; +use Lunar\Admin\Filament\Resources\ProductOptionResource; +use Lunar\Admin\Filament\Resources\ProductOptionResource\RelationManagers\ValuesRelationManager; +use Lunar\Admin\Filament\Resources\OrderResource; use Lunar\Admin\Filament\Resources\ProductResource; use Lunar\Admin\Filament\Resources\StaffResource; use Lunar\Admin\Models\Staff as LunarStaff; use Lunar\Admin\Support\Facades\LunarPanel; use Lunar\Models\Customer; use Lunar\Models\Product; +use Lunar\Shipping\Filament\Resources\ShippingMethodResource; +use Lunar\Shipping\Filament\Resources\ShippingMethodResource\Pages\ListShippingMethod; use Lunar\Shipping\ShippingPlugin; use Modules\Core\Auth\Extensions\StaffResourceExtension; use Modules\Core\Auth\Filament\Pages\Login; use Modules\Core\Auth\Mail\InviteMail; +use Modules\Core\Cart\Filament\Resources\CartResource; +use Modules\Core\Catalog\Filament\Extensions\ProductOptionResourceExtension; +use Modules\Core\Catalog\Filament\Extensions\ValuesRelationManagerExtension; use Modules\Core\Localization\Filament\Resources\LanguageLineResource; +use Modules\Core\Order\Filament\Extensions\OrderItemsTableExtension; +use Modules\Core\Order\Filament\Extensions\OrderPaymentMethodSummaryExtension; +use Modules\Core\Order\Filament\Extensions\OrderActionsExtension; +use Modules\Core\Order\Filament\Extensions\OrderTransactionsExtension; +use Modules\Core\Payment\Filament\Resources\PaymentMethodResource; use Modules\Core\Privacy\Filament\Extensions\CustomerErasureActionsExtension; use Modules\Core\Privacy\Filament\Extensions\CustomerErasureRelationsExtension; use Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource; use Modules\Core\Privacy\Filament\Resources\DataExportRequestResource; use Modules\Core\Privacy\Models\DataErasureRequest; use Modules\Core\Privacy\Models\DataExportRequest; -use Modules\Core\Review\Extensions\ProductResourceExtension; +use Modules\Core\Review\Filament\Extensions\ProductResourceExtension; use Modules\Core\Review\Models\ProductReview; +use Modules\Core\Shipping\Extensions\OrderShipmentsExtension; +use Modules\Core\Shipping\Extensions\OrderViewExtension; +use Modules\Core\Shipping\Extensions\ShippingMethodListExtension; +use Modules\Core\Shipping\Extensions\ShippingMethodResourceExtension; +use Modules\Core\Shipping\Filament\Resources\ManifestResource; +use Modules\Core\Shipping\Filament\Resources\ShipmentResource; class CorePlugin implements Plugin { @@ -48,12 +69,22 @@ class CorePlugin implements Plugin LanguageLineResource::class, DataErasureRequestResource::class, DataExportRequestResource::class, + CartResource::class, + PaymentMethodResource::class, + ShipmentResource::class, + ManifestResource::class, ]) ->plugin(ShippingPlugin::make()); LunarPanel::extensions([ StaffResource::class => StaffResourceExtension::class, ProductResource::class => ProductResourceExtension::class, + ProductOptionResource::class => ProductOptionResourceExtension::class, + ValuesRelationManager::class => ValuesRelationManagerExtension::class, + ShippingMethodResource::class => ShippingMethodResourceExtension::class, + ListShippingMethod::class => ShippingMethodListExtension::class, + ManageOrder::class => [OrderViewExtension::class, OrderActionsExtension::class, OrderTransactionsExtension::class, OrderPaymentMethodSummaryExtension::class, OrderShipmentsExtension::class], + OrderItemsTable::class => OrderItemsTableExtension::class, // headerActions() is resolved per PAGE class, not per resource class — // unlike extendForm()/extendTable(), which really are resource-keyed // (called statically from the Resource class itself). Registering this @@ -110,9 +141,8 @@ class CorePlugin implements Plugin 'password', 'remember_token', 'email_verified_at', - 'two_factor_secret', - 'two_factor_recovery_codes', - 'two_factor_confirmed_at', + 'app_authentication_secret', + 'app_authentication_recovery_codes', ]); LunarStaff::created(function (LunarStaff $staff) { diff --git a/src/Customer/Events/CustomerAddressCreated.php b/src/Customer/Events/CustomerAddressCreated.php new file mode 100644 index 0000000..2afacf3 --- /dev/null +++ b/src/Customer/Events/CustomerAddressCreated.php @@ -0,0 +1,22 @@ + $address Snapshot of the deleted + * row — already gone from the database by dispatch time. + */ + public function __construct( + public readonly array $address, + public readonly Authenticatable $causer, + ) {} +} diff --git a/src/Customer/Events/CustomerAddressUpdated.php b/src/Customer/Events/CustomerAddressUpdated.php new file mode 100644 index 0000000..bdb4701 --- /dev/null +++ b/src/Customer/Events/CustomerAddressUpdated.php @@ -0,0 +1,19 @@ + $old Snapshot of the changed + * attributes before the update. + */ + public function __construct( + public readonly Address $address, + public readonly array $old, + public readonly Authenticatable $causer, + ) {} +} diff --git a/src/Customer/Events/CustomerProfileUpdated.php b/src/Customer/Events/CustomerProfileUpdated.php new file mode 100644 index 0000000..63f5bd7 --- /dev/null +++ b/src/Customer/Events/CustomerProfileUpdated.php @@ -0,0 +1,19 @@ + $old Snapshot of the changed + * attributes before the update. + */ + public function __construct( + public readonly Customer $customer, + public readonly array $old, + public readonly Authenticatable $causer, + ) {} +} diff --git a/src/Customer/Exceptions/AddressNotFoundException.php b/src/Customer/Exceptions/AddressNotFoundException.php new file mode 100644 index 0000000..c215141 --- /dev/null +++ b/src/Customer/Exceptions/AddressNotFoundException.php @@ -0,0 +1,20 @@ +activityLog->created($event->address, $event->address->getAttributes(), $event->causer); + } + + public function handleAddressUpdated(CustomerAddressUpdated $event): void + { + $this->activityLog->updated( + $event->address, + $event->old, + $event->address->only(array_keys($event->old)), + $event->causer, + ); + } + + public function handleAddressDeleted(CustomerAddressDeleted $event): void + { + $subject = (new Address)->forceFill($event->address); + $subject->exists = true; + $subject->id = $event->address['id']; + + $this->activityLog->deleted($subject, $event->address, $event->causer); + } + + public function handleProfileUpdated(CustomerProfileUpdated $event): void + { + $this->activityLog->updated( + $event->customer, + $event->old, + $event->customer->only(array_keys($event->old)), + $event->causer, + ); + } +} diff --git a/src/Customer/RelationManagers/AddressRelationManager.php b/src/Customer/RelationManagers/AddressRelationManager.php index b430797..2041db4 100644 --- a/src/Customer/RelationManagers/AddressRelationManager.php +++ b/src/Customer/RelationManagers/AddressRelationManager.php @@ -2,12 +2,12 @@ namespace Modules\Core\Customer\RelationManagers; -use Filament\Forms\Components\Group; +use Filament\Actions\CreateAction; +use Filament\Actions\EditAction; +use Filament\Actions\DeleteAction; +use Filament\Schemas\Components\Group; use Filament\Forms\Components\Select; use Filament\Forms\Components\TextInput; -use Filament\Tables\Actions\CreateAction; -use Filament\Tables\Actions\DeleteAction; -use Filament\Tables\Actions\EditAction; use Filament\Tables\Columns\TextColumn; use Filament\Tables\Table; use Illuminate\Database\Eloquent\Model; @@ -38,9 +38,9 @@ class AddressRelationManager extends BaseAddressRelationManager ), ]) ->headerActions([ - CreateAction::make()->form($this->addressForm()), + CreateAction::make()->schema($this->addressForm()), ]) - ->actions([ + ->recordActions([ EditAction::make('editAddress') ->fillForm(fn (AddressContract $record): array => [ 'line_one' => $record->line_one, @@ -51,7 +51,7 @@ class AddressRelationManager extends BaseAddressRelationManager 'contact_email' => $record->contact_email, 'contact_phone' => $record->contact_phone, ]) - ->form($this->addressForm()), + ->schema($this->addressForm()), DeleteAction::make('deleteAddress'), ]); } diff --git a/src/Customer/RelationManagers/UserRelationManager.php b/src/Customer/RelationManagers/UserRelationManager.php index ff3f862..0bb7fef 100644 --- a/src/Customer/RelationManagers/UserRelationManager.php +++ b/src/Customer/RelationManagers/UserRelationManager.php @@ -2,6 +2,8 @@ namespace Modules\Core\Customer\RelationManagers; +use Filament\Tables\Columns\TextColumn; +use Filament\Actions\EditAction; use Filament\Forms\Components\TextInput; use Filament\Tables; use Filament\Tables\Table; @@ -14,16 +16,16 @@ class UserRelationManager extends BaseUserRelationManager public function getDefaultTable(Table $table): Table { return $table->columns([ - Tables\Columns\TextColumn::make('name') + TextColumn::make('name') ->label(__('lunarpanel::user.table.name.label')), - Tables\Columns\TextColumn::make('email') + TextColumn::make('email') ->label(__('lunarpanel::user.table.email.label')), - ])->actions([ - Tables\Actions\EditAction::make('edit') + ])->recordActions([ + EditAction::make('edit') ->after( fn (Model $record) => CustomerUserEdited::dispatch($record) ) - ->form([ + ->schema([ TextInput::make('email') ->label(__('lunarpanel::user.form.email.label')) ->required() diff --git a/src/Customer/Services/CustomerAccountService.php b/src/Customer/Services/CustomerAccountService.php new file mode 100644 index 0000000..45d663c --- /dev/null +++ b/src/Customer/Services/CustomerAccountService.php @@ -0,0 +1,255 @@ +latestCustomer() can be null for a User that has no paired + * Customer yet (shouldn't happen via the normal OTP-login cascade — see + * Modules\Core\Auth\Events\UserCreated — but is defended against anyway, + * since nothing stops a User row existing without one, e.g. seeded data) + * — every method returns an empty/null result rather than throwing in + * that case, since "no customer paired yet" isn't a not-found error, it's + * a legitimately empty account. + * + * Address/profile writes go through an explicit column allowlist + * (WRITABLE_ADDRESS_FIELDS/WRITABLE_PROFILE_FIELDS) rather than trusting + * Lunar\Models\Address/Customer's own $guarded = [] — that flag makes + * every column mass-assignable at the model layer, including + * customer_id on addresses, so a caller passing through an unfiltered + * request array (a real risk for a storefront controller built directly + * against this service) could otherwise reassign an address to a + * different customer entirely, or overwrite created_at/id. Arr::only() + * silently drops anything not on the allowlist rather than erroring — + * this is a safety boundary, not form validation (a storefront still + * validates its own request shape before calling this). + * + * Authorization here IS the ownership scoping itself, not a separate + * layer bolted on top — there is deliberately no Laravel Policy/Gate + * class for Order/Address, since a policy is meaningless without a + * controller calling authorize() against it, and this branch is scoped + * to backend services only (no routes/controllers — see the branch's own + * commit history). Every public method below takes Authenticatable $user + * as a required first argument and resolves everything else (Order, + * Address, Customer) strictly through that user's own + * latestCustomer() — there is no method that looks anything up by a bare + * id alone. A future storefront controller cannot "forget" the + * authorization check the way it could with a separate policy class, + * because the check IS how every lookup happens; skipping it isn't an + * option the method signatures allow. + */ +class CustomerAccountService +{ + private const WRITABLE_ADDRESS_FIELDS = [ + 'title', 'first_name', 'last_name', 'company_name', + 'line_one', 'line_two', 'line_three', 'city', 'state', 'postcode', + 'delivery_instructions', 'contact_email', 'contact_phone', + 'country_id', 'shipping_default', 'billing_default', + ]; + + private const WRITABLE_PROFILE_FIELDS = [ + 'title', 'first_name', 'last_name', 'company_name', 'vat_no', + ]; + + public function customer(Authenticatable $user): ?Customer + { + /** @var Customer|null */ + return $user->latestCustomer(); + } + + /** + * Placed orders only (placed_at IS NOT NULL) — a draft/abandoned + * order with no placed_at is checkout-in-progress state, not + * something that belongs in order history. + */ + public function orders(Authenticatable $user, int $perPage = 15): LengthAwarePaginator + { + $customer = $this->customer($user); + + if (! $customer) { + return new LengthAwarePaginator([], 0, $perPage); + } + + return $customer->orders() + ->whereNotNull('placed_at') + ->latest('placed_at') + ->paginate($perPage); + } + + /** + * @throws OrderNotFoundException if $orderId doesn't belong to this + * customer, or belongs to a draft (never placed) order + */ + public function order(Authenticatable $user, int $orderId): Order + { + $customer = $this->customer($user); + + $order = $customer + ?->orders() + ->whereNotNull('placed_at') + ->with(['lines', 'shippingAddress', 'billingAddress', 'transactions', 'shipments']) + ->find($orderId); + + if (! $order) { + throw new OrderNotFoundException; + } + + return $order; + } + + public function addresses(Authenticatable $user): iterable + { + $customer = $this->customer($user); + + return $customer?->addresses ?? collect(); + } + + /** + * @param array $data Any key not in + * WRITABLE_ADDRESS_FIELDS is silently dropped — see this class's + * own docblock. + */ + public function createAddress(Authenticatable $user, array $data): Address + { + $customer = $this->customerOrFail($user); + + $address = $customer->addresses()->create(Arr::only($data, self::WRITABLE_ADDRESS_FIELDS)); + + $this->enforceSingleDefault($customer, $address); + $address->refresh(); + + Event::dispatch(new CustomerAddressCreated($address, $user)); + + return $address; + } + + /** + * @throws AddressNotFoundException if $addressId doesn't belong to + * this customer + */ + public function updateAddress(Authenticatable $user, int $addressId, array $data): Address + { + $address = $this->ownedAddress($user, $addressId); + $old = $address->only(array_keys(Arr::only($data, self::WRITABLE_ADDRESS_FIELDS))); + + $address->update(Arr::only($data, self::WRITABLE_ADDRESS_FIELDS)); + + $this->enforceSingleDefault($address->customer, $address); + $address->refresh(); + + Event::dispatch(new CustomerAddressUpdated($address, $old, $user)); + + return $address; + } + + /** + * @throws AddressNotFoundException if $addressId doesn't belong to + * this customer + */ + public function deleteAddress(Authenticatable $user, int $addressId): void + { + $address = $this->ownedAddress($user, $addressId); + $snapshot = $address->getAttributes(); + + $address->delete(); + + Event::dispatch(new CustomerAddressDeleted($snapshot, $user)); + } + + /** + * Lunar has no built-in action enforcing "at most one shipping + * default / one billing default per customer" — a raw update() could + * otherwise leave two addresses both flagged shipping_default. Runs + * after every create/update, unconditionally (cheap — at most two + * single-row UPDATEs, only fired when the just-written address + * itself is a default), clearing the flag on every OTHER address of + * the same customer. + */ + private function enforceSingleDefault(Customer $customer, Address $address): void + { + if ($address->shipping_default) { + $customer->addresses()->where('id', '!=', $address->id)->update(['shipping_default' => false]); + } + + if ($address->billing_default) { + $customer->addresses()->where('id', '!=', $address->id)->update(['billing_default' => false]); + } + } + + /** + * @throws AddressNotFoundException if $addressId doesn't belong to + * this customer + */ + private function ownedAddress(Authenticatable $user, int $addressId): Address + { + $customer = $this->customer($user); + + $address = $customer?->addresses()->find($addressId); + + if (! $address) { + throw new AddressNotFoundException; + } + + return $address; + } + + /** + * @param array $data Any key not in + * WRITABLE_PROFILE_FIELDS is silently dropped — see this class's + * own docblock. + */ + public function updateProfile(Authenticatable $user, array $data): Customer + { + $customer = $this->customerOrFail($user); + $old = $customer->only(array_keys(Arr::only($data, self::WRITABLE_PROFILE_FIELDS))); + + $customer->update(Arr::only($data, self::WRITABLE_PROFILE_FIELDS)); + $customer->refresh(); + + Event::dispatch(new CustomerProfileUpdated($customer, $old, $user)); + + return $customer; + } + + /** + * @throws LogicException if $user has no paired Customer at all — + * distinct from AddressNotFoundException/OrderNotFoundException + * (which mean "this id isn't yours"), this means the account + * itself is in an invariant-violating state the normal OTP-login + * cascade should never produce. + */ + private function customerOrFail(Authenticatable $user): Customer + { + $customer = $this->customer($user); + + if (! $customer) { + throw new LogicException('This user has no paired Customer record.'); + } + + return $customer; + } +} diff --git a/src/Localization/Filament/Resources/LanguageLineResource.php b/src/Localization/Filament/Resources/LanguageLineResource.php index 3fe9469..8d4b718 100644 --- a/src/Localization/Filament/Resources/LanguageLineResource.php +++ b/src/Localization/Filament/Resources/LanguageLineResource.php @@ -2,8 +2,17 @@ namespace Modules\Core\Localization\Filament\Resources; +use Filament\Schemas\Schema; +use Filament\Forms\Components\TextInput; +use Filament\Schemas\Components\Fieldset; +use Filament\Tables\Columns\TextColumn; +use Filament\Tables\Filters\SelectFilter; +use Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages\ListLanguageLines; +use Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages\CreateLanguageLine; +use Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages\EditLanguageLine; +use Filament\Forms\Components\Textarea; +use Illuminate\Support\Collection; use Filament\Forms; -use Filament\Forms\Form; use Filament\Resources\Resource; use Filament\Tables; use Filament\Tables\Table; @@ -15,29 +24,29 @@ class LanguageLineResource extends Resource { protected static ?string $model = LanguageLine::class; - protected static ?string $navigationIcon = 'heroicon-o-language'; + protected static string | \BackedEnum | null $navigationIcon = 'heroicon-o-language'; - protected static ?string $navigationGroup = 'Settings'; + protected static string | \UnitEnum | null $navigationGroup = 'Settings'; protected static ?string $modelLabel = 'Translation'; protected static ?string $pluralModelLabel = 'Translations'; - public static function form(Form $form): Form + public static function form(Schema $schema): Schema { - return $form->schema([ - Forms\Components\TextInput::make('group') + return $schema->components([ + TextInput::make('group') ->required() ->maxLength(255) ->default('storefront') ->helperText('Namespace for this label, e.g. "storefront" for e-shop UI text.'), - Forms\Components\TextInput::make('key') + TextInput::make('key') ->required() ->maxLength(255) ->helperText('Dot-notation key, e.g. "nav.cart".'), - Forms\Components\Fieldset::make('Translations') + Fieldset::make('Translations') ->schema(static::localeInputs()), ]); } @@ -46,16 +55,16 @@ class LanguageLineResource extends Resource { return $table ->columns([ - Tables\Columns\TextColumn::make('group') + TextColumn::make('group') ->badge() ->sortable(), - Tables\Columns\TextColumn::make('key') + TextColumn::make('key') ->searchable() ->sortable(), ...static::localeColumns(), ]) ->filters([ - Tables\Filters\SelectFilter::make('group') + SelectFilter::make('group') ->options(fn () => LanguageLine::query()->distinct()->pluck('group', 'group')), ]) ->defaultSort('key'); @@ -69,38 +78,38 @@ class LanguageLineResource extends Resource public static function getPages(): array { return [ - 'index' => Pages\ListLanguageLines::route('/'), - 'create' => Pages\CreateLanguageLine::route('/create'), - 'edit' => Pages\EditLanguageLine::route('/{record}/edit'), + 'index' => ListLanguageLines::route('/'), + 'create' => CreateLanguageLine::route('/create'), + 'edit' => EditLanguageLine::route('/{record}/edit'), ]; } /** - * @return array + * @return array