Light API 0.4.0 is a public beta: a minor release such as 0.5.0 may still break. What that means for your module
Light
Developer guideReference

Packages and compatibility

Every Light package, which ones install on their own and which come as a set, what a shop may leave off, the bridges to other modules with their version ranges, and the platforms each release is checked on.

Light ships as separate Composer packages, one per module, plus two metapackages that install the admin in one command. This page says which packages you can take apart, which always come together, and which other modules Light bridges to. Install Light has the commands.

The packages

PackageModuleKindIn distribution-nl
mrx/module-lightMrx_LightCore: the shell, pools, API, doctorYes
mrx/module-aiMrx_AiCore: AI texts and images, on disrex/module-aiYes
mrx/module-settingsMrx_SettingsCore: settings pages, users and permissionsYes
mrx/module-homeMrx_HomeCore: Home, setup guide, analyticsYes
mrx/module-ordersMrx_OrdersCore: orders, shipping, draft ordersYes
mrx/module-customersMrx_CustomersCore: customersYes
mrx/module-documentsMrx_DocumentsCore: emails and PDFs, on dompdf/dompdfYes
mrx/module-locationsMrx_LocationsCore: locations and pickup, on Magento's inventoryThrough Home, Orders and Catalog
mrx/module-catalogMrx_CatalogCore: products, categories, stockYes
mrx/module-contentMrx_ContentCore: pages, blocks, menusYes
mrx/module-discountsMrx_DiscountsCore: discounts and codesYes
mrx/module-appsMrx_AppsCore: Apps, pins, the module finderYes
mrx/module-themesMrx_ThemesCore: admin themesYes
mrx/module-returnsMrx_ReturnsAdd-on: returns, on mage-os/module-rmaNo, suggested
mrx/module-country-nlMrx_CountryNlPack: Dutch facts (VAT, KvK, PostNL, iDEAL wording)Yes
mrx/module-payments-mollieMrx_PaymentsMollieBridge: MollieYes
mrx/module-payments-paynlMrx_PaymentsPaynlBridge: Pay.Yes
mrx/module-shipping-matrixrateMrx_ShippingMatrixrateBridge: rate tables (MatrixRate)No
magerex/module-flex-bridgeMageRex_FlexBridgeBridge: Disrex Flex EditorNo
magerex/light-brandingMageRex_BrandingBrand: the MageRex logo, sign-in page and default themeNo, suggested
magerex/module-supportMageRex_SupportMageRex support tickets (Freshdesk)Yes
mrx/module-content-hyvaMrx_ContentHyvaHyvä storefront parts of ContentOnly distribution-nl-hyva
mrx/module-discounts-hyvaMrx_DiscountsHyvaHyvä storefront parts of DiscountsOnly distribution-nl-hyva
mrx/module-settings-hyvaMrx_SettingsHyvaHyvä storefront parts of SettingsOnly distribution-nl-hyva
magerex/light-demo-dataMageRex_DemoDataDemo products, customers and ordersNo, never on a live shop

magerex/distribution-nl holds 17 Light modules, and magerex/distribution-nl-hyva adds the three Hyvä modules for 20. Both are white-label, and a metapackage for another country will be too: the MageRex brand is a package of its own (The MageRex brand). Every package of one release carries the same version, and its range on the others is ^0.4, so update them together (Updating).

What installs on its own

Eight core packages require each other, so Composer installs all eight when you require any one of them: Light, AI, Settings, Home, Orders, Customers, Documents and Locations. Every other package except AI and Discounts builds on that set:

  • Packages with no other Light requirements: mrx/module-light alone, mrx/module-ai with Light, and mrx/module-discounts with Light (plus mrx/module-discounts-hyva). Composer resolves these without the core set.
  • What the release checks cover: the two metapackages, and Returns, rate tables, the Flex bridge and the MageRex brand, each on top of a metapackage. A shop built from single packages, such as Light with Discounts only, resolves in Composer, but no release check has run it. Install a metapackage and leave modules off instead (next section).

What a shop may leave off

Each of these modules comes with magerex/distribution-nl, and no other Light module requires it. Leave it out of the module:enable line on the first install and it stays off:

ModuleWithout itChecked by
Mrx_CountryNlNeutral screens with no Dutch facts; the doctor warns country_pack on a Dutch shopcore-without-packs.spec.ts
Mrx_PaymentsMollieNo Mollie screens in Light; Mollie itself keeps working in the stock admincore-without-packs.spec.ts
Mrx_PaymentsPaynlNo Pay. screens in Lightcore-without-packs.spec.ts
MageRex_SupportNo Support page or ticketssupport.spec.ts covers it on

