Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cb3fe095d9 | ||
|
|
eef473dbd2 | ||
|
|
409db9c7bf | ||
|
|
594fa41527 | ||
|
|
ef356a6397 | ||
|
|
b3b5ca740d | ||
|
|
d01d27f7ea | ||
|
|
b86fe78852 | ||
|
|
0edf7b156d | ||
|
|
ef9e9daab0 | ||
|
|
751aff5939 | ||
|
|
09844ec2b5 | ||
|
|
885923380d | ||
|
|
235fdda4a7 | ||
|
|
c2eb9bd66a | ||
|
|
356fbd73c5 | ||
|
|
fa137c9a79 | ||
|
|
e31de1b4e3 | ||
|
|
113fa35da7 | ||
|
|
7c199cc3bd | ||
|
|
5cb6c529a0 | ||
|
|
f7da26b487 | ||
|
|
1857ced3a2 | ||
|
|
8646dca16a | ||
|
|
93469d033f | ||
|
|
4c00369005 | ||
|
|
cf6aa343f1 | ||
|
|
ee9893bd64 | ||
|
|
0524380ab0 | ||
|
|
ed496716eb | ||
|
|
1d25e0d746 | ||
|
|
96ad89b6b8 | ||
|
|
c07b36e1f9 | ||
|
|
2767a4bb69 | ||
|
|
1d2a90059d | ||
|
|
364368ba3d | ||
|
|
51c43c11b5 | ||
|
|
90ac32094c | ||
|
|
df03866285 | ||
|
|
825ce885c0 | ||
|
|
cd9632a6bf | ||
|
|
677b240a8d | ||
|
|
ab213f69ec | ||
|
|
ebe905acfa | ||
|
|
d35dff3731 |
+121
@@ -4,6 +4,127 @@ 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.6.0] - 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. Enabled per-shop as a plain list in `config('core.product_option_types')`; an admin then picks one per `ProductOption` from a "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\Services\ProductOptionTypeManager` resolves the selected key to its type (`all()`/`resolve()`). `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` (not auto-registered). Documented in `docs/product-options.md`.
|
||||
- `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.
|
||||
- `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.
|
||||
- `Modules\Core\Search\ProductIndexer` expanded well beyond its original collection/price additions to carry everything a detail page needs: `id`/`slugs` (filterable — `getById()`/`getBySlug()` resolve purely from the index, no database read), `collection_names`, `tags`, the full media gallery, per-variant data (`sku`, `stock`, `purchasable`, translated option/value names + `meta` for swatches, per-currency prices, variant media), and reviews (`reviews`, `review_count`, `average_rating` — public-safe fields only, `reviewer_email` deliberately excluded).
|
||||
- `Modules\Core\Providers\ReviewServiceProvider` (newly registered): re-indexes a product whenever one of its reviews is created/updated/deleted, since a review write doesn't touch the `Product` row and so never fires the product's own model events.
|
||||
- **`Modules\Core\Search\ProductSearchService`**: locale-aware full-text product search on top of the same Meilisearch index, for use by a storefront's search bar — separate from `ProductService`, which is for browsing/filtering without a query term.
|
||||
- `docs/product-listing.md` and `docs/product-search.md` — usage, full field reference, and design notes for the two services above.
|
||||
- `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.
|
||||
- `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.
|
||||
- `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.
|
||||
|
||||
## [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.
|
||||
- `ImportSpec`, `Importer` interface, and `ImporterFactory` (source+type → importer class) as the extension points for future sources (WooCommerce, etc.) and mechanisms (API vs. file export).
|
||||
- `import_mappings` table + `ImportMapping` model: a polymorphic (source, source_type, external_id) → model mapping used by every resolver to make imports idempotent and safely re-runnable.
|
||||
- `DefaultLocale` helper wrapping Lunar's `Language::getDefault()->code`, used anywhere a translatable field needs a locale key, instead of assuming `app()->getLocale()` matches Lunar's configured default.
|
||||
- **Shopify CSV export importer** (`Shopify\ShopifyExportImporter`), the first working source/type combination, verified end-to-end against a real 183-product/693-variant/332-image Shopify export (row counts in the CSV match 1:1 with imported Products/Variants/Media):
|
||||
- `ShopifyCsvReader` + `ProductGroup` group Shopify's flat, repeated-handle CSV rows into one row-group per product (product row, variant rows, image rows).
|
||||
- Ten resolvers under `Shopify\Resolvers`, each responsible for idempotently resolving-or-creating one Lunar entity: `TaxClassResolver`, `ProductTypeResolver` (auto-attaches system attributes to new types), `BrandResolver`, `TagResolver`, `CollectionResolver` (multi-level, multi-collection support via `>`-delimited breadcrumbs), `ProductOptionResolver` (dedupes options/values by slugified name so case variants like "Size"/"size" resolve to one row), `AssetResolver` (Spatie MediaLibrary via `Product::addMedia()`, matches local export images by UUID first, filename fallback), `PriceResolver` (minor-unit conversion per currency), `ImportAttributeResolver` and `ProductAttributeResolver` (custom `cost_per_item`/`seo_title`/`seo_description` attributes, field-type-aware `attribute_data` writing).
|
||||
- `docs/shopify-import.md` — full CSV-to-Lunar field mapping reference and import design notes.
|
||||
- `docs/lunar.md` — new "Gotchas" section documenting non-obvious Lunar behavior hit while building the importer (table-prefix/nested-set race, required `ProductOption.handle`, per-group `Attribute.position`, etc.).
|
||||
- `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.
|
||||
|
||||
## [0.0.1] - 2026-07-03
|
||||
|
||||
First release.
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
# Contributing to boboko-core
|
||||
|
||||
This is a Composer library, not a runnable app — you can't `php artisan serve` it directly. To develop and verify changes, you need a consumer app wired to a local checkout via a Composer path repository, plus a real database, since a large part of this package (Lunar models, migrations, Filament panel resources) can only be meaningfully verified against a live Lunar install.
|
||||
|
||||
## Local dev setup
|
||||
|
||||
This works against any consumer app that follows the same convention — `boboko-test`, `boboko-starter`, `boboko-3dealer`, etc. — checked out next to this repo:
|
||||
|
||||
```
|
||||
RadicalElements/
|
||||
├── boboko-core/ (this repo)
|
||||
└── boboko-test/ (or boboko-starter, boboko-3dealer, ... — consumer app, Docker-based)
|
||||
```
|
||||
|
||||
Each of these consumer apps ships a `bin/dc-core.sh` helper that wraps the Docker Compose overlay needed to bind-mount a local `boboko-core` checkout into the app container:
|
||||
|
||||
```bash
|
||||
./bin/dc-core.sh exec app <command>
|
||||
```
|
||||
|
||||
This is shorthand for `docker compose -f docker-compose.dev.yml -f docker-compose.core-dev.yml exec app <command>`. Use `./bin/dc-core.sh` for everything below instead of typing the full compose invocation.
|
||||
|
||||
1. **Path repository.** In the consumer app's `composer.json`, the `repositories` array needs a path entry pointing at `../boboko-core`. If it only exists in a disabled block (e.g. `_repositories`), move it into the live array.
|
||||
2. **Relaxed version constraint.** The consumer app's `composer.json` should require `"boboko/core": "0.*"` (not a tight `^0.0.1` caret) — otherwise Composer rejects newer `0.0.x` versions resolved from the path repo.
|
||||
3. **Bind mount.** The consumer app's `docker-compose.core-dev.yml` overlays `../boboko-core` into the container at `/var/www/boboko-core`, matching where the path repo resolves it relative to `/var/www/html`.
|
||||
4. **Re-resolve after every change.** Composer's path repo does not hot-reload — after editing anything in `boboko-core` (including adding new files, which need autoload discovery), the container needs to re-run `composer update boboko/core`. In `boboko-test`, the entrypoint does this automatically on every dev boot (see `docker/entrypoint.sh`), so `./bin/dc-core.sh up` alone picks up local core changes. If a consumer app's entrypoint doesn't do this yet, run it manually:
|
||||
|
||||
```bash
|
||||
./bin/dc-core.sh exec app composer update boboko/core --with-all-dependencies
|
||||
```
|
||||
|
||||
Skipping this step is the most common cause of "my change isn't showing up."
|
||||
|
||||
## Verifying changes against a real database
|
||||
|
||||
There is no automated test suite for this package — too much of Lunar's behavior (table prefixing, nested sets, translatable attributes, Filament panel filters) only breaks in combination, against real Postgres, in a way that's impractical to fake in isolation. Instead, verify changes directly against a consumer app's live database. The practical workflow used throughout this package's `MigrateImport` feature:
|
||||
|
||||
**One-off checks**, via `php artisan tinker --execute="..."` in the consumer app's container:
|
||||
|
||||
```bash
|
||||
./bin/dc-core.sh exec app php artisan tinker --execute="
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\ProductTypeResolver;
|
||||
\$type = (new ProductTypeResolver())->resolve('Test Type');
|
||||
echo \$type->name . PHP_EOL;
|
||||
"
|
||||
```
|
||||
|
||||
**Multi-step scripts** (creating related records, checking round-trips), via a raw PHP script bootstrapped like an Artisan command — this avoids tinker's persistent-session quirks and more closely matches how code actually runs in a queued job:
|
||||
|
||||
```bash
|
||||
./bin/dc-core.sh exec app php -r "
|
||||
require 'vendor/autoload.php';
|
||||
\$app = require 'bootstrap/app.php';
|
||||
\$kernel = \$app->make(Illuminate\Contracts\Console\Kernel::class);
|
||||
\$kernel->bootstrap();
|
||||
|
||||
// ... your verification code ...
|
||||
"
|
||||
```
|
||||
|
||||
**Always clean up fixtures** created this way — either via `DB::statement('DELETE FROM ...')` in the same script (respecting foreign key order — Lunar has cascading relations like `lunar_customer_group_product` that block naive deletes), or leave them if they're harmless and the DB is a disposable dev/test instance.
|
||||
|
||||
Non-obvious Lunar bugs/traps hit while building against it are documented in [docs/lunar.md](docs/lunar.md#gotchas), not here — check there before debugging something that looks like a Lunar quirk.
|
||||
|
||||
## Code organization
|
||||
|
||||
Feature work lives under `src/<Feature>/`, with models in a `Models/` subdirectory (see `src/Auth/Models`, `src/Customer/Models`, `src/MigrateImport/Models`). Source-specific importer logic is grouped by source name (e.g. `src/MigrateImport/Shopify/`), with resolver classes (one responsibility each — resolve-or-create a single Lunar entity) grouped further under `Resolvers/`.
|
||||
+12
-4
@@ -2,7 +2,7 @@
|
||||
"name": "boboko/core",
|
||||
"description": "Core module — authentication and shared panel behaviour",
|
||||
"type": "library",
|
||||
"version": "0.0.1",
|
||||
"version": "0.6.0",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Modules\\Core\\": "src/"
|
||||
@@ -13,7 +13,11 @@
|
||||
"lunarphp/lunar": "1.3.0",
|
||||
"laravel/framework": "^12.0",
|
||||
"laravel/tinker": "^3.0",
|
||||
"symfony/yaml": "^7.0"
|
||||
"symfony/yaml": "^7.0",
|
||||
"lunarphp/table-rate-shipping": "^1.3",
|
||||
"lunarphp/search": "*",
|
||||
"lunarphp/meilisearch": "*",
|
||||
"spatie/laravel-translation-loader": "^2.8"
|
||||
},
|
||||
"require-dev": {
|
||||
"fakerphp/faker": "^1.23",
|
||||
@@ -30,13 +34,17 @@
|
||||
"providers": [
|
||||
"Modules\\Core\\Providers\\CoreServiceProvider",
|
||||
"Modules\\Core\\Providers\\AuthServiceProvider",
|
||||
"Modules\\Core\\Providers\\CustomerServiceProvider"
|
||||
"Modules\\Core\\Providers\\CustomerServiceProvider",
|
||||
"Modules\\Core\\Providers\\LocalizationServiceProvider",
|
||||
"Modules\\Core\\Providers\\ProductServiceProvider",
|
||||
"Modules\\Core\\Providers\\ReviewServiceProvider"
|
||||
]
|
||||
}
|
||||
},
|
||||
"config": {
|
||||
"allow-plugins": {
|
||||
"pestphp/pest-plugin": true
|
||||
"pestphp/pest-plugin": true,
|
||||
"php-http/discovery": true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,4 +16,23 @@ return [
|
||||
|
||||
'auto_create_customer_for_user' => true,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Product Option Types
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Enabled `Modules\Core\Product\Contracts\ProductOptionTypeInterface`
|
||||
| implementations, describing what structured data a ProductOption's
|
||||
| values carry in their `meta` jsonb column, and how an admin edits it.
|
||||
| An admin picks one per ProductOption from a dropdown built from this
|
||||
| list (stored in ProductOption::meta, not tied to the option's handle) —
|
||||
| a ProductOption with none selected has no described meta behavior,
|
||||
| plain name/position only.
|
||||
|
|
||||
| \App\ProductOptions\ColorOptionType::class,
|
||||
|
|
||||
*/
|
||||
|
||||
'product_option_types' => [],
|
||||
|
||||
];
|
||||
|
||||
@@ -0,0 +1,210 @@
|
||||
<?php
|
||||
|
||||
return [
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Default Search Engine
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| This option controls the default search connection that gets used while
|
||||
| using Laravel Scout. This connection is used when syncing all models
|
||||
| to the search service. You should adjust this based on your needs.
|
||||
|
|
||||
| Supported: "algolia", "meilisearch", "typesense",
|
||||
| "database", "collection", "null"
|
||||
|
|
||||
*/
|
||||
|
||||
'driver' => env('SCOUT_DRIVER', 'collection'),
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Index Prefix
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Here you may specify a prefix that will be applied to all search index
|
||||
| names used by Scout. This prefix may be useful if you have multiple
|
||||
| "tenants" or applications sharing the same search infrastructure.
|
||||
|
|
||||
*/
|
||||
|
||||
'prefix' => env('SCOUT_PREFIX', ''),
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Queue Data Syncing
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| This option allows you to control if the operations that sync your data
|
||||
| with your search engines are queued. When this is set to "true" then
|
||||
| all automatic data syncing will get queued for better performance.
|
||||
|
|
||||
*/
|
||||
|
||||
'queue' => env('SCOUT_QUEUE', false),
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Database Transactions
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| This configuration option determines if your data will only be synced
|
||||
| with your search indexes after every open database transaction has
|
||||
| been committed, thus preventing any discarded data from syncing.
|
||||
|
|
||||
*/
|
||||
|
||||
'after_commit' => false,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Chunk Sizes
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| These options allow you to control the maximum chunk size when you are
|
||||
| mass importing data into the search engine. This allows you to fine
|
||||
| tune each of these chunk sizes based on the power of the servers.
|
||||
|
|
||||
*/
|
||||
|
||||
'chunk' => [
|
||||
'searchable' => 500,
|
||||
'unsearchable' => 500,
|
||||
],
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Soft Deletes
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| This option allows to control whether to keep soft deleted records in
|
||||
| the search indexes. Maintaining soft deleted records can be useful
|
||||
| if your application still needs to search for the records later.
|
||||
|
|
||||
*/
|
||||
|
||||
'soft_delete' => false,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Identify User
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| This option allows you to control whether to notify the search engine
|
||||
| of the user performing the search. This is sometimes useful if the
|
||||
| engine supports any analytics based on this application's users.
|
||||
|
|
||||
| Supported engines: "algolia"
|
||||
|
|
||||
*/
|
||||
|
||||
'identify' => env('SCOUT_IDENTIFY', false),
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Algolia Configuration
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Here you may configure your Algolia settings. Algolia is a cloud hosted
|
||||
| search engine which works great with Scout out of the box. Just plug
|
||||
| in your application ID and admin API key to get started searching.
|
||||
|
|
||||
*/
|
||||
|
||||
'algolia' => [
|
||||
'id' => env('ALGOLIA_APP_ID', ''),
|
||||
'secret' => env('ALGOLIA_SECRET', ''),
|
||||
'index-settings' => [
|
||||
// 'users' => [
|
||||
// 'searchableAttributes' => ['id', 'name', 'email'],
|
||||
// 'attributesForFaceting'=> ['filterOnly(email)'],
|
||||
// ],
|
||||
],
|
||||
],
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Meilisearch Configuration
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Here you may configure your Meilisearch settings. Meilisearch is an open
|
||||
| source search engine with minimal configuration. Below, you can state
|
||||
| the host and key information for your own Meilisearch installation.
|
||||
|
|
||||
| See: https://www.meilisearch.com/docs/learn/configuration/instance_options#all-instance-options
|
||||
|
|
||||
*/
|
||||
|
||||
'meilisearch' => [
|
||||
'host' => env('MEILISEARCH_HOST', 'http://localhost:7700'),
|
||||
'key' => env('MEILISEARCH_KEY'),
|
||||
'index-settings' => [
|
||||
// 'users' => [
|
||||
// 'filterableAttributes'=> ['id', 'name', 'email'],
|
||||
// ],
|
||||
],
|
||||
],
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Typesense Configuration
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Here you may configure your Typesense settings. Typesense is an open
|
||||
| source search engine using minimal configuration. Below, you will
|
||||
| state the host, key, and schema configuration for the instance.
|
||||
|
|
||||
*/
|
||||
|
||||
'typesense' => [
|
||||
'client-settings' => [
|
||||
'api_key' => env('TYPESENSE_API_KEY', 'xyz'),
|
||||
'nodes' => [
|
||||
[
|
||||
'host' => env('TYPESENSE_HOST', 'localhost'),
|
||||
'port' => env('TYPESENSE_PORT', '8108'),
|
||||
'path' => env('TYPESENSE_PATH', ''),
|
||||
'protocol' => env('TYPESENSE_PROTOCOL', 'http'),
|
||||
],
|
||||
],
|
||||
'nearest_node' => [
|
||||
'host' => env('TYPESENSE_HOST', 'localhost'),
|
||||
'port' => env('TYPESENSE_PORT', '8108'),
|
||||
'path' => env('TYPESENSE_PATH', ''),
|
||||
'protocol' => env('TYPESENSE_PROTOCOL', 'http'),
|
||||
],
|
||||
'connection_timeout_seconds' => env('TYPESENSE_CONNECTION_TIMEOUT_SECONDS', 2),
|
||||
'healthcheck_interval_seconds' => env('TYPESENSE_HEALTHCHECK_INTERVAL_SECONDS', 30),
|
||||
'num_retries' => env('TYPESENSE_NUM_RETRIES', 3),
|
||||
'retry_interval_seconds' => env('TYPESENSE_RETRY_INTERVAL_SECONDS', 1),
|
||||
],
|
||||
// 'max_total_results' => env('TYPESENSE_MAX_TOTAL_RESULTS', 1000),
|
||||
'model-settings' => [
|
||||
// User::class => [
|
||||
// 'collection-schema' => [
|
||||
// 'fields' => [
|
||||
// [
|
||||
// 'name' => 'id',
|
||||
// 'type' => 'string',
|
||||
// ],
|
||||
// [
|
||||
// 'name' => 'name',
|
||||
// 'type' => 'string',
|
||||
// ],
|
||||
// [
|
||||
// 'name' => 'created_at',
|
||||
// 'type' => 'int64',
|
||||
// ],
|
||||
// ],
|
||||
// 'default_sorting_field' => 'created_at',
|
||||
// ],
|
||||
// 'search-parameters' => [
|
||||
// 'query_by' => 'name'
|
||||
// ],
|
||||
// ],
|
||||
],
|
||||
'import_action' => env('TYPESENSE_IMPORT_ACTION', 'upsert'),
|
||||
],
|
||||
|
||||
];
|
||||
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
return new class extends Migration
|
||||
{
|
||||
public function up(): void
|
||||
{
|
||||
Schema::table('lunar_customers', function (Blueprint $table) {
|
||||
$table->string('otp_code', 6)->nullable()->after('meta');
|
||||
$table->timestamp('otp_expires_at')->nullable()->after('otp_code');
|
||||
});
|
||||
}
|
||||
|
||||
public function down(): void
|
||||
{
|
||||
Schema::table('lunar_customers', function (Blueprint $table) {
|
||||
$table->dropColumn(['otp_code', 'otp_expires_at']);
|
||||
});
|
||||
}
|
||||
};
|
||||
@@ -0,0 +1,27 @@
|
||||
<?php
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
return new class extends Migration
|
||||
{
|
||||
public function up(): void
|
||||
{
|
||||
Schema::create('import_mappings', function (Blueprint $table) {
|
||||
$table->id();
|
||||
$table->string('source');
|
||||
$table->string('source_type');
|
||||
$table->string('external_id');
|
||||
$table->morphs('model');
|
||||
$table->timestamps();
|
||||
|
||||
$table->unique(['source', 'source_type', 'external_id']);
|
||||
});
|
||||
}
|
||||
|
||||
public function down(): void
|
||||
{
|
||||
Schema::dropIfExists('import_mappings');
|
||||
}
|
||||
};
|
||||
@@ -0,0 +1,32 @@
|
||||
<?php
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
return new class extends Migration
|
||||
{
|
||||
public function up(): void
|
||||
{
|
||||
Schema::create('product_reviews', function (Blueprint $table) {
|
||||
$table->id();
|
||||
$table->foreignId('product_id')->constrained(config('lunar.database.table_prefix').'products');
|
||||
$table->string('title')->nullable();
|
||||
$table->text('body')->nullable();
|
||||
$table->unsignedTinyInteger('rating');
|
||||
$table->timestamp('reviewed_at')->nullable();
|
||||
$table->string('reviewer_name')->nullable();
|
||||
$table->string('reviewer_email')->nullable();
|
||||
$table->text('reply')->nullable();
|
||||
$table->timestamp('replied_at')->nullable();
|
||||
$table->string('location')->nullable();
|
||||
$table->string('source')->nullable();
|
||||
$table->timestamps();
|
||||
});
|
||||
}
|
||||
|
||||
public function down(): void
|
||||
{
|
||||
Schema::dropIfExists('product_reviews');
|
||||
}
|
||||
};
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
return new class extends Migration
|
||||
{
|
||||
/**
|
||||
* Run the migrations.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function up(): void
|
||||
{
|
||||
Schema::create('language_lines', function (Blueprint $table) {
|
||||
$table->id();
|
||||
$table->string('group')->index();
|
||||
$table->string('key');
|
||||
$table->json('text');
|
||||
$table->timestamps();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Reverse the migrations.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function down(): void
|
||||
{
|
||||
Schema::dropIfExists('language_lines');
|
||||
}
|
||||
};
|
||||
@@ -0,0 +1,260 @@
|
||||
# Localization
|
||||
|
||||
Storefront routes can be locale-prefixed (`/el/proionta`, `/en/products`) using a middleware
|
||||
that reads directly from Lunar's `languages` table — the same table the Filament **Languages**
|
||||
resource manages, so there's no separate locale config to keep in sync.
|
||||
|
||||
---
|
||||
|
||||
## Why prefix every locale, including the default
|
||||
|
||||
Leaving the default locale bare at the root (`/proionta` for Greek, `/en/products` for English)
|
||||
creates ambiguity: is `/` the language-neutral homepage or specifically the Greek version? It
|
||||
also complicates `hreflang` (needs a self-referencing tag on the root plus a possibly-duplicate
|
||||
`x-default`) and risks duplicate content if a bot or campaign link reaches the root without a
|
||||
language signal.
|
||||
|
||||
Prefixing every locale avoids this: every URL unambiguously declares its language, `hreflang`
|
||||
tags are symmetrical, and adding a locale later requires no URL restructuring.
|
||||
|
||||
---
|
||||
|
||||
## Opt-in, not global
|
||||
|
||||
The middleware is registered as a **named alias** (`locale`), not pushed onto the `web`
|
||||
middleware group. Apply it explicitly to the route group(s) that make up your storefront:
|
||||
|
||||
```php
|
||||
// routes/web.php
|
||||
use Illuminate\Support\Facades\Route;
|
||||
|
||||
Route::middleware('locale')->group(function () {
|
||||
Route::get('/{locale}', HomeController::class);
|
||||
Route::get('/{locale}/proionta', ProductIndexController::class);
|
||||
Route::get('/{locale}/proionta/{slug}', ProductShowController::class);
|
||||
});
|
||||
```
|
||||
|
||||
It is **not** applied automatically because storefront routes aren't the only routes living
|
||||
under `web` in a shop:
|
||||
|
||||
- The Filament admin panel (`/boboko*`, see `PanelServiceProvider`) has its own routing/auth
|
||||
concerns and must never be locale-redirected.
|
||||
- Livewire's internal update endpoint (`/livewire/update`) must resolve without a locale prefix.
|
||||
- Webhooks, health checks, and other non-storefront routes shouldn't be touched.
|
||||
|
||||
If a shop's entire `web.php` *is* the storefront, wrapping the whole file in the group above is
|
||||
fine — just keep admin/Livewire/webhook routes registered outside of it (as they already are).
|
||||
|
||||
---
|
||||
|
||||
## Behavior
|
||||
|
||||
`Modules\Core\Localization\Middleware\LocaleMiddleware`:
|
||||
|
||||
1. Reads the first path segment (`request()->segment(1)`).
|
||||
2. Matches it against `Lunar\Models\Language::code`.
|
||||
- **Match** — `App::setLocale($code)` is set, and `locale` / `language` request attributes
|
||||
are populated for controllers/views to use.
|
||||
- **No match** (missing, wrong, or unknown segment) — redirects to the same path prefixed
|
||||
with a resolved locale:
|
||||
- the best match from the `Accept-Language` header against available language codes, or
|
||||
- the language flagged `default` in the `languages` table, or
|
||||
- the first language row, as a last resort.
|
||||
|
||||
The language list is cached with `Cache::rememberForever()` under `core.localization.languages`
|
||||
and invalidated automatically. Adding, editing, or removing a language via the Filament
|
||||
**Languages** resource clears the cache immediately — no TTL, no stale reads.
|
||||
|
||||
### How invalidation is wired (event-driven, not the observer itself)
|
||||
|
||||
`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
|
||||
`code` — or `LanguageDeleted`), and two listeners, wired in
|
||||
`Modules\Core\Providers\LocalizationServiceProvider`, react:
|
||||
|
||||
- **`FlushLanguageCache`** — flushes `core.localization.languages` on all three events.
|
||||
- **`MigrateTranslationsForRenamedLanguage`** — `LanguageUpdated` only, and only when `code`
|
||||
actually changed. A renamed `Language::code` (e.g. `el` → `gr`) would otherwise strand every
|
||||
`LanguageLine`'s translated text under the old, now-unroutable key —
|
||||
`getTranslationsForGroup('gr', ...)` would silently return nothing for that locale even though
|
||||
the translated content still exists. This listener moves the `text.{oldCode}` key to
|
||||
`text.{newCode}` on every affected `LanguageLine` row and flushes both the old and new code's
|
||||
translation cache for every group touched.
|
||||
|
||||
Deleting a `Language` only flushes the language-list cache — `LanguageLine.text` keys for the
|
||||
deleted code are left in place rather than destructively erased, in case the language is ever
|
||||
re-added under the same code.
|
||||
|
||||
Splitting cache-flush and text-migration into separate listeners (rather than one
|
||||
`LanguageCacheObserver` method doing both) mirrors the same event → listener pattern used for
|
||||
`TranslationService`'s writes below — the observer only detects *what happened*, listeners own
|
||||
*what to do about it*.
|
||||
|
||||
---
|
||||
|
||||
## Reading the resolved locale/language downstream
|
||||
|
||||
```php
|
||||
// In a controller or view composer
|
||||
$locale = $request->attributes->get('locale'); // e.g. "el"
|
||||
$language = $request->attributes->get('language'); // Lunar\Models\Language instance
|
||||
```
|
||||
|
||||
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)
|
||||
<a href="{{ $altLocale['url'] }}" hreflang="{{ $altLocale['code'] }}">{{ $altLocale['name'] }}</a>
|
||||
@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
|
||||
|
||||
If a shop has only one row in `languages`, the middleware still enforces the prefix (e.g. every
|
||||
URL under `/en/...`) rather than special-casing it away — this keeps behavior identical across
|
||||
shops and avoids a silent restructuring if a second language is added later. If a shop genuinely
|
||||
never wants locale prefixes, don't apply the `locale` middleware to its routes at all.
|
||||
|
||||
---
|
||||
|
||||
## Storefront UI labels (`__('storefront.*')`)
|
||||
|
||||
The `locale` middleware resolves *which* language a request is in — routing/redirects,
|
||||
`Lunar\Models\Language`, and Lunar's own translatable product/collection content. It has nothing
|
||||
to do with static UI chrome like "Cart", "Back", "Add to Cart". Those are handled separately by
|
||||
[`spatie/laravel-translation-loader`](https://github.com/spatie/laravel-translation-loader),
|
||||
stored in the `language_lines` table.
|
||||
|
||||
### Why a separate system, not another `languages`-table lookup
|
||||
|
||||
Lunar's translatable fields (`TranslatedText`, `Url`, etc.) are all tied to specific *model
|
||||
records* — a product's name, a collection's description. UI labels aren't attached to any model;
|
||||
they're static strings the app itself owns. `laravel-translation-loader` is Laravel's own
|
||||
`__()`/`trans()` mechanism with a DB-backed source layered on top of the normal file-based one —
|
||||
no new helper to learn, no bespoke table shape.
|
||||
|
||||
**Nothing existing breaks.** The package's `TranslationLoaderManager` *extends* Laravel's
|
||||
`FileLoader` and merges DB translations on top of file-based ones
|
||||
(`array_replace_recursive()`) — Filament's own vendor `lang/en/product.php`-style strings
|
||||
keep working exactly as before. The package registers itself via Laravel's standard Composer
|
||||
package auto-discovery (`extra.laravel.providers` in its own `composer.json`) — nothing needed
|
||||
in `CoreServiceProvider` to wire it up.
|
||||
|
||||
### Usage
|
||||
|
||||
```blade
|
||||
{{ __('storefront.nav.cart') }}
|
||||
{{ __('storefront.product.add_to_cart') }}
|
||||
```
|
||||
|
||||
`group` is `storefront` for e-shop UI labels — kept separate from Lunar/Filament's own `lunar::`
|
||||
namespaced groups so nothing collides. `__()` resolves the translation for whatever
|
||||
`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.
|
||||
|
||||
### Admin UI
|
||||
|
||||
`Modules\Core\Localization\Filament\Resources\LanguageLineResource` (registered in
|
||||
`CorePlugin`, under the panel's Settings group) lists/searches/filters `language_lines` and
|
||||
edits each row's `group`, `key`, and one text input per row currently in `lunar_languages` —
|
||||
the locale columns are generated dynamically from `Language::query()->pluck('code')`, so adding
|
||||
a third language automatically adds a third input, no resource changes needed.
|
||||
|
||||
### `TranslationService` — writes go through here, not the model directly
|
||||
|
||||
`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\Services\TranslationService;
|
||||
|
||||
app(TranslationService::class)->create('storefront', 'nav.wishlist', [
|
||||
'en' => 'Wishlist',
|
||||
'el' => 'Λίστα Επιθυμιών',
|
||||
]);
|
||||
|
||||
app(TranslationService::class)->update(
|
||||
$languageLine,
|
||||
'storefront',
|
||||
'nav.wishlist',
|
||||
['en' => 'Wishlist ♥', 'el' => 'Λίστα Επιθυμιών ♥'],
|
||||
);
|
||||
|
||||
app(TranslationService::class)->delete($languageLine);
|
||||
```
|
||||
|
||||
`update()` takes the full `group`/`key`/`text` state, not just `text` — a rename is a normal
|
||||
update, not a special case. `TranslationCreated`, `TranslationUpdated` (carries the full
|
||||
`{group, key, text}` snapshot from *before* the update, so a listener can tell a rename from a
|
||||
text edit), and `TranslationDeleted` are dispatched from `Modules\Core\Localization\Events`. Two
|
||||
listeners are wired in `Modules\Core\Providers\LocalizationServiceProvider` for all three events:
|
||||
|
||||
- **`FlushTranslationCache`** — `LanguageLine::boot()` already flushes the cache for the
|
||||
*current* group's locales present after a save, but misses two cases on update: locales a save
|
||||
*removed* from `text` (e.g. dropping the `el` key leaves `storefront.el` stale), and a changed
|
||||
`group`/`key` (the *old* group's cached array is never told a row left it). This listener
|
||||
flushes every group+locale combination touched by either the old or new state, so nothing —
|
||||
including the group a row was renamed away from — can remain stale.
|
||||
- **`LogTranslationActivity`** — records the change via `Modules\Core\Logging\ActivityLogService`
|
||||
on the `lunar` activity log channel, same `created`/`updated`/`deleted` shape as every other
|
||||
domain write in this project. A rename shows up in the log as an `old`/`attributes` diff across
|
||||
`group`, `key`, and `text` together, not just a text diff.
|
||||
|
||||
The Filament resource's Create/Edit/Delete pages route through `TranslationService` (via
|
||||
`handleRecordCreation`/`handleRecordUpdate`/the delete action's `->action()` override) rather
|
||||
than Filament's default direct-model calls, so **every** edit made in the admin UI — including a
|
||||
bare `group`/`key` rename with no `text` change — dispatches `TranslationUpdated` and is both
|
||||
cache-invalidated and audit-logged.
|
||||
@@ -1191,3 +1191,21 @@ php artisan vendor:publish --tag=lunar.migrations # publish migrations
|
||||
php artisan scout:import "Lunar\Models\Product" # index products
|
||||
php artisan scout:flush "Lunar\Models\Order" # flush order index
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Gotchas
|
||||
|
||||
Real bugs/traps hit while building against Lunar in this package — not obvious from reading Lunar's source in isolation.
|
||||
|
||||
- **`Lunar\Base\BaseModel` prefixes table names at construction time.** Mass-assigning a `parent_id` on a model using `kalnoy/nestedset`'s `NodeTrait` (e.g. `Collection`) triggers a mutator that queries the database *before* the table prefix is applied, throwing "relation does not exist". Use `appendToNode()`/`saveAsRoot()` instead of setting `parent_id` directly. See `MigrateImport\Shopify\Resolvers\CollectionResolver` for the pattern.
|
||||
- **Don't trust a schema read from memory — re-check the actual migration/model file.** `products.brand` was assumed to be a plain string column based on an earlier read; it's actually `brand_id`, a real FK to a `Brand` model. Verify column names against the live `Schema::getColumnListing()` or the actual migration file, not recollection.
|
||||
- **Lunar's default `Language` may not be `en`.** Don't hardcode `app()->getLocale()` for `TranslatedText`/translatable fields — use `Lunar\Models\Language::getDefault()->code` (wrapped here as `MigrateImport\DefaultLocale::code()`). A mismatch means data saves under the wrong locale key and silently doesn't render in the panel.
|
||||
- **`attribute_data` is not a free-form array.** Values must be `Lunar\Base\FieldType` instances (`Text`, `TranslatedText`, `Number`, etc.), and the handle must be mapped to the product's `ProductType` via `mappedAttributes()`/`productAttributes()` — otherwise the value is silently dropped or won't render in the panel.
|
||||
- **New `ProductType`s start with zero mapped attributes.** Creating one via `ProductType::create()` alone means `name`/`description` won't work until you `attach()` the existing system attributes to it.
|
||||
- **`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\Product\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\Product\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.
|
||||
|
||||
@@ -0,0 +1,206 @@
|
||||
# Product Listing
|
||||
|
||||
`Modules\Core\Product\Services\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.
|
||||
|
||||
This is separate from `Modules\Core\Product\Services\ProductSearchService` (see `product-search.md`), which
|
||||
handles free-text query search. `ProductService` is for browsing/lookup without a search term.
|
||||
|
||||
---
|
||||
|
||||
## Why it reads from the index, not the database
|
||||
|
||||
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\Product\Services\ProductIndexer` is built to
|
||||
carry that full shape.
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
```php
|
||||
use Modules\Core\Product\DTOs\ProductFilters;
|
||||
use Modules\Core\Product\Services\ProductService;
|
||||
use Modules\Core\Product\Enums\ProductSort;
|
||||
|
||||
$service = app(ProductService::class);
|
||||
|
||||
// List everything, paginated — returns 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 = $service->list(perPage: 24, page: 1);
|
||||
|
||||
// Filter by collection, brand, and/or price range
|
||||
$products = $service->list(
|
||||
filters: new ProductFilters(collectionId: 17, minPrice: 10.0, maxPrice: 50.0),
|
||||
perPage: 24,
|
||||
page: 1,
|
||||
);
|
||||
|
||||
// Sort — cheapest/priciest first, or newest first. Omit for Meilisearch's default
|
||||
// relevance ordering (irrelevant here since the query is always empty).
|
||||
$products = $service->list(perPage: 24, page: 1, sort: ProductSort::PriceAsc);
|
||||
|
||||
$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
|
||||
|
||||
// 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
|
||||
```
|
||||
|
||||
All `ProductFilters` fields are optional; only the ones set are added to the Meilisearch query.
|
||||
|
||||
---
|
||||
|
||||
## Fields this depends on: `Modules\Core\Product\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\Product\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. |
|
||||
| `slugs` | `$product->urls->pluck('slug')` | Filterable. Every locale's `Url::slug` for the product, so `getBySlug()` resolves purely from the index — no database read. |
|
||||
| `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. |
|
||||
|
||||
`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
|
||||
`attribute_data` — Lunar's `translateAttribute('name')` silently returns `null` for them. The
|
||||
indexer's `translatedName()` reads the array directly instead. See `docs/lunar.md` "Gotchas".
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
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.
|
||||
`Modules\Core\Providers\ReviewServiceProvider` listens on `ProductReview`'s `created`/`updated`/
|
||||
`deleted` events and calls `$review->product->searchable()`, so the parent product's document
|
||||
stays current without waiting for the next full reindex. This provider must be registered in
|
||||
`composer.json`'s `extra.laravel.providers` (already done in this repo) — see `docs/modules.md`
|
||||
"Provider Registration Pitfalls" for what happens if a provider like this is ever added but not
|
||||
registered.
|
||||
|
||||
---
|
||||
|
||||
## Multi-variant products and price
|
||||
|
||||
A product's `price` is its *cheapest* variant's price ("from €19.99" style), not every variant's
|
||||
price. A price-range filter matches based on that single minimum — a product with one cheap
|
||||
variant and several expensive ones will match a low-price-range filter even though most of its
|
||||
variants don't.
|
||||
|
||||
---
|
||||
|
||||
## Sorting
|
||||
|
||||
`ProductSort` (`Modules\Core\Product\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\Product\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\Product\Services\ProductIndexer::class,
|
||||
// ...other model indexers unchanged
|
||||
],
|
||||
```
|
||||
|
||||
## Re-syncing after this change
|
||||
|
||||
Filterable attributes are Meilisearch index settings, not computed per-query — changing them
|
||||
requires re-syncing settings and reindexing existing documents:
|
||||
|
||||
```bash
|
||||
php artisan lunar:meilisearch:setup
|
||||
php artisan lunar:search:index "Lunar\Models\Product" --refresh
|
||||
```
|
||||
|
||||
**If `SCOUT_QUEUE=true`, restart the queue worker after deploying an indexer change.** A running
|
||||
`queue:work` process loads PHP classes once at boot and keeps that code in memory for its entire
|
||||
lifetime — it does not pick up an edited/newly-deployed indexer class. Symptoms: reindexing
|
||||
commands succeed with no errors, `Product::toSearchableArray()` returns the new fields correctly
|
||||
when called directly (e.g. via `artisan tinker`, which always boots fresh), but documents written
|
||||
via `$model->searchable()` through the live queue are still missing the new fields. Restarting the
|
||||
queue worker (`docker compose restart queue`, or equivalent) resolves it — no code change needed.
|
||||
|
||||
---
|
||||
|
||||
## Meilisearch driver quirk: `paginateRaw()`'s `items()` is not a list of hits
|
||||
|
||||
For the Meilisearch engine specifically, Scout's `Builder::paginateRaw()` puts the **entire raw
|
||||
response** (`hits`, `query`, `processingTimeMs`, `hitsPerPage`, `page`, `totalPages`, `totalHits`)
|
||||
into the paginator's `items()`, not a plain array of documents. Calling `$paginator->items()`
|
||||
and treating it as a list (e.g. `collect($paginator->items())->values()`) silently produces a
|
||||
7-element array whose first element happens to be the real hits and the rest are stray scalars
|
||||
from the other response keys — no error, just wrong data leaking into what looks like a normal
|
||||
list. `ProductService::list()` pulls `$paginator->items()['hits']` explicitly to avoid this;
|
||||
`$paginator->total()`/`perPage()`/`currentPage()`/`lastPage()` are unaffected and safe to use
|
||||
as-is.
|
||||
@@ -0,0 +1,105 @@
|
||||
# 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\Product\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 enables a type class in `config/core.php`:
|
||||
|
||||
```php
|
||||
// config/core.php
|
||||
'product_option_types' => [
|
||||
\App\ProductOptions\ColorOptionType::class,
|
||||
],
|
||||
```
|
||||
|
||||
This is a plain list, **not** keyed by `ProductOption::handle` — a shop's own handle
|
||||
naming (transliterated Greek, legacy import slugs, whatever an admin happened to type
|
||||
when creating the option) shouldn't have to match a type's key. 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']`, not inferred
|
||||
from anything else.
|
||||
|
||||
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\Product\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\Product\OptionTypes\ColorOptionType`
|
||||
— not auto-registered, since registration is always an explicit shop decision.
|
||||
|
||||
---
|
||||
|
||||
## How it's wired into the admin UI
|
||||
|
||||
`Modules\Core\Product\Services\ProductOptionTypeManager`:
|
||||
- `all(): Collection<string, ProductOptionTypeInterface>` — every enabled type,
|
||||
keyed by `getKey()`.
|
||||
- `resolve(?string $key): ?ProductOptionTypeInterface` — looks up one by key (or
|
||||
`null` if no key / not found).
|
||||
|
||||
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\Product\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\Product\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.
|
||||
@@ -0,0 +1,81 @@
|
||||
# Product Search
|
||||
|
||||
`Modules\Core\Product\Services\ProductSearchService` provides locale-aware full-text product search on
|
||||
top of Laravel Scout + Meilisearch.
|
||||
|
||||
---
|
||||
|
||||
## Why locale-aware search isn't a filter
|
||||
|
||||
Lunar's Meilisearch indexer (`Lunar\Search\ScoutIndexer::mapSearchableAttributes()`) flattens
|
||||
every translated attribute into **locale-suffixed fields on a single document** — a product with
|
||||
a translated `name` produces `name_en`, `name_el`, etc. as separate top-level fields, not
|
||||
separate documents per locale and not a filterable `locale` field.
|
||||
|
||||
That means "search in Greek" isn't a `->filter('locale = el')` — Meilisearch has no such field to
|
||||
filter on. It's a choice of **which fields the query targets**: `name_el`/`description_el`
|
||||
instead of `name_en`/`description_en`. This is what Meilisearch's `attributesToSearchOn` search
|
||||
parameter controls, exposed through Scout via `Builder::options()`, which passes straight through
|
||||
to the underlying Meilisearch client call (`Laravel\Scout\Engines\MeilisearchEngine::performSearch()`
|
||||
merges `$builder->options` directly into the search request).
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
```php
|
||||
use Modules\Core\Product\Services\ProductSearchService;
|
||||
|
||||
$results = app(ProductSearchService::class)->search('running shoes');
|
||||
// or an explicit locale, bypassing App::getLocale():
|
||||
$results = app(ProductSearchService::class)->search('running shoes', 'el');
|
||||
```
|
||||
|
||||
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\Middleware\LocaleMiddleware` (see `localization.md`), so callers in controllers
|
||||
don't need to pass it explicitly.
|
||||
|
||||
---
|
||||
|
||||
## Missing-translation fallback
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Field list is dynamic, not hardcoded
|
||||
|
||||
The set of attribute handles searched (`name`, `description`, or whatever else) comes from
|
||||
`Lunar\Facades\AttributeManifest::getSearchableAttributes(Product::morphName())` — the same
|
||||
source `ScoutIndexer` itself uses to decide what gets indexed. If an admin marks a new attribute
|
||||
searchable in the panel, `ProductSearchService` picks it up automatically; nothing in this class
|
||||
needs to change.
|
||||
|
||||
---
|
||||
|
||||
## Re-syncing after indexer changes
|
||||
|
||||
Changing which attributes are searchable, or `ProductIndexer`'s filterable/sortable fields,
|
||||
requires re-syncing Meilisearch's index settings and re-indexing existing documents:
|
||||
|
||||
```bash
|
||||
php artisan lunar:meilisearch:setup
|
||||
php artisan lunar:search:index "Lunar\Models\Product" --refresh
|
||||
```
|
||||
|
||||
`ProductSearchService` itself needs no re-sync when locales change — `attributesToSearchOn` is
|
||||
computed per-query from the live language list, not baked into index settings.
|
||||
@@ -0,0 +1,150 @@
|
||||
# Shopify → Lunar product import
|
||||
|
||||
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`.
|
||||
|
||||
## 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.
|
||||
|
||||
**Solution: a dedicated `import_mappings` table**, not columns on Lunar's core tables.
|
||||
|
||||
```php
|
||||
Schema::create($this->prefix.'import_mappings', function (Blueprint $table) {
|
||||
$table->id();
|
||||
$table->string('source'); // 'shopify'
|
||||
$table->string('source_type'); // 'product', 'variant', 'image', 'collection', 'tag'
|
||||
$table->string('external_id'); // Shopify handle, or handle+position for variants/images
|
||||
$table->morphs('model'); // model_type + model_id -> Product, ProductVariant, Asset, Collection, Tag
|
||||
$table->timestamps();
|
||||
|
||||
$table->unique(['source', 'source_type', 'external_id']);
|
||||
});
|
||||
```
|
||||
|
||||
Every resolver looks up `import_mappings` by `(source, source_type, external_id)` first — update if found, create + insert mapping row if not.
|
||||
|
||||
## CSV shape
|
||||
|
||||
Shopify's export is flat: one row per (product × variant × extra image), with `Handle` repeated across all rows belonging to the same product. Only the first row per handle carries `Title`/`Body (HTML)`/`Vendor`/etc — later rows are variant-only or pure image rows (no `Option1 Value` at all).
|
||||
|
||||
The importer must first group consecutive CSV rows by `Handle` into `{ handle, productFields, variants: [...], images: [...] }` before touching Lunar.
|
||||
|
||||
## Field mapping: CSV → Lunar
|
||||
|
||||
| CSV column | Lunar equivalent | Notes |
|
||||
|---|---|---|
|
||||
| `Title`, `Body (HTML)` | `products.attribute_data` (JSON, translatable) | goes into attribute_data, not a flat column |
|
||||
| `Vendor` | `products.brand` (plain string column) | direct passthrough |
|
||||
| `Product Category` | `Collection` (nested set) inside a `CollectionGroup` | Google-taxonomy breadcrumb (e.g. `Toys & Games > Toys > Bath Toys`) — parse into a nested Collection chain, product attached to the deepest node. See "Collections" below. |
|
||||
| `Type` | `product_type_id` (required FK) | must resolve/create a `ProductType`; needs a default fallback (e.g. "General") |
|
||||
| `Tags` | `Tag` model (separate, not built into Product) | split CSV string, find/create, attach |
|
||||
| `Published` / `Status` | `products.status` (plain string, indexed) | direct mapping |
|
||||
| `Option1/2/3 Name+Value` | `product_options` + `product_option_values` + variant pivot | find/create option (by name), find/create value (by option+value), attach to variant |
|
||||
| `Variant SKU` | `product_variants.sku` | direct |
|
||||
| `Variant Grams` | `product_variants` dimensions (`$table->dimensions()`) | needs unit conversion check — macro likely adds `weight_value`/`weight_unit`, not raw grams |
|
||||
| `Variant Inventory Qty` | `product_variants.stock` | direct |
|
||||
| `Variant Price` / `Compare At Price` | `prices` table (polymorphic `priceable`, per-currency, per-customer-group) | **not a variant column** — create a `Price` row per variant per currency |
|
||||
| `Cost per item` | *(nothing)* | Lunar has no cost-price field — stash in `attribute_data` as a custom attribute, in scope for v1 |
|
||||
| `Variant Barcode` | closest is `gtin`/`ean` on variant | ambiguous, needs a mapping rule |
|
||||
| `Variant Requires Shipping` | `product_variants.shippable` (boolean) | direct |
|
||||
| `Variant Taxable` | `tax_class_id` (required FK, not boolean) | must resolve to an actual `TaxClass` row (e.g. "Standard" vs "None") |
|
||||
| `Image Src` (+ image-only rows) | `Asset` model + Spatie MediaLibrary, ordered via `media_product_variant` pivot (`position`) | see "Images" below — file is local, not a URL to download |
|
||||
| `SEO Title` / `SEO Description` | *(nothing structured)* | stash in `attribute_data` as custom attributes, in scope for v1 |
|
||||
| Metafield columns (see below) | *(nothing)* | **all empty across every row in the sample export — skip entirely** |
|
||||
| `Handle` | `Url` model (`urls` table, polymorphic, per-language slug) | create a `Url` row per product (slug = handle), not a plain column |
|
||||
|
||||
## Collections — Lunar supports multiple collections per product
|
||||
|
||||
Lunar's `collection_product` table is a plain many-to-many pivot (`collection_id`, `product_id`, `position`) with no uniqueness constraint tying a product to a single collection. A `Product` can belong to any number of `Collection`s simultaneously, and `Collection`s themselves are a nested-set tree (`NodeTrait`, `_lft`/`_rgt`/`parent_id`) scoped inside a `CollectionGroup` (`collection_group_id`).
|
||||
|
||||
This matters for the importer in two ways:
|
||||
|
||||
- **The breadcrumb import doesn't have to be exclusive.** Attaching a product to `Toys & Games > Toys > Bath Toys > Rubber Duckies` doesn't prevent it from also being attached to a separately-curated collection (e.g. a manual "Best Sellers" collection) — no conflict, since it's a plain pivot.
|
||||
- **Resolve the breadcrumb into whichever `CollectionGroup` fits the target site's structure** — the known Shopify category tree can be parsed straight into it; no need for a separate import-only group unless you specifically want to isolate/purge imported collections independently later.
|
||||
- Only the **deepest node** of the breadcrumb needs the product attached directly — Lunar's nested-set ancestry (`getBreadcrumbAttribute()`) already exposes the full parent chain via `$collection->ancestors`, so there's no need to attach the product to every intermediate level.
|
||||
|
||||
Resolver logic: split `Product Category` on `>`, trim each segment, walk down creating/reusing `Collection` nodes as a chain (`parent_id` chained) within the fixed import `CollectionGroup`, then attach the product only to the final (leaf) `Collection` via `collection_product`.
|
||||
|
||||
## Images — the export includes a local files folder
|
||||
|
||||
The Shopify export isn't just the CSV — it also produces a folder of the actual image files, named by UUID (not by the original filename or `Image Src` URL). The `Image Src` column in the CSV is the *original* Shopify CDN URL, which is **not** how the file is named on disk in the export folder.
|
||||
|
||||
This changes the AssetResolver from an HTTP-download step to a local-file-lookup step:
|
||||
|
||||
- The importer needs a way to map each CSV `Image Src` row to its corresponding UUID-named file in the export folder — check whether the export also provides a manifest/mapping file, or whether the mapping has to be inferred from row order per `Handle` (i.e. Nth image row for a handle = Nth file in that handle's image set, if the export preserves ordering).
|
||||
- Once resolved, the local file is what gets added to the `Asset` + Spatie MediaLibrary (`addMedia($localPath)`), not a downloaded copy of the CDN URL — no HTTP client / retry / timeout handling needed for images, but a **file-existence check** is needed (missing/renamed file in the export folder should not silently fail the whole product import).
|
||||
- `import_mappings` for images should still key on something stable from the CSV (e.g. `Image Src` URL, or `handle + position`) rather than the UUID filename, since the UUID is regenerated on every fresh export and isn't a stable external ID across re-imports.
|
||||
|
||||
## Metafield columns — confirmed empty, skipped
|
||||
|
||||
These are Shopify's auto-generated category-specific metafields (populated once a product has a `Product Category` assigned). In the sample export they were empty for effectively every row (a few had `color-pattern`, `material`, or `target-gender` populated). **Decision: skip all of these for v1**, since none carry data worth preserving in this dataset.
|
||||
|
||||
```
|
||||
Product rating count (product.metafields.reviews.rating_count)
|
||||
Age group (product.metafields.shopify.age-group)
|
||||
Barware material (product.metafields.shopify.barware-material)
|
||||
Board game mechanics (product.metafields.shopify.board-game-mechanics)
|
||||
Color (product.metafields.shopify.color-pattern)
|
||||
Construction set theme (product.metafields.shopify.construction-set-theme)
|
||||
Decoration material (product.metafields.shopify.decoration-material)
|
||||
Dexterity skills (product.metafields.shopify.dexterity-skills)
|
||||
Dice shape (product.metafields.shopify.dice-shape)
|
||||
Difficulty level (product.metafields.shopify.difficulty-level)
|
||||
Doll/Playset features (product.metafields.shopify.doll-playset-features)
|
||||
Finish (product.metafields.shopify.finish)
|
||||
Gameplay skills (product.metafields.shopify.gameplay-skills)
|
||||
Hardware material (product.metafields.shopify.hardware-material)
|
||||
Material (product.metafields.shopify.material)
|
||||
Pet trainer type (product.metafields.shopify.pet-trainer-type)
|
||||
Plant class (product.metafields.shopify.plant-class)
|
||||
Plant name (product.metafields.shopify.plant-name)
|
||||
Puzzle theme (product.metafields.shopify.puzzle-theme)
|
||||
Puzzle type (product.metafields.shopify.puzzle-type)
|
||||
Recommended age group (product.metafields.shopify.recommended-age-group)
|
||||
Shape (product.metafields.shopify.shape)
|
||||
Stationery binding type (product.metafields.shopify.stationery-binding-type)
|
||||
Suitable space (product.metafields.shopify.suitable-space)
|
||||
Target gender (product.metafields.shopify.target-gender)
|
||||
Theme (product.metafields.shopify.theme)
|
||||
Toy/Game material (product.metafields.shopify.toy-game-material)
|
||||
Usage type (product.metafields.shopify.usage-type)
|
||||
Vase shape (product.metafields.shopify.vase-shape)
|
||||
```
|
||||
|
||||
## Resolvers, in dependency order
|
||||
|
||||
Each resolver is idempotent: find-by-natural-key-or-create, checking `import_mappings` where applicable.
|
||||
|
||||
1. **TaxClassResolver** — maps `Variant Taxable` (bool) to a fixed `TaxClass` ("Standard" vs "None"), not a per-row lookup.
|
||||
2. **ProductTypeResolver** — maps CSV `Type` to `ProductType`; falls back to a default (e.g. "General") since `product_type_id` is required.
|
||||
3. **BrandResolver** — `Vendor` → `products.brand`; likely a passthrough, not a real resolver, since it's a plain string column.
|
||||
4. **TagResolver** — splits `Tags`, finds/creates `Tag` rows, attaches to product.
|
||||
5. **CollectionResolver** — parses `Product Category` breadcrumb into a nested `Collection` chain within the target `CollectionGroup` (find/create per level), attaches product only to the deepest (leaf) Collection. Does not touch or conflict with any other collections the product may already belong to — a product can be in multiple collections at once.
|
||||
6. **ProductOptionResolver** — for each `Option1/2/3 Name`, find/create `ProductOption` + `ProductOptionValue`, reused across products.
|
||||
7. **AssetResolver** — resolves each CSV image row to its local UUID-named file in the export's images folder (see "Images" above), creates `Asset` + Spatie media from that local file, attaches to product and/or specific variants with `position` ordering.
|
||||
8. **PriceResolver** — creates `Price` row(s) per variant per currency from `Variant Price` / `Variant Compare At Price`.
|
||||
|
||||
## Orchestration order per product group
|
||||
|
||||
```
|
||||
1. Resolve/create ProductType, TaxClass, Brand
|
||||
2. Create or update Product (import_mappings: source_type='product', external_id=handle)
|
||||
- write Title/Body, Cost per item, SEO title/description into attribute_data
|
||||
3. Create/attach Url (slug = handle)
|
||||
4. Resolve/attach Tags
|
||||
5. Resolve/attach Collection chain (parsed from Product Category breadcrumb, within the target CollectionGroup; attach product to leaf Collection only)
|
||||
6. For each Option1/2/3 Name -> resolve ProductOption
|
||||
7. For each variant row:
|
||||
- resolve ProductOptionValues for that variant's option combination
|
||||
- create or update ProductVariant (import_mappings: source_type='variant', external_id=handle+variant-index)
|
||||
- attach ProductOptionValues to variant
|
||||
- create/update Price row(s)
|
||||
8. For each image row:
|
||||
- resolve the CSV row to its local UUID-named file in the export's images folder; skip with a logged warning if the file is missing
|
||||
- resolve/create Asset from the local file (import_mappings: source_type='image', external_id=image URL or handle+position — not the UUID filename, which is regenerated per export)
|
||||
- attach to Product, and to specific ProductVariant if the image is variant-scoped
|
||||
```
|
||||
|
||||
## Explicitly out of scope for v1
|
||||
|
||||
- Metafield columns (confirmed empty — see above).
|
||||
@@ -46,6 +46,10 @@
|
||||
<x-filament::button type="submit" class="w-full">
|
||||
Sign in
|
||||
</x-filament::button>
|
||||
|
||||
<x-filament::link wire:click="back" tag="button" type="button" class="mx-auto">
|
||||
← Back
|
||||
</x-filament::link>
|
||||
</div>
|
||||
</form>
|
||||
@endif
|
||||
|
||||
@@ -35,6 +35,12 @@ class Login extends SimplePage
|
||||
}
|
||||
}
|
||||
|
||||
public function back(): void
|
||||
{
|
||||
$this->otpSent = false;
|
||||
$this->otp = '';
|
||||
}
|
||||
|
||||
public function requestOtp(): void
|
||||
{
|
||||
$this->validate(['email' => 'required|email']);
|
||||
|
||||
@@ -0,0 +1,284 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Command;
|
||||
|
||||
use Illuminate\Console\Command;
|
||||
use Lunar\Facades\DB;
|
||||
use Lunar\FieldTypes\TranslatedText;
|
||||
use Lunar\Models\Attribute;
|
||||
use Lunar\Models\AttributeGroup;
|
||||
use Lunar\Models\Channel;
|
||||
use Lunar\Models\Collection;
|
||||
use Lunar\Models\CollectionGroup;
|
||||
use Lunar\Models\Country;
|
||||
use Lunar\Models\Currency;
|
||||
use Lunar\Models\CustomerGroup;
|
||||
use Lunar\Models\Language;
|
||||
use Lunar\Models\Product;
|
||||
use Lunar\Models\ProductType;
|
||||
use Lunar\Models\TaxClass;
|
||||
use Lunar\Models\TaxZone;
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
/**
|
||||
* Overrides Lunar's own lunar:install to skip the interactive prompts (migrate
|
||||
* confirmation, admin creation, GitHub star), so it's safe to run unattended from
|
||||
* the entrypoint on every boot. Migrations already run as a separate, earlier
|
||||
* entrypoint step; the admin user is created manually.
|
||||
*/
|
||||
class InstallLunarCommand extends Command
|
||||
{
|
||||
protected $signature = 'lunar:install';
|
||||
|
||||
protected $description = 'Seed the default Lunar store data (countries, channel, currency, tax zone, attributes, product type)';
|
||||
|
||||
public function handle(): void
|
||||
{
|
||||
$this->components->info('Seeding default Lunar store data...');
|
||||
|
||||
if (! Country::count()) {
|
||||
$this->components->info('Importing countries');
|
||||
$this->call('lunar:import:address-data');
|
||||
}
|
||||
|
||||
DB::transaction(function () {
|
||||
if (! Channel::whereDefault(true)->exists()) {
|
||||
$this->components->info('Setting up default channel');
|
||||
|
||||
Channel::create([
|
||||
'name' => 'Webstore',
|
||||
'handle' => 'webstore',
|
||||
'default' => true,
|
||||
'url' => 'http://localhost',
|
||||
]);
|
||||
}
|
||||
|
||||
if (! Language::count()) {
|
||||
$this->components->info('Adding default language');
|
||||
|
||||
Language::create([
|
||||
'code' => 'en',
|
||||
'name' => 'English',
|
||||
'default' => true,
|
||||
]);
|
||||
}
|
||||
|
||||
if (! Currency::whereDefault(true)->exists()) {
|
||||
$this->components->info('Adding a default currency (USD)');
|
||||
|
||||
Currency::create([
|
||||
'code' => 'USD',
|
||||
'name' => 'US Dollar',
|
||||
'exchange_rate' => 1,
|
||||
'decimal_places' => 2,
|
||||
'default' => true,
|
||||
'enabled' => true,
|
||||
]);
|
||||
}
|
||||
|
||||
if (! CustomerGroup::whereDefault(true)->exists()) {
|
||||
$this->components->info('Adding a default customer group.');
|
||||
|
||||
CustomerGroup::create([
|
||||
'name' => 'Retail',
|
||||
'handle' => 'retail',
|
||||
'default' => true,
|
||||
]);
|
||||
}
|
||||
|
||||
if (! CollectionGroup::count()) {
|
||||
$this->components->info('Adding an initial collection group');
|
||||
|
||||
CollectionGroup::create([
|
||||
'name' => 'Main',
|
||||
'handle' => 'main',
|
||||
]);
|
||||
}
|
||||
|
||||
if (! TaxClass::count()) {
|
||||
$this->components->info('Adding a default tax class.');
|
||||
|
||||
TaxClass::create([
|
||||
'name' => 'Default Tax Class',
|
||||
'default' => true,
|
||||
]);
|
||||
}
|
||||
|
||||
if (! TaxZone::count()) {
|
||||
$this->components->info('Adding a default tax zone.');
|
||||
|
||||
$taxZone = TaxZone::create([
|
||||
'name' => 'Default Tax Zone',
|
||||
'zone_type' => 'country',
|
||||
'price_display' => 'tax_exclusive',
|
||||
'default' => true,
|
||||
'active' => true,
|
||||
]);
|
||||
$taxZone->countries()->createMany(
|
||||
Country::get()->map(fn ($country) => [
|
||||
'country_id' => $country->id,
|
||||
])
|
||||
);
|
||||
}
|
||||
|
||||
if (! Attribute::count()) {
|
||||
$this->components->info('Setting up initial attributes');
|
||||
|
||||
$group = AttributeGroup::create([
|
||||
'attributable_type' => Product::morphName(),
|
||||
'name' => collect([
|
||||
'en' => 'Details',
|
||||
]),
|
||||
'handle' => 'details',
|
||||
'position' => 1,
|
||||
]);
|
||||
|
||||
$collectionGroup = AttributeGroup::create([
|
||||
'attributable_type' => Collection::morphName(),
|
||||
'name' => collect([
|
||||
'en' => 'Details',
|
||||
]),
|
||||
'handle' => 'collection_details',
|
||||
'position' => 1,
|
||||
]);
|
||||
|
||||
Attribute::create([
|
||||
'attribute_type' => 'product',
|
||||
'attribute_group_id' => $group->id,
|
||||
'position' => 1,
|
||||
'name' => [
|
||||
'en' => 'Name',
|
||||
],
|
||||
'handle' => 'name',
|
||||
'section' => 'main',
|
||||
'type' => TranslatedText::class,
|
||||
'required' => true,
|
||||
'default_value' => null,
|
||||
'configuration' => [
|
||||
'richtext' => false,
|
||||
],
|
||||
'system' => true,
|
||||
'description' => [
|
||||
'en' => '',
|
||||
],
|
||||
]);
|
||||
|
||||
Attribute::create([
|
||||
'attribute_type' => 'collection',
|
||||
'attribute_group_id' => $collectionGroup->id,
|
||||
'position' => 1,
|
||||
'name' => [
|
||||
'en' => 'Name',
|
||||
],
|
||||
'handle' => 'name',
|
||||
'section' => 'main',
|
||||
'type' => TranslatedText::class,
|
||||
'required' => true,
|
||||
'default_value' => null,
|
||||
'configuration' => [
|
||||
'richtext' => false,
|
||||
],
|
||||
'system' => true,
|
||||
'description' => [
|
||||
'en' => '',
|
||||
],
|
||||
]);
|
||||
|
||||
Attribute::create([
|
||||
'attribute_type' => 'product',
|
||||
'attribute_group_id' => $group->id,
|
||||
'position' => 2,
|
||||
'name' => [
|
||||
'en' => 'Description',
|
||||
],
|
||||
'handle' => 'description',
|
||||
'section' => 'main',
|
||||
'type' => TranslatedText::class,
|
||||
'required' => false,
|
||||
'default_value' => null,
|
||||
'configuration' => [
|
||||
'richtext' => true,
|
||||
],
|
||||
'system' => false,
|
||||
'description' => [
|
||||
'en' => '',
|
||||
],
|
||||
]);
|
||||
|
||||
Attribute::create([
|
||||
'attribute_type' => 'collection',
|
||||
'attribute_group_id' => $collectionGroup->id,
|
||||
'position' => 2,
|
||||
'name' => [
|
||||
'en' => 'Description',
|
||||
],
|
||||
'handle' => 'description',
|
||||
'section' => 'main',
|
||||
'type' => TranslatedText::class,
|
||||
'required' => false,
|
||||
'default_value' => null,
|
||||
'configuration' => [
|
||||
'richtext' => true,
|
||||
],
|
||||
'system' => false,
|
||||
'description' => [
|
||||
'en' => '',
|
||||
],
|
||||
]);
|
||||
}
|
||||
|
||||
if (! ProductType::count()) {
|
||||
$this->components->info('Adding a product type.');
|
||||
|
||||
$type = ProductType::create([
|
||||
'name' => 'Stock',
|
||||
]);
|
||||
|
||||
$type->mappedAttributes()->attach(
|
||||
Attribute::whereAttributeType(
|
||||
Product::morphName()
|
||||
)->get()->pluck('id')
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
if (! LanguageLine::where('group', 'storefront')->exists()) {
|
||||
$this->components->info('Seeding storefront label translations');
|
||||
$this->seedStorefrontLabels();
|
||||
}
|
||||
|
||||
$this->components->info('Publishing Filament assets');
|
||||
$this->call('filament:assets');
|
||||
|
||||
$this->components->info('Lunar default data seeded.');
|
||||
}
|
||||
|
||||
private function seedStorefrontLabels(): 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' => 'Αναζήτηση προϊόντων…'],
|
||||
];
|
||||
|
||||
foreach ($labels as $key => $text) {
|
||||
LanguageLine::create([
|
||||
'group' => 'storefront',
|
||||
'key' => $key,
|
||||
'text' => $text,
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Command;
|
||||
|
||||
use Illuminate\Console\Command;
|
||||
use Modules\Core\MigrateImport\ImportSpec;
|
||||
use Modules\Core\MigrateImport\RunMigrateImportJob;
|
||||
|
||||
class MigrateImportCommand extends Command
|
||||
{
|
||||
protected $signature = 'boboko:migrate:import
|
||||
{--source= : The source platform to import from}
|
||||
{--type= : The import mechanism for the chosen source}
|
||||
{--file= : Path to the export file (when type is export)}';
|
||||
|
||||
protected $description = 'Migrate data (products, customers, etc.) from an external source';
|
||||
|
||||
// Supported sources. Only "shopify" and "judgeme" are wired up for now.
|
||||
private const SOURCES = [
|
||||
'shopify',
|
||||
'judgeme',
|
||||
// "woocommerce",
|
||||
];
|
||||
|
||||
// Supported import types per source. Only "export" is wired up for now.
|
||||
private const TYPES = [
|
||||
'export',
|
||||
// "api",
|
||||
];
|
||||
|
||||
public function handle(): void
|
||||
{
|
||||
$source = $this->option('source')
|
||||
?? $this->choice('Select a source:', self::SOURCES, 0);
|
||||
|
||||
$type = $this->option('type')
|
||||
?? $this->choice('Select an import type:', self::TYPES, 0);
|
||||
|
||||
if ($type === 'api') {
|
||||
$credentials = [
|
||||
'api_key' => $this->secret('API key:'),
|
||||
'api_secret' => $this->secret('API secret:'),
|
||||
];
|
||||
$filePath = null;
|
||||
} else {
|
||||
$importsPath = storage_path('app/private/imports');
|
||||
|
||||
$filePath = $this->option('file')
|
||||
?? $this->resolveImportPath($importsPath, $this->ask("Path to the export file, relative to {$importsPath}:"));
|
||||
|
||||
while (blank($filePath) || ! is_file($filePath)) {
|
||||
if (filled($filePath)) {
|
||||
$this->error("File not found: {$filePath}");
|
||||
}
|
||||
|
||||
$filePath = $this->resolveImportPath(
|
||||
$importsPath,
|
||||
$this->ask("Path to the export file, relative to {$importsPath}:"),
|
||||
);
|
||||
}
|
||||
|
||||
$credentials = null;
|
||||
}
|
||||
|
||||
$spec = new ImportSpec(
|
||||
source: $source,
|
||||
type: $type,
|
||||
filePath: $filePath,
|
||||
credentials: $credentials,
|
||||
);
|
||||
|
||||
RunMigrateImportJob::dispatch($spec);
|
||||
|
||||
$this->info('Import queued.');
|
||||
}
|
||||
|
||||
// Answers are relative to storage/app/private/imports (e.g. "shopify" or
|
||||
// "shopify/products_export.csv"); absolute paths are used as-is. A
|
||||
// directory answer picks the first CSV file found inside it.
|
||||
private function resolveImportPath(string $importsPath, ?string $answer): ?string
|
||||
{
|
||||
if (blank($answer)) {
|
||||
return $answer;
|
||||
}
|
||||
|
||||
$path = str_starts_with($answer, '/') ? $answer : "{$importsPath}/{$answer}";
|
||||
|
||||
if (is_dir($path)) {
|
||||
$csv = collect(glob("{$path}/*.csv"))->first();
|
||||
|
||||
return $csv ?? $path;
|
||||
}
|
||||
|
||||
return $path;
|
||||
}
|
||||
}
|
||||
+23
-8
@@ -3,15 +3,25 @@
|
||||
namespace Modules\Core;
|
||||
|
||||
use Filament\Contracts\Plugin;
|
||||
use Filament\Navigation\NavigationItem;
|
||||
use Filament\Panel;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
use Illuminate\Support\Facades\Mail;
|
||||
use Lunar\Admin\Filament\Resources\ProductOptionResource;
|
||||
use Lunar\Admin\Filament\Resources\ProductOptionResource\RelationManagers\ValuesRelationManager;
|
||||
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\Product;
|
||||
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\Localization\Filament\Resources\LanguageLineResource;
|
||||
use Modules\Core\Product\Filament\Extensions\ProductOptionResourceExtension;
|
||||
use Modules\Core\Product\Filament\Extensions\ValuesRelationManagerExtension;
|
||||
use Modules\Core\Review\Extensions\ProductResourceExtension;
|
||||
use Modules\Core\Review\Models\ProductReview;
|
||||
|
||||
class CorePlugin implements Plugin
|
||||
{
|
||||
@@ -27,18 +37,23 @@ class CorePlugin implements Plugin
|
||||
->brandLogo(asset('static/logos/core/boboko-logo.svg'))
|
||||
->darkModeBrandLogo(asset('static/logos/core/boboko-logo-white.svg'))
|
||||
->login(Login::class)
|
||||
->navigationItems([
|
||||
NavigationItem::make("Lucent")
|
||||
->url("/lucent")
|
||||
->icon("heroicon-o-sun")
|
||||
->group("Content")
|
||||
->sort(1),
|
||||
]);
|
||||
->resources([
|
||||
LanguageLineResource::class,
|
||||
])
|
||||
->plugin(ShippingPlugin::make());
|
||||
|
||||
LunarPanel::extensions([
|
||||
StaffResource::class => StaffResourceExtension::class,
|
||||
ProductResource::class => ProductResourceExtension::class,
|
||||
ProductOptionResource::class => ProductOptionResourceExtension::class,
|
||||
ValuesRelationManager::class => ValuesRelationManagerExtension::class,
|
||||
]);
|
||||
|
||||
Product::macro('reviews', function (): HasMany {
|
||||
/** @var Product $this */
|
||||
return $this->hasMany(ProductReview::class);
|
||||
});
|
||||
|
||||
LunarStaff::addActivitylogExcept([
|
||||
'otp_code',
|
||||
'otp_expires_at',
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Events;
|
||||
|
||||
use Lunar\Models\Language;
|
||||
|
||||
class LanguageCreated
|
||||
{
|
||||
public function __construct(
|
||||
public readonly Language $language,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Events;
|
||||
|
||||
use Lunar\Models\Language;
|
||||
|
||||
class LanguageDeleted
|
||||
{
|
||||
public function __construct(
|
||||
public readonly Language $language,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Events;
|
||||
|
||||
use Lunar\Models\Language;
|
||||
|
||||
class LanguageUpdated
|
||||
{
|
||||
/**
|
||||
* @param array{code: string} $old Snapshot of watched attributes before the update.
|
||||
*/
|
||||
public function __construct(
|
||||
public readonly Language $language,
|
||||
public readonly array $old,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Events;
|
||||
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
class TranslationCreated
|
||||
{
|
||||
public function __construct(
|
||||
public readonly LanguageLine $languageLine,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Events;
|
||||
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
class TranslationDeleted
|
||||
{
|
||||
public function __construct(
|
||||
public readonly LanguageLine $languageLine,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Events;
|
||||
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
class TranslationUpdated
|
||||
{
|
||||
/**
|
||||
* @param array{group: string, key: string, text: array} $old Snapshot before the update.
|
||||
*/
|
||||
public function __construct(
|
||||
public readonly LanguageLine $languageLine,
|
||||
public readonly array $old,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,107 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Filament\Resources;
|
||||
|
||||
use Filament\Forms;
|
||||
use Filament\Forms\Form;
|
||||
use Filament\Resources\Resource;
|
||||
use Filament\Tables;
|
||||
use Filament\Tables\Table;
|
||||
use Lunar\Models\Language;
|
||||
use Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages;
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
class LanguageLineResource extends Resource
|
||||
{
|
||||
protected static ?string $model = LanguageLine::class;
|
||||
|
||||
protected static ?string $navigationIcon = 'heroicon-o-language';
|
||||
|
||||
protected static ?string $navigationGroup = 'Settings';
|
||||
|
||||
protected static ?string $modelLabel = 'Translation';
|
||||
|
||||
protected static ?string $pluralModelLabel = 'Translations';
|
||||
|
||||
public static function form(Form $form): Form
|
||||
{
|
||||
return $form->schema([
|
||||
Forms\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')
|
||||
->required()
|
||||
->maxLength(255)
|
||||
->helperText('Dot-notation key, e.g. "nav.cart".'),
|
||||
|
||||
Forms\Components\Fieldset::make('Translations')
|
||||
->schema(static::localeInputs()),
|
||||
]);
|
||||
}
|
||||
|
||||
public static function table(Table $table): Table
|
||||
{
|
||||
return $table
|
||||
->columns([
|
||||
Tables\Columns\TextColumn::make('group')
|
||||
->badge()
|
||||
->sortable(),
|
||||
Tables\Columns\TextColumn::make('key')
|
||||
->searchable()
|
||||
->sortable(),
|
||||
...static::localeColumns(),
|
||||
])
|
||||
->filters([
|
||||
Tables\Filters\SelectFilter::make('group')
|
||||
->options(fn () => LanguageLine::query()->distinct()->pluck('group', 'group')),
|
||||
])
|
||||
->defaultSort('key');
|
||||
}
|
||||
|
||||
public static function getRelations(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public static function getPages(): array
|
||||
{
|
||||
return [
|
||||
'index' => Pages\ListLanguageLines::route('/'),
|
||||
'create' => Pages\CreateLanguageLine::route('/create'),
|
||||
'edit' => Pages\EditLanguageLine::route('/{record}/edit'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<Forms\Components\Textarea>
|
||||
*/
|
||||
private static function localeInputs(): array
|
||||
{
|
||||
return static::localeCodes()
|
||||
->map(fn (string $code) => Forms\Components\Textarea::make("text.{$code}")
|
||||
->label(strtoupper($code))
|
||||
->rows(2))
|
||||
->all();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<Tables\Columns\TextColumn>
|
||||
*/
|
||||
private static function localeColumns(): array
|
||||
{
|
||||
return static::localeCodes()
|
||||
->map(fn (string $code) => Tables\Columns\TextColumn::make("text.{$code}")
|
||||
->label(strtoupper($code))
|
||||
->limit(40)
|
||||
->toggleable())
|
||||
->all();
|
||||
}
|
||||
|
||||
private static function localeCodes(): \Illuminate\Support\Collection
|
||||
{
|
||||
return Language::query()->pluck('code');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages;
|
||||
|
||||
use Filament\Resources\Pages\CreateRecord;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
||||
use Modules\Core\Localization\Services\TranslationService;
|
||||
|
||||
class CreateLanguageLine extends CreateRecord
|
||||
{
|
||||
protected static string $resource = LanguageLineResource::class;
|
||||
|
||||
protected function handleRecordCreation(array $data): Model
|
||||
{
|
||||
return app(TranslationService::class)->create(
|
||||
$data['group'],
|
||||
$data['key'],
|
||||
$data['text'] ?? [],
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages;
|
||||
|
||||
use Filament\Actions;
|
||||
use Filament\Actions\Action;
|
||||
use Filament\Resources\Pages\EditRecord;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
||||
use Modules\Core\Localization\Services\TranslationService;
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
class EditLanguageLine extends EditRecord
|
||||
{
|
||||
protected static string $resource = LanguageLineResource::class;
|
||||
|
||||
protected function getHeaderActions(): array
|
||||
{
|
||||
return [
|
||||
Actions\DeleteAction::make()
|
||||
->action(function (LanguageLine $record) {
|
||||
app(TranslationService::class)->delete($record);
|
||||
|
||||
$this->redirect($this->getResource()::getUrl('index'));
|
||||
}),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Filament's default Cancel button uses window.history.back(), which
|
||||
* restores the browser's cached previous page instead of re-fetching —
|
||||
* so an edit made just before clicking Cancel doesn't show up in the
|
||||
* list until a manual refresh. Redirect through Livewire instead, which
|
||||
* always re-queries.
|
||||
*/
|
||||
protected function getCancelFormAction(): Action
|
||||
{
|
||||
return Action::make('cancel')
|
||||
->label(__('filament-panels::resources/pages/edit-record.form.actions.cancel.label'))
|
||||
->url(static::getResource()::getUrl('index'))
|
||||
->color('gray');
|
||||
}
|
||||
|
||||
protected function handleRecordUpdate(Model $record, array $data): Model
|
||||
{
|
||||
return app(TranslationService::class)->update(
|
||||
$record,
|
||||
$data['group'],
|
||||
$data['key'],
|
||||
$data['text'] ?? [],
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages;
|
||||
|
||||
use Filament\Actions;
|
||||
use Filament\Resources\Pages\ListRecords;
|
||||
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
||||
|
||||
class ListLanguageLines extends ListRecords
|
||||
{
|
||||
protected static string $resource = LanguageLineResource::class;
|
||||
|
||||
protected function getHeaderActions(): array
|
||||
{
|
||||
return [
|
||||
Actions\CreateAction::make(),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Listeners;
|
||||
|
||||
use Modules\Core\Localization\Events\LanguageCreated;
|
||||
use Modules\Core\Localization\Events\LanguageDeleted;
|
||||
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||
use Modules\Core\Localization\Services\LanguageCache;
|
||||
|
||||
class FlushLanguageCache
|
||||
{
|
||||
public function __construct(private readonly LanguageCache $languages) {}
|
||||
|
||||
public function handle(LanguageCreated|LanguageUpdated|LanguageDeleted $event): void
|
||||
{
|
||||
$this->languages->forget();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Listeners;
|
||||
|
||||
use Illuminate\Support\Facades\Cache;
|
||||
use Modules\Core\Localization\Events\TranslationCreated;
|
||||
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||
use Modules\Core\Localization\Events\TranslationUpdated;
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
/**
|
||||
* LanguageLine::boot() already flushes the cache for the current group's locales
|
||||
* present after a save, but misses two cases on update: locales removed from
|
||||
* `text` (e.g. dropping the "el" key leaves `{group}.el` stale), and a changed
|
||||
* `group`/`key` (the old group's cached array never gets told a row left it).
|
||||
* This listener flushes every group+locale combination touched by either the
|
||||
* old or new state so nothing can remain stale.
|
||||
*/
|
||||
class FlushTranslationCache
|
||||
{
|
||||
public function handle(TranslationCreated|TranslationUpdated|TranslationDeleted $event): void
|
||||
{
|
||||
$this->flush($event->languageLine->group, array_keys($event->languageLine->text ?? []));
|
||||
|
||||
if ($event instanceof TranslationUpdated) {
|
||||
$this->flush($event->old['group'], array_keys($event->old['text'] ?? []));
|
||||
}
|
||||
}
|
||||
|
||||
private function flush(string $group, array $locales): void
|
||||
{
|
||||
foreach ($locales as $locale) {
|
||||
Cache::forget(LanguageLine::getCacheKey($group, $locale));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Listeners;
|
||||
|
||||
use Illuminate\Support\Arr;
|
||||
use Modules\Core\Localization\Events\TranslationCreated;
|
||||
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||
use Modules\Core\Localization\Events\TranslationUpdated;
|
||||
use Modules\Core\Logging\ActivityLogService;
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
class LogTranslationActivity
|
||||
{
|
||||
public function __construct(
|
||||
private readonly ActivityLogService $activityLog,
|
||||
) {}
|
||||
|
||||
public function handle(TranslationCreated|TranslationUpdated|TranslationDeleted $event): void
|
||||
{
|
||||
$languageLine = $event->languageLine;
|
||||
|
||||
match (true) {
|
||||
$event instanceof TranslationCreated => $this->activityLog->created(
|
||||
$languageLine,
|
||||
$this->flatten($languageLine),
|
||||
),
|
||||
$event instanceof TranslationUpdated => $this->activityLog->updated(
|
||||
$languageLine,
|
||||
Arr::dot($event->old),
|
||||
$this->flatten($languageLine),
|
||||
),
|
||||
$event instanceof TranslationDeleted => $this->activityLog->deleted(
|
||||
$languageLine,
|
||||
$this->flatten($languageLine),
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Filament's Activity resource renders `properties` with a flat KeyValue
|
||||
* field, which can't display a nested value like `text: {en, el}` — it
|
||||
* shows as "[object Object]". Flatten to dot-notation ("text.en",
|
||||
* "text.el") so every property is a plain string, viewable as-is.
|
||||
*/
|
||||
private function flatten(LanguageLine $languageLine): array
|
||||
{
|
||||
return Arr::dot([
|
||||
'group' => $languageLine->group,
|
||||
'key' => $languageLine->key,
|
||||
'text' => $languageLine->text,
|
||||
]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Listeners;
|
||||
|
||||
use Illuminate\Support\Facades\Cache;
|
||||
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
/**
|
||||
* A renamed Language::code (e.g. "el" -> "gr") would otherwise strand every
|
||||
* LanguageLine's translated text under the old, now-unroutable key —
|
||||
* getTranslationsForGroup($newCode, ...) would silently return nothing for
|
||||
* that locale even though the translated content still exists. Move the
|
||||
* text.{oldCode} key to text.{newCode} on every affected row instead.
|
||||
*/
|
||||
class MigrateTranslationsForRenamedLanguage
|
||||
{
|
||||
public function handle(LanguageUpdated $event): void
|
||||
{
|
||||
$oldCode = $event->old['code'];
|
||||
$newCode = $event->language->code;
|
||||
|
||||
if ($oldCode === $newCode) {
|
||||
return;
|
||||
}
|
||||
|
||||
$affectedGroups = [];
|
||||
|
||||
LanguageLine::query()
|
||||
->whereJsonContainsKey('text->'.$oldCode)
|
||||
->each(function (LanguageLine $languageLine) use ($oldCode, $newCode, &$affectedGroups) {
|
||||
$text = $languageLine->text;
|
||||
$text[$newCode] = $text[$oldCode];
|
||||
unset($text[$oldCode]);
|
||||
|
||||
$languageLine->update(['text' => $text]);
|
||||
|
||||
$affectedGroups[$languageLine->group] = true;
|
||||
});
|
||||
|
||||
foreach (array_keys($affectedGroups) as $group) {
|
||||
Cache::forget(LanguageLine::getCacheKey($group, $oldCode));
|
||||
Cache::forget(LanguageLine::getCacheKey($group, $newCode));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,107 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Middleware;
|
||||
|
||||
use Closure;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Facades\App;
|
||||
use Illuminate\Support\Facades\URL;
|
||||
use Illuminate\Support\Facades\View;
|
||||
use Lunar\Models\Language;
|
||||
use Modules\Core\Localization\Services\LanguageCache;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
|
||||
class LocaleMiddleware
|
||||
{
|
||||
public function __construct(private readonly LanguageCache $languages) {}
|
||||
|
||||
public function handle(Request $request, Closure $next): Response
|
||||
{
|
||||
$languages = $this->languages->all();
|
||||
|
||||
if ($languages->isEmpty()) {
|
||||
return $next($request);
|
||||
}
|
||||
|
||||
$segment = (string) $request->segment(1);
|
||||
$language = $languages->firstWhere('code', $segment);
|
||||
|
||||
if (! $language) {
|
||||
return $this->redirectToLocalizedUrl($request, $languages);
|
||||
}
|
||||
|
||||
App::setLocale($language->code);
|
||||
$request->attributes->set('locale', $language->code);
|
||||
$request->attributes->set('language', $language);
|
||||
|
||||
// Lets route() calls omit {locale} anywhere in the request lifecycle
|
||||
// (controllers, views) — without this, every route() call would need
|
||||
// locale passed explicitly every time.
|
||||
URL::defaults(['locale' => $language->code]);
|
||||
|
||||
$this->shareLocaleViewData($request, $language, $languages);
|
||||
|
||||
return $next($request);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shares the current locale and every OTHER available locale (each with its
|
||||
* own URL for the current page) with all views, so the header language
|
||||
* switcher and layout hreflang tags don't have to recompute it.
|
||||
*
|
||||
* `altLocales` is a collection, not a single value — firstWhere('code', '!=',
|
||||
* ...) would only ever surface one alternate, which happens to look correct
|
||||
* with exactly 2 configured languages (there's only one "other" to find) but
|
||||
* silently drops every locale past the first for a 3+ language store, with no
|
||||
* error, just fewer switcher options than actually configured. A view iterates
|
||||
* `$altLocales` to render as many links/dropdown entries as there are
|
||||
* alternates, whether that's 1 or 10.
|
||||
*/
|
||||
private function shareLocaleViewData(Request $request, Language $language, Collection $languages): void
|
||||
{
|
||||
$route = $request->route();
|
||||
$routeName = $route?->getName();
|
||||
|
||||
$altLocales = $languages
|
||||
->reject(fn (Language $other) => $other->code === $language->code)
|
||||
->map(fn (Language $other) => [
|
||||
'code' => $other->code,
|
||||
'name' => $other->name,
|
||||
'url' => $routeName
|
||||
? route($routeName, array_merge($route->parameters(), ['locale' => $other->code]))
|
||||
: url('/'.$other->code),
|
||||
])
|
||||
->values();
|
||||
|
||||
View::share('currentLocale', $language->code);
|
||||
View::share('altLocales', $altLocales);
|
||||
}
|
||||
|
||||
private function redirectToLocalizedUrl(Request $request, Collection $languages): Response
|
||||
{
|
||||
$locale = $this->negotiateLocale($request, $languages);
|
||||
|
||||
$path = trim($request->getPathInfo(), '/');
|
||||
$target = '/'.$locale.($path !== '' ? '/'.$path : '');
|
||||
|
||||
$query = $request->getQueryString();
|
||||
if ($query) {
|
||||
$target .= '?'.$query;
|
||||
}
|
||||
|
||||
return redirect($target);
|
||||
}
|
||||
|
||||
private function negotiateLocale(Request $request, Collection $languages): string
|
||||
{
|
||||
$preferred = $request->getPreferredLanguage($languages->pluck('code')->all());
|
||||
|
||||
if ($preferred) {
|
||||
return $preferred;
|
||||
}
|
||||
|
||||
return $languages->firstWhere('default', true)?->code
|
||||
?? $languages->first()->code;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Models;
|
||||
|
||||
use Modules\Core\Localization\Services\LanguageCache;
|
||||
use Spatie\TranslationLoader\LanguageLine as BaseLanguageLine;
|
||||
|
||||
/**
|
||||
* Overrides the base package's locale fallback (config('app.fallback_locale'), a
|
||||
* static .env value) with the store's actual default language — Lunar's
|
||||
* `languages.default` flag, the same source LocaleMiddleware/LanguageCache already
|
||||
* treat as the single source of truth for "this store's default language".
|
||||
*
|
||||
* Without this, changing the default language via the Filament Languages resource
|
||||
* has no effect on which locale an untranslated storefront label falls back to —
|
||||
* two disconnected "default locale" concepts silently drifting apart. Swapped in
|
||||
* via config('translation-loader.model') (see LocalizationServiceProvider), the
|
||||
* package's own documented extension point for this.
|
||||
*/
|
||||
class LanguageLine extends BaseLanguageLine
|
||||
{
|
||||
public function getTranslation(string $locale): ?string
|
||||
{
|
||||
if (isset($this->text[$locale])) {
|
||||
return $this->text[$locale];
|
||||
}
|
||||
|
||||
$fallback = app(LanguageCache::class)->defaultLocale();
|
||||
|
||||
return $fallback !== null ? ($this->text[$fallback] ?? null) : null;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Observers;
|
||||
|
||||
use Illuminate\Support\Facades\Event;
|
||||
use Lunar\Models\Language;
|
||||
use Modules\Core\Localization\Events\LanguageCreated;
|
||||
use Modules\Core\Localization\Events\LanguageDeleted;
|
||||
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||
|
||||
class LanguageCacheObserver
|
||||
{
|
||||
public function created(Language $language): void
|
||||
{
|
||||
Event::dispatch(new LanguageCreated($language));
|
||||
}
|
||||
|
||||
public function updated(Language $language): void
|
||||
{
|
||||
Event::dispatch(new LanguageUpdated($language, [
|
||||
'code' => $language->getOriginal('code'),
|
||||
]));
|
||||
}
|
||||
|
||||
public function deleted(Language $language): void
|
||||
{
|
||||
Event::dispatch(new LanguageDeleted($language));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Services;
|
||||
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Facades\Cache;
|
||||
use Lunar\Models\Language;
|
||||
|
||||
/**
|
||||
* Cached read layer over Lunar's `languages` table — the single source both
|
||||
* Modules\Core\Localization\Middleware\LocaleMiddleware (request-time locale resolution) and
|
||||
* any other locale-aware code (e.g. Modules\Core\Product\Services\ProductService) read
|
||||
* from, so the language list is fetched once per cache lifetime rather than once
|
||||
* per caller. Cached forever, invalidated via forget() by
|
||||
* Modules\Core\Localization\Listeners\FlushLanguageCache on
|
||||
* LanguageCreated/LanguageUpdated/LanguageDeleted.
|
||||
*/
|
||||
class LanguageCache
|
||||
{
|
||||
private const CACHE_KEY = 'core.localization.languages';
|
||||
|
||||
public function all(): Collection
|
||||
{
|
||||
return Cache::rememberForever(
|
||||
self::CACHE_KEY,
|
||||
fn () => Language::query()->get(['id', 'code', 'name', 'default']),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* The store's default language code (e.g. 'el') - the fixed fallback other
|
||||
* locale-aware code should use, as opposed to config('app.locale') which
|
||||
* App::setLocale() mutates per request and so can't serve as a stable
|
||||
* fallback.
|
||||
*/
|
||||
public function defaultLocale(): ?string
|
||||
{
|
||||
return $this->all()->firstWhere('default', true)?->code;
|
||||
}
|
||||
|
||||
/**
|
||||
* Every configured store locale code (e.g. ['el', 'en']) - for code that needs
|
||||
* to enumerate all locales a TranslatedText attribute was indexed under (see
|
||||
* Modules\Core\Product\Services\ProductService::withLocalizedFields()), rather than
|
||||
* hardcoding locale codes.
|
||||
*
|
||||
* @return array<int, string>
|
||||
*/
|
||||
public function availableLocales(): array
|
||||
{
|
||||
return $this->all()->pluck('code')->all();
|
||||
}
|
||||
|
||||
public function forget(): void
|
||||
{
|
||||
Cache::forget(self::CACHE_KEY);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Services;
|
||||
|
||||
use Illuminate\Support\Facades\App;
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
class TranslationReader
|
||||
{
|
||||
private const DEFAULT_GROUP = 'storefront';
|
||||
|
||||
/**
|
||||
* All labels in a group for the given (or current) locale, keyed by their
|
||||
* dot-notation key — e.g. ['nav.cart' => 'Cart', 'nav.home' => 'Home'].
|
||||
* Backed by LanguageLine's own forever-cache, so this is a cache hit after
|
||||
* the first call for a given group+locale.
|
||||
*/
|
||||
public function group(string $group = self::DEFAULT_GROUP, ?string $locale = null): array
|
||||
{
|
||||
return LanguageLine::getTranslationsForGroup($locale ?? App::getLocale(), $group);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Localization\Services;
|
||||
|
||||
use Illuminate\Support\Facades\Event;
|
||||
use Modules\Core\Localization\Events\TranslationCreated;
|
||||
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||
use Modules\Core\Localization\Events\TranslationUpdated;
|
||||
use Spatie\TranslationLoader\LanguageLine;
|
||||
|
||||
class TranslationService
|
||||
{
|
||||
public function create(string $group, string $key, array $text): LanguageLine
|
||||
{
|
||||
$languageLine = LanguageLine::create([
|
||||
'group' => $group,
|
||||
'key' => $key,
|
||||
'text' => $text,
|
||||
]);
|
||||
|
||||
Event::dispatch(new TranslationCreated($languageLine));
|
||||
|
||||
return $languageLine;
|
||||
}
|
||||
|
||||
public function update(LanguageLine $languageLine, string $group, string $key, array $text): LanguageLine
|
||||
{
|
||||
// Callers (e.g. Filament's EditRecord) may hand us a model instance
|
||||
// already filled with the new form values in memory — refresh from the
|
||||
// database first so $old reflects what's actually persisted, not what's
|
||||
// about to be written.
|
||||
$persisted = $languageLine->fresh();
|
||||
|
||||
$old = [
|
||||
'group' => $persisted->group,
|
||||
'key' => $persisted->key,
|
||||
'text' => $persisted->text,
|
||||
];
|
||||
|
||||
$languageLine->update([
|
||||
'group' => $group,
|
||||
'key' => $key,
|
||||
'text' => $text,
|
||||
]);
|
||||
|
||||
Event::dispatch(new TranslationUpdated($languageLine, $old));
|
||||
|
||||
return $languageLine;
|
||||
}
|
||||
|
||||
public function delete(LanguageLine $languageLine): void
|
||||
{
|
||||
$languageLine->delete();
|
||||
|
||||
Event::dispatch(new TranslationDeleted($languageLine));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport;
|
||||
|
||||
use Lunar\Models\Language;
|
||||
|
||||
class DefaultLocale
|
||||
{
|
||||
public static function code(): string
|
||||
{
|
||||
return Language::getDefault()->code;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport;
|
||||
|
||||
class ImportSpec
|
||||
{
|
||||
public function __construct(
|
||||
public readonly string $source,
|
||||
public readonly string $type,
|
||||
public readonly ?string $filePath = null,
|
||||
public readonly ?array $credentials = null,
|
||||
) {
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport;
|
||||
|
||||
interface Importer
|
||||
{
|
||||
public function import(ImportSpec $spec): void;
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport;
|
||||
|
||||
use Modules\Core\MigrateImport\JudgeMe\JudgeMeExportImporter;
|
||||
use Modules\Core\MigrateImport\Shopify\ShopifyExportImporter;
|
||||
|
||||
class ImporterFactory
|
||||
{
|
||||
public static function make(ImportSpec $spec): Importer
|
||||
{
|
||||
return match ([$spec->source, $spec->type]) {
|
||||
['shopify', 'export'] => new ShopifyExportImporter,
|
||||
// ["shopify", "api"] => new ShopifyApiImporter(),
|
||||
['judgeme', 'export'] => new JudgeMeExportImporter,
|
||||
// ["woocommerce", "export"] => new WooCommerceExportImporter(),
|
||||
// ["woocommerce", "api"] => new WooCommerceApiImporter(),
|
||||
default => throw new \InvalidArgumentException(
|
||||
"No importer available for source \"{$spec->source}\" with type \"{$spec->type}\".",
|
||||
),
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\JudgeMe;
|
||||
|
||||
class JudgeMeCsvReader
|
||||
{
|
||||
/**
|
||||
* @return array<int, array<string, string>>
|
||||
*/
|
||||
public function read(string $csvPath): array
|
||||
{
|
||||
$handle = fopen($csvPath, 'r');
|
||||
|
||||
if ($handle === false) {
|
||||
throw new \RuntimeException("Could not open CSV file: {$csvPath}");
|
||||
}
|
||||
|
||||
$headers = fgetcsv($handle);
|
||||
$rows = [];
|
||||
|
||||
while (($row = fgetcsv($handle)) !== false) {
|
||||
$rows[] = array_combine($headers, $row);
|
||||
}
|
||||
|
||||
fclose($handle);
|
||||
|
||||
return $rows;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,105 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\JudgeMe;
|
||||
|
||||
use Illuminate\Support\Carbon;
|
||||
use Illuminate\Support\Facades\Log;
|
||||
use Modules\Core\MigrateImport\Importer;
|
||||
use Modules\Core\MigrateImport\ImportSpec;
|
||||
use Modules\Core\MigrateImport\JudgeMe\Resolvers\ProductResolver;
|
||||
use Modules\Core\MigrateImport\Models\ImportMapping;
|
||||
use Modules\Core\Review\Models\ProductReview;
|
||||
|
||||
class JudgeMeExportImporter implements Importer
|
||||
{
|
||||
private const SOURCE = 'judgeme';
|
||||
|
||||
public function __construct(
|
||||
private readonly JudgeMeCsvReader $csvReader = new JudgeMeCsvReader,
|
||||
private readonly ProductResolver $productResolver = new ProductResolver,
|
||||
) {}
|
||||
|
||||
public function import(ImportSpec $spec): void
|
||||
{
|
||||
foreach ($this->csvReader->read($spec->filePath) as $row) {
|
||||
$this->importReview($row);
|
||||
}
|
||||
}
|
||||
|
||||
private function importReview(array $row): void
|
||||
{
|
||||
$handle = trim((string) ($row['product_handle'] ?? ''));
|
||||
$externalId = $row['metaobject_handle'] ?? '';
|
||||
|
||||
$product = $handle !== '' ? $this->productResolver->resolve($handle) : null;
|
||||
|
||||
if (! $product) {
|
||||
Log::warning('JudgeMe import: no product found for handle, skipping review', [
|
||||
'product_handle' => $handle,
|
||||
'metaobject_handle' => $externalId,
|
||||
]);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$existing = ImportMapping::resolve(self::SOURCE, 'review', $externalId);
|
||||
|
||||
$review = $existing instanceof ProductReview ? $existing : new ProductReview;
|
||||
$review->product_id = $product->id;
|
||||
$review->title = trim((string) ($row['title'] ?? '')) ?: null;
|
||||
$review->body = $row['body'] ?? null;
|
||||
$review->rating = (int) ($row['rating'] ?? 0);
|
||||
$review->reviewed_at = $this->parseDate($row['review_date'] ?? null);
|
||||
$review->reviewer_name = $row['reviewer_name'] ?? null;
|
||||
$review->reviewer_email = trim((string) ($row['reviewer_email'] ?? '')) ?: null;
|
||||
$review->reply = trim((string) ($row['reply'] ?? '')) ?: null;
|
||||
$review->replied_at = $this->parseDate($row['reply_date'] ?? null);
|
||||
$review->location = trim((string) ($row['location'] ?? '')) ?: null;
|
||||
$review->source = trim((string) ($row['source'] ?? '')) ?: null;
|
||||
$review->save();
|
||||
|
||||
ImportMapping::record(self::SOURCE, 'review', $externalId, $review);
|
||||
|
||||
$pictureUrls = $this->parsePictureUrls($row['picture_urls'] ?? null);
|
||||
|
||||
if ($pictureUrls && $review->getMedia(ProductReview::IMAGES_COLLECTION)->isEmpty()) {
|
||||
$this->importImages($review, $pictureUrls);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, string> $urls
|
||||
*/
|
||||
private function importImages(ProductReview $review, array $urls): void
|
||||
{
|
||||
foreach ($urls as $url) {
|
||||
try {
|
||||
$review->addMediaFromUrl($url)->toMediaCollection(ProductReview::IMAGES_COLLECTION);
|
||||
} catch (\Throwable $e) {
|
||||
Log::warning('JudgeMe import: failed to download review image', [
|
||||
'review_id' => $review->id,
|
||||
'url' => $url,
|
||||
'error' => $e->getMessage(),
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private function parseDate(?string $value): ?Carbon
|
||||
{
|
||||
$value = trim((string) $value);
|
||||
|
||||
return $value !== '' ? Carbon::parse($value) : null;
|
||||
}
|
||||
|
||||
private function parsePictureUrls(?string $value): ?array
|
||||
{
|
||||
$value = trim((string) $value);
|
||||
|
||||
if ($value === '') {
|
||||
return null;
|
||||
}
|
||||
|
||||
return array_map('trim', explode(',', $value));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\JudgeMe\Resolvers;
|
||||
|
||||
use Lunar\Models\Product;
|
||||
use Lunar\Models\Url;
|
||||
|
||||
class ProductResolver
|
||||
{
|
||||
/**
|
||||
* A slug can have more than one `lunar_urls` row pointing at it across import
|
||||
* batches — e.g. a product soft-deleted and re-imported leaves its old URL row
|
||||
* behind, still matching the same slug. Picking "whichever Url row matches
|
||||
* first" (as a plain Url::where('slug', ...)->first() would) can resolve to a
|
||||
* soft-deleted product, silently failing every downstream write for that
|
||||
* product (e.g. JudgeMeExportImporter logging "no product found" for a handle
|
||||
* that, in isolation, clearly exists). Join against `lunar_products` directly
|
||||
* so only a URL pointing at a live (non-deleted) product resolves.
|
||||
*/
|
||||
public function resolve(string $handle): ?Product
|
||||
{
|
||||
return Product::query()
|
||||
->join('lunar_urls', 'lunar_urls.element_id', '=', 'lunar_products.id')
|
||||
->where('lunar_urls.slug', $handle)
|
||||
->where('lunar_urls.element_type', (new Product)->getMorphClass())
|
||||
->select('lunar_products.*')
|
||||
->first();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
|
||||
class ImportMapping extends Model
|
||||
{
|
||||
protected $guarded = [];
|
||||
|
||||
public function model(): MorphTo
|
||||
{
|
||||
return $this->morphTo();
|
||||
}
|
||||
|
||||
public static function resolve(string $source, string $sourceType, string $externalId): ?Model
|
||||
{
|
||||
return static::query()
|
||||
->where('source', $source)
|
||||
->where('source_type', $sourceType)
|
||||
->where('external_id', $externalId)
|
||||
->first()
|
||||
?->model;
|
||||
}
|
||||
|
||||
public static function record(string $source, string $sourceType, string $externalId, Model $model): self
|
||||
{
|
||||
return static::query()->updateOrCreate(
|
||||
[
|
||||
'source' => $source,
|
||||
'source_type' => $sourceType,
|
||||
'external_id' => $externalId,
|
||||
],
|
||||
[
|
||||
'model_type' => $model->getMorphClass(),
|
||||
'model_id' => $model->getKey(),
|
||||
],
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport;
|
||||
|
||||
use Illuminate\Bus\Queueable;
|
||||
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||
use Illuminate\Foundation\Bus\Dispatchable;
|
||||
use Illuminate\Queue\InteractsWithQueue;
|
||||
use Illuminate\Queue\SerializesModels;
|
||||
|
||||
class RunMigrateImportJob implements ShouldQueue
|
||||
{
|
||||
use Dispatchable;
|
||||
use InteractsWithQueue;
|
||||
use Queueable;
|
||||
use SerializesModels;
|
||||
|
||||
public function __construct(
|
||||
public readonly ImportSpec $spec,
|
||||
) {
|
||||
}
|
||||
|
||||
public function handle(): void
|
||||
{
|
||||
$importer = ImporterFactory::make($this->spec);
|
||||
$importer->import($this->spec);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify;
|
||||
|
||||
class ProductGroup
|
||||
{
|
||||
/** @var array<int, array<string, string>> */
|
||||
public array $variantRows = [];
|
||||
|
||||
/** @var array<int, array<string, string>> */
|
||||
public array $imageRows = [];
|
||||
|
||||
public function __construct(
|
||||
public readonly string $handle,
|
||||
public readonly array $productRow,
|
||||
) {
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Lunar\Models\Product;
|
||||
use Spatie\MediaLibrary\MediaCollections\Models\Media;
|
||||
|
||||
class AssetResolver
|
||||
{
|
||||
public function resolve(Product $product, string $localFilePath, int $position): ?Media
|
||||
{
|
||||
if (! is_file($localFilePath)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $product->addMedia($localFilePath)
|
||||
->preservingOriginal()
|
||||
->withCustomProperties(['position' => $position])
|
||||
->toMediaCollection(config('lunar.media.collection'));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Lunar\Models\Brand;
|
||||
|
||||
class BrandResolver
|
||||
{
|
||||
public function resolve(?string $vendor): ?Brand
|
||||
{
|
||||
$vendor = trim((string) $vendor);
|
||||
|
||||
if ($vendor === '') {
|
||||
return null;
|
||||
}
|
||||
|
||||
return Brand::firstOrCreate(['name' => $vendor]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,65 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Lunar\FieldTypes\Text;
|
||||
use Lunar\FieldTypes\TranslatedText;
|
||||
use Lunar\Models\Collection;
|
||||
use Lunar\Models\CollectionGroup;
|
||||
use Lunar\Models\Product;
|
||||
use Modules\Core\MigrateImport\DefaultLocale;
|
||||
|
||||
class CollectionResolver
|
||||
{
|
||||
public function resolve(Product $product, CollectionGroup $group, ?string $categoryPath): void
|
||||
{
|
||||
$segments = collect(explode('>', (string) $categoryPath))
|
||||
->map(fn (string $segment) => trim($segment))
|
||||
->filter();
|
||||
|
||||
if ($segments->isEmpty()) {
|
||||
return;
|
||||
}
|
||||
|
||||
$parent = null;
|
||||
|
||||
foreach ($segments as $segment) {
|
||||
$parent = $this->findChild($group, $parent, $segment) ?? $this->create($group, $parent, $segment);
|
||||
}
|
||||
|
||||
$product->collections()->syncWithoutDetaching([$parent->id]);
|
||||
}
|
||||
|
||||
private function findChild(CollectionGroup $group, ?Collection $parent, string $name): ?Collection
|
||||
{
|
||||
return Collection::query()
|
||||
->where('collection_group_id', $group->id)
|
||||
->where('parent_id', $parent?->id)
|
||||
->get()
|
||||
->first(fn (Collection $collection) => $collection->translateAttribute('name') === $name);
|
||||
}
|
||||
|
||||
private function create(CollectionGroup $group, ?Collection $parent, string $name): Collection
|
||||
{
|
||||
$collection = new Collection([
|
||||
'collection_group_id' => $group->id,
|
||||
'attribute_data' => [
|
||||
'name' => new TranslatedText(collect([
|
||||
DefaultLocale::code() => new Text($name),
|
||||
])),
|
||||
],
|
||||
]);
|
||||
|
||||
// Mass-assigning parent_id triggers NodeTrait's setParentIdAttribute
|
||||
// mutator before BaseModel's constructor has prefixed the table,
|
||||
// causing an "undefined table" query. appendToNode()/saveAsRoot()
|
||||
// avoid that mutator entirely.
|
||||
if ($parent) {
|
||||
$collection->appendToNode($parent)->save();
|
||||
} else {
|
||||
$collection->saveAsRoot();
|
||||
}
|
||||
|
||||
return $collection;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Lunar\FieldTypes\Number;
|
||||
use Lunar\FieldTypes\TranslatedText;
|
||||
use Lunar\Models\Attribute;
|
||||
use Lunar\Models\AttributeGroup;
|
||||
use Lunar\Models\Product;
|
||||
use Lunar\Models\ProductType;
|
||||
use Modules\Core\MigrateImport\DefaultLocale;
|
||||
|
||||
class ImportAttributeResolver
|
||||
{
|
||||
// Attributes Lunar doesn't ship by default but this importer needs,
|
||||
// with the field type each one should use.
|
||||
public const EXTRA_ATTRIBUTES = [
|
||||
'cost_per_item' => ['label' => 'Cost per item', 'type' => Number::class],
|
||||
'seo_title' => ['label' => 'SEO Title', 'type' => TranslatedText::class],
|
||||
'seo_description' => ['label' => 'SEO Description', 'type' => TranslatedText::class],
|
||||
];
|
||||
|
||||
public function ensureMapped(ProductType $productType): void
|
||||
{
|
||||
$mappedHandles = $productType->productAttributes()->pluck('handle')->all();
|
||||
$missing = array_diff(array_keys(self::EXTRA_ATTRIBUTES), $mappedHandles);
|
||||
|
||||
if (empty($missing)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$group = $this->importAttributeGroup();
|
||||
$nextPosition = Attribute::where('attribute_group_id', $group->id)->max('position') + 1;
|
||||
|
||||
foreach ($missing as $handle) {
|
||||
$definition = self::EXTRA_ATTRIBUTES[$handle];
|
||||
|
||||
$attribute = Attribute::firstOrCreate(
|
||||
['attribute_type' => Product::morphName(), 'handle' => $handle],
|
||||
[
|
||||
'attribute_group_id' => $group->id,
|
||||
'position' => $nextPosition++,
|
||||
'name' => [DefaultLocale::code() => $definition['label']],
|
||||
'section' => 'main',
|
||||
'type' => $definition['type'],
|
||||
'required' => false,
|
||||
'default_value' => null,
|
||||
'configuration' => $definition['type'] === TranslatedText::class
|
||||
? ['richtext' => false]
|
||||
: [],
|
||||
'system' => false,
|
||||
'description' => [DefaultLocale::code() => ''],
|
||||
],
|
||||
);
|
||||
|
||||
$productType->mappedAttributes()->syncWithoutDetaching([$attribute->id]);
|
||||
}
|
||||
}
|
||||
|
||||
private function importAttributeGroup(): AttributeGroup
|
||||
{
|
||||
return AttributeGroup::firstOrCreate(
|
||||
['attributable_type' => Product::morphName(), 'handle' => 'import'],
|
||||
[
|
||||
'name' => [DefaultLocale::code() => 'Additional Details'],
|
||||
'position' => 100,
|
||||
],
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Lunar\Models\Currency;
|
||||
use Lunar\Models\Price;
|
||||
use Lunar\Models\ProductVariant;
|
||||
|
||||
class PriceResolver
|
||||
{
|
||||
public function resolve(ProductVariant $variant, Currency $currency, float $price, ?float $comparePrice): Price
|
||||
{
|
||||
return Price::updateOrCreate(
|
||||
[
|
||||
'priceable_type' => $variant->getMorphClass(),
|
||||
'priceable_id' => $variant->id,
|
||||
'currency_id' => $currency->id,
|
||||
'customer_group_id' => null,
|
||||
],
|
||||
[
|
||||
'price' => (int) round($price * (10 ** $currency->decimal_places)),
|
||||
'compare_price' => $comparePrice !== null
|
||||
? (int) round($comparePrice * (10 ** $currency->decimal_places))
|
||||
: null,
|
||||
'min_quantity' => 1,
|
||||
],
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Lunar\FieldTypes\Number;
|
||||
use Lunar\FieldTypes\Text;
|
||||
use Lunar\FieldTypes\TranslatedText;
|
||||
use Lunar\Models\ProductType;
|
||||
use Modules\Core\MigrateImport\DefaultLocale;
|
||||
|
||||
class ProductAttributeResolver
|
||||
{
|
||||
/**
|
||||
* @param array<string, ?string> $values keyed by attribute handle, e.g. ['name' => ..., 'description' => ...]
|
||||
*/
|
||||
public function resolve(ProductType $productType, array $values): array
|
||||
{
|
||||
$mappedHandles = $productType->productAttributes()->pluck('handle')->all();
|
||||
|
||||
$attributeData = [];
|
||||
|
||||
foreach ($values as $handle => $value) {
|
||||
if (! in_array($handle, $mappedHandles, true)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (trim((string) $value) === '') {
|
||||
continue;
|
||||
}
|
||||
|
||||
$attributeData[$handle] = $this->fieldFor($handle, $value);
|
||||
}
|
||||
|
||||
return $attributeData;
|
||||
}
|
||||
|
||||
private function fieldFor(string $handle, string $value): Number|TranslatedText
|
||||
{
|
||||
$type = ImportAttributeResolver::EXTRA_ATTRIBUTES[$handle]['type'] ?? TranslatedText::class;
|
||||
|
||||
if ($type === Number::class) {
|
||||
return new Number((float) $value);
|
||||
}
|
||||
|
||||
return new TranslatedText(collect([
|
||||
DefaultLocale::code() => new Text($value),
|
||||
]));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Illuminate\Support\Str;
|
||||
use Lunar\Models\ProductOption;
|
||||
use Lunar\Models\ProductOptionValue;
|
||||
use Modules\Core\MigrateImport\DefaultLocale;
|
||||
|
||||
class ProductOptionResolver
|
||||
{
|
||||
public function resolveOption(string $name): ProductOption
|
||||
{
|
||||
// Match by slugified name (== handle), not raw name, so Shopify's
|
||||
// inconsistent casing across products ("Size" vs "size") resolves to
|
||||
// the same option instead of creating a near-duplicate.
|
||||
$handle = Str::slug($name) ?: 'option';
|
||||
|
||||
return ProductOption::query()->firstOrCreate(
|
||||
['handle' => $handle],
|
||||
[
|
||||
'name' => [DefaultLocale::code() => $name],
|
||||
'shared' => true,
|
||||
],
|
||||
);
|
||||
}
|
||||
|
||||
public function resolveValue(ProductOption $option, string $value): ProductOptionValue
|
||||
{
|
||||
$slug = Str::slug($value) ?: 'value';
|
||||
|
||||
// Query fresh rather than $option->values: that relation is lazily
|
||||
// cached on first access, so within one product's variant loop it
|
||||
// would miss a value created earlier in the same loop, creating a
|
||||
// duplicate for the same option+value pair.
|
||||
$existing = ProductOptionValue::query()
|
||||
->where('product_option_id', $option->id)
|
||||
->get()
|
||||
->first(fn (ProductOptionValue $optionValue) => Str::slug($optionValue->translate('name')) === $slug);
|
||||
|
||||
return $existing ?? ProductOptionValue::create([
|
||||
'product_option_id' => $option->id,
|
||||
'name' => [DefaultLocale::code() => $value],
|
||||
]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Lunar\Models\Attribute;
|
||||
use Lunar\Models\Product;
|
||||
use Lunar\Models\ProductType;
|
||||
|
||||
class ProductTypeResolver
|
||||
{
|
||||
private const DEFAULT_NAME = 'General';
|
||||
|
||||
public function resolve(?string $type): ProductType
|
||||
{
|
||||
$name = trim((string) $type) !== '' ? trim($type) : self::DEFAULT_NAME;
|
||||
|
||||
$existing = ProductType::where('name', $name)->first();
|
||||
|
||||
if ($existing) {
|
||||
return $existing;
|
||||
}
|
||||
|
||||
$productType = ProductType::create(['name' => $name]);
|
||||
|
||||
$productType->mappedAttributes()->attach(
|
||||
Attribute::whereAttributeType(Product::morphName())->pluck('id'),
|
||||
);
|
||||
|
||||
return $productType;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Str;
|
||||
use Lunar\Models\Product;
|
||||
use Lunar\Models\Tag;
|
||||
|
||||
class TagResolver
|
||||
{
|
||||
public function resolve(Product $product, ?string $tags): void
|
||||
{
|
||||
$values = collect(explode(',', (string) $tags))
|
||||
->map(fn (string $tag) => trim($tag))
|
||||
->filter();
|
||||
|
||||
$this->sync($product, $values);
|
||||
}
|
||||
|
||||
private function sync(Product $product, Collection $tags): void
|
||||
{
|
||||
$tagIds = $tags
|
||||
->map(fn (string $tag) => Str::upper($tag))
|
||||
->map(fn (string $tag) => Tag::firstOrCreate(['value' => $tag])->id);
|
||||
|
||||
$product->tags()->sync($tagIds);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
||||
|
||||
use Lunar\Models\TaxClass;
|
||||
|
||||
class TaxClassResolver
|
||||
{
|
||||
public function resolve(bool $taxable): TaxClass
|
||||
{
|
||||
return TaxClass::getDefault();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify;
|
||||
|
||||
class ShopifyCsvReader
|
||||
{
|
||||
/**
|
||||
* @return array<int, ProductGroup>
|
||||
*/
|
||||
public function read(string $csvPath): array
|
||||
{
|
||||
$handle = fopen($csvPath, 'r');
|
||||
|
||||
if ($handle === false) {
|
||||
throw new \RuntimeException("Could not open CSV file: {$csvPath}");
|
||||
}
|
||||
|
||||
$headers = fgetcsv($handle);
|
||||
|
||||
/** @var array<string, ProductGroup> $groups */
|
||||
$groups = [];
|
||||
$order = [];
|
||||
|
||||
while (($row = fgetcsv($handle)) !== false) {
|
||||
$data = array_combine($headers, $row);
|
||||
$productHandle = trim($data['Handle'] ?? '');
|
||||
|
||||
if ($productHandle === '') {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (! isset($groups[$productHandle])) {
|
||||
$groups[$productHandle] = new ProductGroup($productHandle, $data);
|
||||
$order[] = $productHandle;
|
||||
}
|
||||
|
||||
$group = $groups[$productHandle];
|
||||
|
||||
$hasVariantData = trim((string) ($data['Option1 Value'] ?? '')) !== ''
|
||||
|| trim((string) ($data['Variant SKU'] ?? '')) !== '';
|
||||
|
||||
if ($hasVariantData) {
|
||||
$group->variantRows[] = $data;
|
||||
}
|
||||
|
||||
if (trim((string) ($data['Image Src'] ?? '')) !== '') {
|
||||
$group->imageRows[] = $data;
|
||||
}
|
||||
}
|
||||
|
||||
fclose($handle);
|
||||
|
||||
return array_map(fn (string $handle) => $groups[$handle], $order);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,238 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\MigrateImport\Shopify;
|
||||
|
||||
use Illuminate\Support\Facades\Log;
|
||||
use Lunar\Models\Collection;
|
||||
use Lunar\Models\CollectionGroup;
|
||||
use Lunar\Models\Currency;
|
||||
use Lunar\Models\Language;
|
||||
use Lunar\Models\Product;
|
||||
use Lunar\Models\ProductVariant;
|
||||
use Lunar\Models\Url;
|
||||
use Modules\Core\MigrateImport\ImportSpec;
|
||||
use Modules\Core\MigrateImport\Importer;
|
||||
use Modules\Core\MigrateImport\Models\ImportMapping;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\AssetResolver;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\BrandResolver;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\CollectionResolver;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\ImportAttributeResolver;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\PriceResolver;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\ProductAttributeResolver;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\ProductOptionResolver;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\ProductTypeResolver;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\TagResolver;
|
||||
use Modules\Core\MigrateImport\Shopify\Resolvers\TaxClassResolver;
|
||||
|
||||
class ShopifyExportImporter implements Importer
|
||||
{
|
||||
private const SOURCE = 'shopify';
|
||||
|
||||
public function __construct(
|
||||
private readonly ShopifyCsvReader $csvReader = new ShopifyCsvReader(),
|
||||
private readonly TaxClassResolver $taxClassResolver = new TaxClassResolver(),
|
||||
private readonly ProductTypeResolver $productTypeResolver = new ProductTypeResolver(),
|
||||
private readonly BrandResolver $brandResolver = new BrandResolver(),
|
||||
private readonly TagResolver $tagResolver = new TagResolver(),
|
||||
private readonly CollectionResolver $collectionResolver = new CollectionResolver(),
|
||||
private readonly ProductOptionResolver $productOptionResolver = new ProductOptionResolver(),
|
||||
private readonly AssetResolver $assetResolver = new AssetResolver(),
|
||||
private readonly PriceResolver $priceResolver = new PriceResolver(),
|
||||
private readonly ImportAttributeResolver $importAttributeResolver = new ImportAttributeResolver(),
|
||||
private readonly ProductAttributeResolver $productAttributeResolver = new ProductAttributeResolver(),
|
||||
) {
|
||||
}
|
||||
|
||||
public function import(ImportSpec $spec): void
|
||||
{
|
||||
$groups = $this->csvReader->read($spec->filePath);
|
||||
$imagesPath = dirname($spec->filePath).'/files';
|
||||
$collectionGroup = CollectionGroup::firstOrCreate(
|
||||
['handle' => 'shopify'],
|
||||
['name' => 'Shopify'],
|
||||
);
|
||||
$currency = Currency::getDefault();
|
||||
|
||||
foreach ($groups as $group) {
|
||||
$this->importProduct($group, $imagesPath, $collectionGroup, $currency);
|
||||
}
|
||||
}
|
||||
|
||||
private function importProduct(
|
||||
ProductGroup $group,
|
||||
string $imagesPath,
|
||||
CollectionGroup $collectionGroup,
|
||||
Currency $currency,
|
||||
): void {
|
||||
$row = $group->productRow;
|
||||
|
||||
$taxClass = $this->taxClassResolver->resolve(
|
||||
filter_var($row['Variant Taxable'] ?? 'true', FILTER_VALIDATE_BOOLEAN),
|
||||
);
|
||||
$productType = $this->productTypeResolver->resolve($row['Type'] ?? null);
|
||||
$brand = $this->brandResolver->resolve($row['Vendor'] ?? null);
|
||||
|
||||
$this->importAttributeResolver->ensureMapped($productType);
|
||||
|
||||
$attributeData = $this->productAttributeResolver->resolve($productType->fresh(), [
|
||||
'name' => $row['Title'] ?? '',
|
||||
'description' => $row['Body (HTML)'] ?? '',
|
||||
'cost_per_item' => $row['Cost per item'] ?? '',
|
||||
'seo_title' => $row['SEO Title'] ?? '',
|
||||
'seo_description' => $row['SEO Description'] ?? '',
|
||||
]);
|
||||
|
||||
$existing = ImportMapping::resolve(self::SOURCE, 'product', $group->handle);
|
||||
|
||||
$product = $existing instanceof Product ? $existing : new Product();
|
||||
$product->product_type_id = $productType->id;
|
||||
$product->status = filter_var($row['Published'] ?? 'true', FILTER_VALIDATE_BOOLEAN) ? 'published' : 'draft';
|
||||
$product->brand_id = $brand?->id;
|
||||
$product->attribute_data = array_merge($product->attribute_data?->toArray() ?? [], $attributeData);
|
||||
$product->save();
|
||||
|
||||
ImportMapping::record(self::SOURCE, 'product', $group->handle, $product);
|
||||
|
||||
Url::updateOrCreate(
|
||||
[
|
||||
'element_type' => $product->getMorphClass(),
|
||||
'element_id' => $product->id,
|
||||
'language_id' => Language::getDefault()->id,
|
||||
],
|
||||
[
|
||||
'slug' => $group->handle,
|
||||
'default' => true,
|
||||
],
|
||||
);
|
||||
|
||||
$this->tagResolver->resolve($product, $row['Tags'] ?? null);
|
||||
$this->collectionResolver->resolve($product, $collectionGroup, $row['Product Category'] ?? null);
|
||||
|
||||
$options = $this->attachOptions($product, $row);
|
||||
|
||||
foreach ($group->variantRows as $index => $variantRow) {
|
||||
$this->importVariant($product, $group->handle, $index, $variantRow, $taxClass, $currency, $options);
|
||||
}
|
||||
|
||||
foreach ($group->imageRows as $index => $imageRow) {
|
||||
$this->importImage($product, $group->handle, $index, $imageRow, $imagesPath);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, \Lunar\Models\ProductOption>
|
||||
*/
|
||||
private function attachOptions(Product $product, array $row): array
|
||||
{
|
||||
$options = [];
|
||||
|
||||
foreach ([1, 2, 3] as $position) {
|
||||
$name = trim((string) ($row["Option{$position} Name"] ?? ''));
|
||||
|
||||
if ($name === '' || $name === 'Title') {
|
||||
continue;
|
||||
}
|
||||
|
||||
$option = $this->productOptionResolver->resolveOption($name);
|
||||
$product->productOptions()->syncWithoutDetaching([$option->id => ['position' => $position]]);
|
||||
$options[$position] = $option;
|
||||
}
|
||||
|
||||
return $options;
|
||||
}
|
||||
|
||||
private function importVariant(
|
||||
Product $product,
|
||||
string $handle,
|
||||
int $index,
|
||||
array $row,
|
||||
\Lunar\Models\TaxClass $taxClass,
|
||||
Currency $currency,
|
||||
array $options,
|
||||
): void {
|
||||
$externalId = "{$handle}#{$index}";
|
||||
$existing = ImportMapping::resolve(self::SOURCE, 'variant', $externalId);
|
||||
|
||||
$variant = $existing instanceof ProductVariant ? $existing : new ProductVariant();
|
||||
$variant->product_id = $product->id;
|
||||
$variant->tax_class_id = $taxClass->id;
|
||||
$variant->sku = trim((string) ($row['Variant SKU'] ?? '')) ?: null;
|
||||
$variant->stock = (int) ($row['Variant Inventory Qty'] ?? 0);
|
||||
$variant->shippable = filter_var($row['Variant Requires Shipping'] ?? 'true', FILTER_VALIDATE_BOOLEAN);
|
||||
$variant->save();
|
||||
|
||||
ImportMapping::record(self::SOURCE, 'variant', $externalId, $variant);
|
||||
|
||||
foreach ($options as $position => $option) {
|
||||
$value = trim((string) ($row["Option{$position} Value"] ?? ''));
|
||||
|
||||
if ($value === '') {
|
||||
continue;
|
||||
}
|
||||
|
||||
$optionValue = $this->productOptionResolver->resolveValue($option, $value);
|
||||
$variant->values()->syncWithoutDetaching([$optionValue->id]);
|
||||
}
|
||||
|
||||
$price = (float) ($row['Variant Price'] ?? 0);
|
||||
$comparePrice = trim((string) ($row['Variant Compare At Price'] ?? '')) !== ''
|
||||
? (float) $row['Variant Compare At Price']
|
||||
: null;
|
||||
|
||||
$this->priceResolver->resolve($variant, $currency, $price, $comparePrice);
|
||||
}
|
||||
|
||||
private function importImage(
|
||||
Product $product,
|
||||
string $handle,
|
||||
int $index,
|
||||
array $row,
|
||||
string $imagesPath,
|
||||
): void {
|
||||
$externalId = $row['Image Src'] ?: "{$handle}#image-{$index}";
|
||||
$position = (int) ($row['Image Position'] ?? $index + 1);
|
||||
|
||||
if (ImportMapping::resolve(self::SOURCE, 'image', $externalId)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$localFile = $this->findLocalFile($imagesPath, $row['Image Src']);
|
||||
|
||||
if ($localFile === null) {
|
||||
Log::warning('Shopify import: image file not found', [
|
||||
'handle' => $handle,
|
||||
'image_src' => $row['Image Src'],
|
||||
]);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$media = $this->assetResolver->resolve($product, $localFile, $position);
|
||||
|
||||
if ($media) {
|
||||
ImportMapping::record(self::SOURCE, 'image', $externalId, $product);
|
||||
}
|
||||
}
|
||||
|
||||
private function findLocalFile(string $imagesPath, string $imageSrc): ?string
|
||||
{
|
||||
$imagesPath = rtrim($imagesPath, '/');
|
||||
$filename = basename(parse_url($imageSrc, PHP_URL_PATH) ?? '');
|
||||
|
||||
// Shopify CDN filenames often embed a UUID (e.g. "1_ab5a6923-...-b130c6.jpg").
|
||||
// Export folders name files by that UUID alone, so try matching on it
|
||||
// before falling back to an exact filename match.
|
||||
if (preg_match('/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/i', $filename, $matches)) {
|
||||
$extension = pathinfo($filename, PATHINFO_EXTENSION);
|
||||
$byUuid = "{$imagesPath}/{$matches[0]}".($extension ? ".{$extension}" : '');
|
||||
|
||||
if (is_file($byUuid)) {
|
||||
return $byUuid;
|
||||
}
|
||||
}
|
||||
|
||||
$byFilename = "{$imagesPath}/{$filename}";
|
||||
|
||||
return is_file($byFilename) ? $byFilename : null;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\Contracts;
|
||||
|
||||
use Filament\Forms\Components\Component;
|
||||
|
||||
/**
|
||||
* A Product Option Type describes how a category of Lunar `ProductOption` (e.g.
|
||||
* "Color", "Size", "Material") behaves — namely, what structured data its values
|
||||
* carry in their free-form `meta` jsonb column, and how an admin edits that data.
|
||||
*
|
||||
* `ProductOption`/`ProductOptionValue` themselves stay exactly as Lunar defines
|
||||
* them — this is not a new model. `ProductOptionTypeManager` maps a
|
||||
* `ProductOption::handle` to the type describing it (via `config('core.product_option_types')`,
|
||||
* typed explicitly by the admin), so adding a new kind of option is a single new
|
||||
* class, not scattered per-option special-casing across the admin UI or storefront.
|
||||
*/
|
||||
interface ProductOptionTypeInterface
|
||||
{
|
||||
/**
|
||||
* Matches the ProductOption::handle this type describes (e.g. 'color', 'size').
|
||||
*/
|
||||
public static function getKey(): string;
|
||||
|
||||
/**
|
||||
* Filament form components for editing a ProductOptionValue's `meta` under this
|
||||
* option type — e.g. Color returns a color picker for `meta.hex`, Size returns a
|
||||
* numeric input for `meta.sort_value`. Field names should be dot-notation under
|
||||
* `meta` (e.g. `meta.hex`), matching where ValuesRelationManagerExtension saves them.
|
||||
*
|
||||
* @return array<Component>
|
||||
*/
|
||||
public function getMetaForm(): array;
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\DTOs;
|
||||
|
||||
/**
|
||||
* Filter input for ProductService::list(). All fields are optional — omitted
|
||||
* filters are simply not added to the Meilisearch query. Values are matched
|
||||
* against Modules\Core\Product\Services\ProductIndexer's document fields, so
|
||||
* filtering only works on stores where that indexer is registered and the index
|
||||
* has been re-synced (see docs/product-listing.md).
|
||||
*/
|
||||
class ProductFilters
|
||||
{
|
||||
public function __construct(
|
||||
public readonly ?int $collectionId = null,
|
||||
public readonly ?string $brand = null,
|
||||
public readonly ?float $minPrice = null,
|
||||
public readonly ?float $maxPrice = null,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\Enums;
|
||||
|
||||
/**
|
||||
* Sort options for ProductService::list(), each mapped to a Meilisearch `sort`
|
||||
* clause against a field indexed as sortable by Modules\Core\Product\Services\
|
||||
* ProductIndexer (see its getSortableFields()). Adding a case here requires the
|
||||
* matching field to also be sortable in the index, re-synced via
|
||||
* `php artisan lunar:meilisearch:setup`.
|
||||
*/
|
||||
enum ProductSort: string
|
||||
{
|
||||
case PriceAsc = 'price_asc';
|
||||
case PriceDesc = 'price_desc';
|
||||
case Newest = 'newest';
|
||||
|
||||
public function toMeilisearchSort(): string
|
||||
{
|
||||
return match ($this) {
|
||||
self::PriceAsc => 'price:asc',
|
||||
self::PriceDesc => 'price:desc',
|
||||
self::Newest => 'created_at:desc',
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\Filament\Extensions;
|
||||
|
||||
use Filament\Forms\Components\Select;
|
||||
use Filament\Forms\Form;
|
||||
use Illuminate\Support\Str;
|
||||
use Lunar\Admin\Support\Extending\ResourceExtension;
|
||||
use Modules\Core\Product\Services\ProductOptionTypeManager;
|
||||
|
||||
/**
|
||||
* Adds an "Option Type" dropdown to Lunar's own ProductOptionResource form, letting
|
||||
* an admin pick which registered `ProductOptionTypeInterface` (if any) describes this
|
||||
* option's values — e.g. "Color" — independent of the option's own `handle`. The
|
||||
* selection is saved to `ProductOption::meta['option_type']`.
|
||||
*/
|
||||
class ProductOptionResourceExtension extends ResourceExtension
|
||||
{
|
||||
public function extendForm(Form $form): Form
|
||||
{
|
||||
$options = app(ProductOptionTypeManager::class)->all()
|
||||
->keys()
|
||||
->mapWithKeys(fn (string $key) => [$key => Str::headline($key)])
|
||||
->all();
|
||||
|
||||
if ($options === []) {
|
||||
return $form;
|
||||
}
|
||||
|
||||
return $form->schema([
|
||||
...$form->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),
|
||||
]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\Filament\Extensions;
|
||||
|
||||
use Filament\Forms\Form;
|
||||
use Lunar\Admin\Support\Extending\RelationManagerExtension;
|
||||
use Lunar\Models\ProductOption;
|
||||
use Modules\Core\Product\Services\ProductOptionTypeManager;
|
||||
|
||||
/**
|
||||
* Appends the owning `ProductOption`'s registered `ProductOptionTypeInterface` meta
|
||||
* form (if any) to Lunar's own ValuesRelationManager form, so e.g. a "color" option
|
||||
* gets a hex-color picker for each value alongside the stock name field — without
|
||||
* forking Lunar's relation manager.
|
||||
*/
|
||||
class ValuesRelationManagerExtension extends RelationManagerExtension
|
||||
{
|
||||
public function extendForm(Form $form): Form
|
||||
{
|
||||
/** @var ProductOption $option */
|
||||
$option = $this->caller->getOwnerRecord();
|
||||
|
||||
$type = app(ProductOptionTypeManager::class)->resolve($option->meta['option_type'] ?? null);
|
||||
|
||||
if ($type === null) {
|
||||
return $form;
|
||||
}
|
||||
|
||||
return $form->schema([
|
||||
...$form->getComponents(),
|
||||
...$type->getMetaForm(),
|
||||
]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\Observers;
|
||||
|
||||
use Illuminate\Support\Facades\DB;
|
||||
use Lunar\Models\Product;
|
||||
use Lunar\Models\ProductOption;
|
||||
use Lunar\Models\ProductOptionValue;
|
||||
use Lunar\Models\ProductVariant;
|
||||
|
||||
/**
|
||||
* Keeps every product using a ProductOption/ProductOptionValue in sync with
|
||||
* Meilisearch. ProductIndexer::mapVariant() embeds each option value's `meta`
|
||||
* (e.g. a color's hex) directly into the product's indexed document — but saving
|
||||
* the option or one of its values never fires the *product's* own save/update
|
||||
* events, so without this, a changed option_type or a changed hex would only
|
||||
* reach the index on that product's next unrelated reindex.
|
||||
*/
|
||||
class ProductOptionReindexObserver
|
||||
{
|
||||
public function optionSaved(ProductOption $option): void
|
||||
{
|
||||
$this->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();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\OptionTypes;
|
||||
|
||||
use Filament\Forms\Components\ColorPicker;
|
||||
use Modules\Core\Product\Contracts\ProductOptionTypeInterface;
|
||||
|
||||
/**
|
||||
* Reference implementation: describes a 'color' ProductOption's values as
|
||||
* carrying a hex code in `meta.hex`, editable via a Filament color picker.
|
||||
* Not auto-registered — a shop opts in via config('core.product_option_types').
|
||||
*/
|
||||
class ColorOptionType implements ProductOptionTypeInterface
|
||||
{
|
||||
public static function getKey(): string
|
||||
{
|
||||
return 'color';
|
||||
}
|
||||
|
||||
public function getMetaForm(): array
|
||||
{
|
||||
return [
|
||||
ColorPicker::make('meta.hex')
|
||||
->label('Color')
|
||||
->required(),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,193 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\Services;
|
||||
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Lunar\Models\Currency;
|
||||
use Lunar\Models\Price;
|
||||
use Lunar\Models\Product;
|
||||
use Lunar\Models\ProductVariant;
|
||||
use Lunar\Search\ProductIndexer as BaseProductIndexer;
|
||||
use Modules\Core\Review\Models\ProductReview;
|
||||
use Spatie\MediaLibrary\MediaCollections\Models\Media;
|
||||
|
||||
/**
|
||||
* Extends Lunar's own indexer so Modules\Core\Product\Services\ProductService can
|
||||
* serve both listing/filtering AND single-product lookups from Meilisearch alone —
|
||||
* one data source, no separate database read path for a product detail page. Adds:
|
||||
* - collections (ids, filterable) and collection_names (display)
|
||||
* - slugs (every locale's Url::slug for the product, filterable) — lets
|
||||
* ProductService::getBySlug() resolve a product from the index directly, with
|
||||
* no database read at all
|
||||
* - price (cheapest variant, filterable) and full per-variant pricing
|
||||
* - variants: sku, stock, purchasable, option values, prices, media
|
||||
* - the full media gallery (not just the single thumbnail Lunar's base indexer sends)
|
||||
* - tags
|
||||
* - reviews: public-safe fields only (see mapReview() — reviewer_email is deliberately
|
||||
* excluded, it's PII with no storefront use), including staff replies, plus an
|
||||
* average rating
|
||||
* - channel_ids (filterable) — Lunar's base indexer only indexes "status" as
|
||||
* filterable, not channel assignment, so search results can't otherwise be
|
||||
* scoped to products actually assigned+enabled on the current sales channel
|
||||
*
|
||||
* A review is created/edited independently of its product (Modules\Core\Providers\
|
||||
* ReviewServiceProvider re-indexes the product on review create/update/delete), so
|
||||
* this data doesn't go stale between full reindexes.
|
||||
*
|
||||
* New fields aren't filterable 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 — see docs/product-listing.md. If SCOUT_QUEUE is enabled, the
|
||||
* queue worker also needs restarting after deploying changes to this class (see
|
||||
* docs/lunar.md "Gotchas" — a running worker keeps stale indexer code in memory).
|
||||
*/
|
||||
class ProductIndexer extends BaseProductIndexer
|
||||
{
|
||||
public function getFilterableFields(): array
|
||||
{
|
||||
return [
|
||||
...parent::getFilterableFields(),
|
||||
'id',
|
||||
'brand',
|
||||
'collections',
|
||||
'price',
|
||||
'slugs',
|
||||
'channel_ids',
|
||||
];
|
||||
}
|
||||
|
||||
public function getSortableFields(): array
|
||||
{
|
||||
return [
|
||||
...parent::getSortableFields(),
|
||||
'price',
|
||||
];
|
||||
}
|
||||
|
||||
public function makeAllSearchableUsing(Builder $query): Builder
|
||||
{
|
||||
return parent::makeAllSearchableUsing($query)->with([
|
||||
'collections',
|
||||
'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->pluck('id')->map(fn ($id) => (string) $id)->all();
|
||||
$data['collection_names'] = $model->collections->map(fn ($collection) => $collection->translateAttribute('name'))->all();
|
||||
$data['slugs'] = $model->urls->pluck('slug')->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'] = $reviews->map(fn (ProductReview $review) => $this->mapReview($review))->all();
|
||||
$data['review_count'] = $reviews->count();
|
||||
$data['average_rating'] = $reviews->isEmpty() ? null : round($reviews->avg('rating'), 1);
|
||||
$data['channel_ids'] = $model->channels()
|
||||
->wherePivot('enabled', true)
|
||||
->pluck('lunar_channels.id')
|
||||
->toArray();
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
private function mapVariant(ProductVariant $variant, Currency $currency): array
|
||||
{
|
||||
return [
|
||||
'id' => $variant->id,
|
||||
'sku' => $variant->sku,
|
||||
'stock' => $variant->stock,
|
||||
'purchasable' => $variant->purchasable,
|
||||
'options' => $variant->values->map(fn ($value) => [
|
||||
'option' => $this->translatedName($value->option->name),
|
||||
'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;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\Services;
|
||||
|
||||
use Illuminate\Support\Collection;
|
||||
use Modules\Core\Product\Contracts\ProductOptionTypeInterface;
|
||||
|
||||
/**
|
||||
* Resolves an admin-selected option type key to the `ProductOptionTypeInterface`
|
||||
* describing it. The selection (which key a given `Lunar\Models\ProductOption` uses)
|
||||
* is stored per-option in `ProductOption::meta['option_type']` — deliberately not
|
||||
* tied to the option's `handle`, since a shop's own handle naming (e.g. transliterated
|
||||
* Greek, legacy imports) shouldn't have to match a type's key.
|
||||
*
|
||||
* The available keys come from `config('core.product_option_types')` — a plain list,
|
||||
* not a config array, because the mapping from option to type is an admin's per-option
|
||||
* choice made in the UI (see ValuesRelationManagerExtension/ProductOptionResourceExtension),
|
||||
* not something config alone can express.
|
||||
*/
|
||||
class ProductOptionTypeManager
|
||||
{
|
||||
/**
|
||||
* @return Collection<string, ProductOptionTypeInterface> keyed by getKey()
|
||||
*/
|
||||
public function all(): Collection
|
||||
{
|
||||
return collect(config('core.product_option_types', []))
|
||||
->map(fn (string $class) => app($class))
|
||||
->keyBy(fn (ProductOptionTypeInterface $type) => $type::getKey());
|
||||
}
|
||||
|
||||
public function resolve(?string $key): ?ProductOptionTypeInterface
|
||||
{
|
||||
if ($key === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $this->all()->get($key);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\Services;
|
||||
|
||||
use Illuminate\Database\Eloquent\Collection;
|
||||
use Illuminate\Support\Facades\App;
|
||||
use Lunar\Facades\AttributeManifest;
|
||||
use Lunar\Models\Language;
|
||||
use Lunar\Models\Product;
|
||||
|
||||
/**
|
||||
* Lunar's Meilisearch indexer flattens translated attributes into locale-suffixed
|
||||
* fields on a single document (name_en, name_el, description_en, description_el —
|
||||
* see Lunar\Search\ScoutIndexer::mapSearchableAttributes()), not separate indexes
|
||||
* or a filterable locale field. Locale-aware search means choosing which fields
|
||||
* to search on, not filtering results by locale.
|
||||
*/
|
||||
class ProductSearchService
|
||||
{
|
||||
/**
|
||||
* @return Collection<int, Product>
|
||||
*/
|
||||
public function search(string $query, ?string $locale = null): Collection
|
||||
{
|
||||
$locale ??= App::getLocale();
|
||||
$defaultLocale = Language::getDefault()->code;
|
||||
|
||||
return Product::search($query)
|
||||
->options([
|
||||
'attributesToSearchOn' => $this->searchableFields($locale, $defaultLocale),
|
||||
])
|
||||
->get();
|
||||
}
|
||||
|
||||
/**
|
||||
* Target the resolved locale's fields plus the default locale's fields, so a
|
||||
* product that's only ever been translated into the default language still
|
||||
* surfaces when searched in another locale, instead of becoming invisible
|
||||
* until every product is fully translated.
|
||||
*
|
||||
* @return array<int, string>
|
||||
*/
|
||||
private function searchableFields(string $locale, string $defaultLocale): array
|
||||
{
|
||||
$handles = AttributeManifest::getSearchableAttributes(Product::morphName())
|
||||
->pluck('handle');
|
||||
|
||||
$locales = array_unique([$locale, $defaultLocale]);
|
||||
|
||||
return $handles
|
||||
->crossJoin($locales)
|
||||
->map(fn (array $pair) => "{$pair[0]}_{$pair[1]}")
|
||||
->values()
|
||||
->all();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,168 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Product\Services;
|
||||
|
||||
use Illuminate\Contracts\Pagination\LengthAwarePaginator as LengthAwarePaginatorContract;
|
||||
use Illuminate\Pagination\LengthAwarePaginator;
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Facades\App;
|
||||
use Lunar\Base\AttributeManifest;
|
||||
use Lunar\FieldTypes\TranslatedText;
|
||||
use Lunar\Models\Product;
|
||||
use Modules\Core\Localization\Services\LanguageCache;
|
||||
use Modules\Core\Product\DTOs\ProductFilters;
|
||||
use Modules\Core\Product\Enums\ProductSort;
|
||||
|
||||
/**
|
||||
* Storefront product listing/filtering AND single-product lookup, all reading directly
|
||||
* from the Meilisearch index (Modules\Core\Product\Services\ProductIndexer) - one data
|
||||
* source, no ->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\Product\Services\
|
||||
* ProductSearchService; this service is for browsing/filtering without a search term.
|
||||
*/
|
||||
class ProductService
|
||||
{
|
||||
public function __construct(
|
||||
private readonly LanguageCache $languages,
|
||||
private readonly AttributeManifest $attributes,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Returns 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): LengthAwarePaginator
|
||||
{
|
||||
$options = ['filter' => $this->buildFilter($filters)];
|
||||
|
||||
if ($sort !== null) {
|
||||
$options['sort'] = [$sort->toMeilisearchSort()];
|
||||
}
|
||||
|
||||
$paginator = Product::search('')
|
||||
->options($options)
|
||||
->paginateRaw(perPage: $perPage, page: $page);
|
||||
|
||||
$data = collect($this->hitsFrom($paginator))
|
||||
->map(fn (array $product) => $this->withLocalizedFields($product))
|
||||
->all();
|
||||
|
||||
return new LengthAwarePaginator(
|
||||
items: $data,
|
||||
total: $paginator->total(),
|
||||
perPage: $paginator->perPage(),
|
||||
currentPage: $paginator->currentPage(),
|
||||
options: ['path' => LengthAwarePaginator::resolveCurrentPath()],
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Look up a single product by its URL slug (any locale - slugs are indexed across
|
||||
* all languages, see Modules\Core\Product\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}\"");
|
||||
}
|
||||
|
||||
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 every translated Product attribute's current-locale value from the
|
||||
* indexer's per-locale `{handle}_{locale}` fields (e.g. `name_el`, `name_en`,
|
||||
* `seo_title_el`, ...) into a plain `{handle}` key, falling back to the store's
|
||||
* default language (LanguageCache::defaultLocale()) when 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.
|
||||
*
|
||||
* Which handles are translated is read from AttributeManifest - the same
|
||||
* source Lunar's own ScoutIndexer reads when exploding a TranslatedText
|
||||
* attribute into `{handle}_{locale}` keys at index time - rather than a fixed
|
||||
* list, so a store's own custom translated attributes (e.g. `seo_title`) are
|
||||
* picked up automatically with no change here. The raw per-locale keys are
|
||||
* then stripped, since once resolved, callers only ever need the one that
|
||||
* matched the current locale.
|
||||
*
|
||||
* 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 = $this->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;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, string>
|
||||
*/
|
||||
private function translatedAttributeHandles(): array
|
||||
{
|
||||
return $this->attributes->getSearchableAttributes((new Product)->getMorphClass())
|
||||
->filter(fn ($attribute) => $attribute->type === TranslatedText::class)
|
||||
->pluck('handle')
|
||||
->all();
|
||||
}
|
||||
|
||||
/**
|
||||
* 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(LengthAwarePaginatorContract $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 ');
|
||||
}
|
||||
}
|
||||
@@ -8,6 +8,8 @@ use Modules\Core\Command\AnonymizeCommand;
|
||||
use Modules\Core\Command\ExportCleanupCommand;
|
||||
use Modules\Core\Command\ExportCommand;
|
||||
use Modules\Core\Command\ImportCommand;
|
||||
use Modules\Core\Command\InstallLunarCommand;
|
||||
use Modules\Core\Command\MigrateImportCommand;
|
||||
|
||||
class CoreServiceProvider extends ServiceProvider
|
||||
{
|
||||
@@ -24,6 +26,7 @@ class CoreServiceProvider extends ServiceProvider
|
||||
|
||||
$this->publishes([
|
||||
__DIR__ . '/../../config/core.php' => config_path('core.php'),
|
||||
__DIR__ . '/../../config/scout.php' => config_path('scout.php'),
|
||||
], 'core-config');
|
||||
|
||||
$this->publishes([
|
||||
@@ -32,7 +35,10 @@ class CoreServiceProvider extends ServiceProvider
|
||||
], 'core-assets');
|
||||
|
||||
if ($this->app->runningInConsole()) {
|
||||
$this->commands([AnonymizeCommand::class, ExportCommand::class, ExportCleanupCommand::class, ImportCommand::class]);
|
||||
$this->commands([AnonymizeCommand::class, ExportCommand::class, ExportCleanupCommand::class, ImportCommand::class, MigrateImportCommand::class]);
|
||||
|
||||
//Overriding lunar:install
|
||||
$this->app->booted(fn () => $this->commands([InstallLunarCommand::class]));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Providers;
|
||||
|
||||
use Illuminate\Support\Facades\Event;
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
use Lunar\Models\Language;
|
||||
use Modules\Core\Localization\Events\LanguageCreated;
|
||||
use Modules\Core\Localization\Events\LanguageDeleted;
|
||||
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||
use Modules\Core\Localization\Events\TranslationCreated;
|
||||
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||
use Modules\Core\Localization\Events\TranslationUpdated;
|
||||
use Modules\Core\Localization\Listeners\FlushLanguageCache;
|
||||
use Modules\Core\Localization\Listeners\FlushTranslationCache;
|
||||
use Modules\Core\Localization\Listeners\LogTranslationActivity;
|
||||
use Modules\Core\Localization\Listeners\MigrateTranslationsForRenamedLanguage;
|
||||
use Modules\Core\Localization\Middleware\LocaleMiddleware;
|
||||
use Modules\Core\Localization\Models\LanguageLine;
|
||||
use Modules\Core\Localization\Observers\LanguageCacheObserver;
|
||||
|
||||
class LocalizationServiceProvider extends ServiceProvider
|
||||
{
|
||||
public function register(): void
|
||||
{
|
||||
// Must run before Spatie\TranslationLoader\TranslationServiceProvider's
|
||||
// register() merges its own config defaults - mergeConfigFrom() only fills
|
||||
// in keys not already set, so setting this here (regardless of provider
|
||||
// boot order) makes it win over the package's default
|
||||
// Spatie\TranslationLoader\LanguageLine::class.
|
||||
config(['translation-loader.model' => LanguageLine::class]);
|
||||
}
|
||||
|
||||
public function boot(): void
|
||||
{
|
||||
$this->app['router']->aliasMiddleware('locale', LocaleMiddleware::class);
|
||||
Language::observe(LanguageCacheObserver::class);
|
||||
|
||||
foreach ([TranslationCreated::class, TranslationUpdated::class, TranslationDeleted::class] as $event) {
|
||||
Event::listen($event, FlushTranslationCache::class);
|
||||
Event::listen($event, LogTranslationActivity::class);
|
||||
}
|
||||
|
||||
foreach ([LanguageCreated::class, LanguageUpdated::class, LanguageDeleted::class] as $event) {
|
||||
Event::listen($event, FlushLanguageCache::class);
|
||||
}
|
||||
|
||||
Event::listen(LanguageUpdated::class, MigrateTranslationsForRenamedLanguage::class);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Providers;
|
||||
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
use Lunar\Models\ProductOption;
|
||||
use Lunar\Models\ProductOptionValue;
|
||||
use Modules\Core\Product\Observers\ProductOptionReindexObserver;
|
||||
|
||||
class ProductServiceProvider extends ServiceProvider
|
||||
{
|
||||
public function boot(): void
|
||||
{
|
||||
$observer = new ProductOptionReindexObserver;
|
||||
|
||||
ProductOption::saved(fn (ProductOption $option) => $observer->optionSaved($option));
|
||||
ProductOption::deleted(fn (ProductOption $option) => $observer->optionDeleted($option));
|
||||
|
||||
ProductOptionValue::saved(fn (ProductOptionValue $value) => $observer->valueSaved($value));
|
||||
ProductOptionValue::deleted(fn (ProductOptionValue $value) => $observer->valueDeleted($value));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Providers;
|
||||
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
use Modules\Core\Review\Models\ProductReview;
|
||||
|
||||
/**
|
||||
* Keeps a product's Meilisearch document in sync with its reviews. A review is
|
||||
* created/edited independently of its product (customer submission, staff reply),
|
||||
* so the product's own save/update events never fire for it — without this listener,
|
||||
* Modules\Core\Product\Services\ProductIndexer's review data would only refresh on
|
||||
* the next full product reindex.
|
||||
*/
|
||||
class ReviewServiceProvider extends ServiceProvider
|
||||
{
|
||||
public function boot(): void
|
||||
{
|
||||
ProductReview::created(fn (ProductReview $review) => $review->product?->searchable());
|
||||
ProductReview::updated(fn (ProductReview $review) => $review->product?->searchable());
|
||||
ProductReview::deleted(fn (ProductReview $review) => $review->product?->searchable());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Review\Extensions;
|
||||
|
||||
use Lunar\Admin\Support\Extending\ResourceExtension;
|
||||
use Modules\Core\Review\Pages\ManageProductReviews;
|
||||
|
||||
class ProductResourceExtension extends ResourceExtension
|
||||
{
|
||||
public function extendPages(array $pages): array
|
||||
{
|
||||
$pages['reviews'] = ManageProductReviews::route('/{record}/reviews');
|
||||
|
||||
return $pages;
|
||||
}
|
||||
|
||||
public function extendSubNavigation(array $pages): array
|
||||
{
|
||||
return [...$pages, ManageProductReviews::class];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Review\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
use Lunar\Models\Product;
|
||||
use Spatie\Image\Enums\BorderType;
|
||||
use Spatie\Image\Enums\Fit;
|
||||
use Spatie\MediaLibrary\HasMedia;
|
||||
use Spatie\MediaLibrary\InteractsWithMedia;
|
||||
use Spatie\MediaLibrary\MediaCollections\Models\Media;
|
||||
|
||||
class ProductReview extends Model implements HasMedia
|
||||
{
|
||||
use InteractsWithMedia;
|
||||
|
||||
public const IMAGES_COLLECTION = 'review-images';
|
||||
|
||||
protected $guarded = [];
|
||||
|
||||
protected $casts = [
|
||||
'reviewed_at' => 'datetime',
|
||||
'replied_at' => 'datetime',
|
||||
];
|
||||
|
||||
public function product(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(Product::class);
|
||||
}
|
||||
|
||||
public function registerMediaCollections(): void
|
||||
{
|
||||
$this->addMediaCollection(self::IMAGES_COLLECTION);
|
||||
}
|
||||
|
||||
/**
|
||||
* Unlike Product/ProductVariant, this model sits outside Lunar's own
|
||||
* MediaDefinitionsInterface (Lunar\Base\StandardMediaDefinitions), which is
|
||||
* what registers the 'small' conversion those models get automatically. Without
|
||||
* this, Modules\Core\Product\Services\ProductIndexer::mapMedia() — shared across
|
||||
* product, variant, and review media — throws Spatie\MediaLibrary\MediaCollections\
|
||||
* Exceptions\InvalidConversion the first time a review has an image, since
|
||||
* $media->getUrl('small') has no matching conversion to resolve.
|
||||
*/
|
||||
public function registerMediaConversions(?Media $media = null): void
|
||||
{
|
||||
$this->addMediaConversion('small')
|
||||
->fit(Fit::Fill, 300, 300)
|
||||
->border(0, BorderType::Overlay, color: '#FFF')
|
||||
->background('#FFF')
|
||||
->sharpen(10)
|
||||
->keepOriginalImageFormat();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,153 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Review\Pages;
|
||||
|
||||
use Filament\Forms\Components\Group;
|
||||
use Filament\Forms\Components\Placeholder;
|
||||
use Filament\Forms\Components\Textarea;
|
||||
use Filament\Forms\Components\TextInput;
|
||||
use Filament\Forms\Form;
|
||||
use Filament\Tables\Actions\Action;
|
||||
use Filament\Tables\Actions\DeleteAction;
|
||||
use Filament\Tables\Actions\DeleteBulkAction;
|
||||
use Filament\Tables\Actions\ViewAction;
|
||||
use Filament\Tables\Columns\TextColumn;
|
||||
use Filament\Tables\Table;
|
||||
use Illuminate\Support\Carbon;
|
||||
use Illuminate\Support\HtmlString;
|
||||
use Lunar\Admin\Filament\Resources\ProductResource;
|
||||
use Lunar\Admin\Support\Pages\BaseManageRelatedRecords;
|
||||
use Modules\Core\Review\Models\ProductReview;
|
||||
|
||||
class ManageProductReviews extends BaseManageRelatedRecords
|
||||
{
|
||||
protected static string $resource = ProductResource::class;
|
||||
|
||||
protected static string $relationship = 'reviews';
|
||||
|
||||
public static function getNavigationIcon(): ?string
|
||||
{
|
||||
return 'heroicon-o-star';
|
||||
}
|
||||
|
||||
public function getTitle(): string
|
||||
{
|
||||
return 'Reviews';
|
||||
}
|
||||
|
||||
public static function getNavigationLabel(): string
|
||||
{
|
||||
return 'Reviews';
|
||||
}
|
||||
|
||||
public function form(Form $form): Form
|
||||
{
|
||||
return $form
|
||||
->schema([
|
||||
TextInput::make('rating')
|
||||
->label('Rating')
|
||||
->disabled(),
|
||||
TextInput::make('title')
|
||||
->label('Title')
|
||||
->disabled(),
|
||||
Textarea::make('body')
|
||||
->label('Body')
|
||||
->disabled()
|
||||
->columnSpanFull(),
|
||||
Group::make([
|
||||
TextInput::make('reviewer_name')
|
||||
->label('Reviewer name')
|
||||
->disabled(),
|
||||
TextInput::make('reviewer_email')
|
||||
->label('Reviewer email')
|
||||
->disabled(),
|
||||
])->columns(2),
|
||||
Group::make([
|
||||
TextInput::make('location')
|
||||
->label('Location')
|
||||
->disabled(),
|
||||
TextInput::make('source')
|
||||
->label('Source')
|
||||
->disabled(),
|
||||
])->columns(2),
|
||||
Group::make([
|
||||
TextInput::make('reviewed_at')
|
||||
->label('Reviewed at')
|
||||
->disabled(),
|
||||
TextInput::make('replied_at')
|
||||
->label('Replied at')
|
||||
->disabled(),
|
||||
])->columns(2),
|
||||
Textarea::make('reply')
|
||||
->label('Reply')
|
||||
->disabled()
|
||||
->columnSpanFull(),
|
||||
Placeholder::make('images')
|
||||
->label('Images')
|
||||
->content(function (?ProductReview $record) {
|
||||
if (! $record) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$media = $record->getMedia(ProductReview::IMAGES_COLLECTION);
|
||||
|
||||
if ($media->isEmpty()) {
|
||||
return 'No images';
|
||||
}
|
||||
|
||||
$tags = $media->map(fn ($item) => sprintf(
|
||||
'<a href="%1$s" target="_blank"><img src="%1$s" style="height:6rem;width:6rem;object-fit:cover;border-radius:0.5rem;display:inline-block;margin:0.25rem" /></a>',
|
||||
$item->getUrl(),
|
||||
))->implode('');
|
||||
|
||||
return new HtmlString($tags);
|
||||
})
|
||||
->columnSpanFull(),
|
||||
]);
|
||||
}
|
||||
|
||||
public function table(Table $table): Table
|
||||
{
|
||||
return $table
|
||||
->recordTitleAttribute('title')
|
||||
->columns([
|
||||
TextColumn::make('rating')
|
||||
->label('Rating')
|
||||
->formatStateUsing(fn (int $state) => str_repeat('★', $state).str_repeat('☆', 5 - $state))
|
||||
->sortable(),
|
||||
TextColumn::make('title')
|
||||
->label('Title')
|
||||
->limit(40)
|
||||
->searchable(),
|
||||
TextColumn::make('reviewer_name')
|
||||
->label('Reviewer')
|
||||
->searchable(),
|
||||
])
|
||||
->defaultSort('reviewed_at', 'desc')
|
||||
->filters([
|
||||
//
|
||||
])
|
||||
->actions([
|
||||
ViewAction::make(),
|
||||
Action::make('reply')
|
||||
->label(fn (ProductReview $record) => $record->reply ? 'Edit reply' : 'Reply')
|
||||
->icon('heroicon-o-chat-bubble-left-right')
|
||||
->form([
|
||||
Textarea::make('reply')
|
||||
->label('Reply')
|
||||
->required(),
|
||||
])
|
||||
->fillForm(fn (ProductReview $record) => ['reply' => $record->reply])
|
||||
->action(function (ProductReview $record, array $data) {
|
||||
$record->update([
|
||||
'reply' => $data['reply'],
|
||||
'replied_at' => Carbon::now(),
|
||||
]);
|
||||
}),
|
||||
DeleteAction::make(),
|
||||
])
|
||||
->bulkActions([
|
||||
DeleteBulkAction::make(),
|
||||
]);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user