The MageRex brand is not in this list because no metapackage installs it: white-label.spec.ts and npm run guard:white-label check that the admin names no MageRex without it.

The code still installs, and so do Mollie and Pay. from Packagist, because the metapackage requires them. To drop the code as well, require the packages you want one by one instead of the metapackage.

Off from the start, or a dump first

MageRex_Support has its own table, and so do Light core modules such as Orders, Customers, Documents and Home. A setup:upgrade that runs while a module with tables is disabled and its code is still installed drops those tables. Leave such a module off from the first install, or dump the database before you disable it later. The core set and Catalog, Content, Discounts, Apps and Themes can't be left off: other Light modules need them.

Bridges to other modules

A bridge package connects Light to a module from another vendor. It requires that module in a tested range, and Composer refuses a version outside it:

BridgeBringsRangeIn a metapackageWhat Light adds
mrx/module-payments-molliemollie/magento2^3.1.4YesMollie in Settings > Payments, payment status on orders, refunds from Light
mrx/module-payments-paynlpaynl/magento2-plugin^4.0YesPay. in Settings > Payments, payment status on orders
mrx/module-shipping-matrixratewebshopapps/module-matrixrate~20.5.2No"How do you charge shipping?" per channel, the Rate table page with CSV import and export
mrx/module-returnsmage-os/module-rma^2.4.1No, suggestedReturns screens, the return slip, return mails
magerex/module-flex-bridgenone; suggests disrex/module-flex-coreFlexCore 2.0.26 testedNoThe Flex Editor banner on Home and pages, and cards in the category and product editors
mrx/module-content-hyva, -discounts-hyva, -settings-hyvahyva-themes/magento2-theme-module, hyva-themes/magento2-compat-module-fallbackany; Hyvä 1.4 and 1.5 testeddistribution-nl-hyvaStorefront parts on a Hyvä theme

Two of the core modules lean on another vendor too: Mrx_Ai on disrex/module-ai ^1.3, and Mrx_Documents on dompdf/dompdf ^3.1. Both come along with the core set.

  • Mollie and Pay. come from Packagist. A shop that also uses packages.disrex.nl excludes mollie/* and paynl/* there (The repository).
  • The Flex bridge shows nothing and answers 404 without FlexCore, so it is safe to install before Flex. FlexCore runs on Hyvä only (Flex shops).
  • MatrixRate and Returns keep data in their own tables. Read Rate tables and Returns before you take them out.

Optional Magento modules

Light runs without these, and uses them when the shop has them. They are the suggest entries of Light's packages:

Magento moduleUsed byWith it
Inventory (MSI), with In-Store PickupLocations, Catalog, OrdersStock per location and pickup at a location. Without MSI, or with one source, Light keeps one quantity per product (Stock and locations)
Page BuilderCatalog, ContentThe page editor notices Page Builder content and leaves it to Page Builder
Bundle and Grouped productsCatalogThose product types in the product list and editor
Gift messagesDocumentsThe gift message on PDFs and mails
mage-os/module-theme-adminhtml-switcherLight"Switch to advanced mode" opens the stock admin in the admin's own theme
mage-os/module-meta-robots-tagContentThe search engine setting on pages
mage-os/module-automatic-translationAITranslating content through AI

Platforms

WhatSupportedChecked per release
PlatformMage-OS 3.x, Magento Open Source 2.4.8 and 2.4.9. Not Adobe CommerceComposer resolves on Mage-OS 3.5.0, Magento 2.4.9 and 2.4.8-p5 (tests/release/resolve.sh)
PHP8.3, 8.4, 8.58.5 on Mage-OS 3.5.0 and Magento 2.4.9, 8.4 on Magento 2.4.8-p5
StorefrontLuma, or Hyvä with distribution-nl-hyvaLuma in the dev shop, Hyvä 1.4 and 1.5 on test shops
InventoryWithout MSI, MSI with one source, MSI with several sourcesinventory*.spec.ts, locations*.spec.ts
Two-factor sign-inOn or offauth-shell.spec.ts

Every release resolves magerex/distribution-nl, magerex/distribution-nl-hyva, mrx/module-shipping-matrixrate and magerex/module-flex-bridge from packages.disrex.nl on the three platforms before it counts as published.

A bridge for your own module

Your own module, or a third-party one, can join Light in the same way: in the module itself (pattern B), or in a separate <vendor>/module-<name>-light package (pattern A). Versioning explains both patterns and the range rule, and Upgrading the module behind your bridge covers new versions of the module you bridge to.

Last updated on

On this page