Plugin Presets

Presets register commonly used plugin bundles with the plugin registry. Call the registration function before startPlatform, which initializes their database modules and lifecycle hooks. The standard Express/Fastify connector mounts the plugins' HTTP routes, so each plugin needs no separate connector.

import { startPlatform } from '@unchainedshop/platform';
import { registerBasePlugins } from '@unchainedshop/plugins/presets/base';

registerBasePlugins();

const platform = await startPlatform({});

note

Import presets without a file extension (@unchainedshop/plugins/presets/base, not .../base.js) — the package exports map resolves the extensionless path.

Available Presets

Preset	Import	Function
Base	@unchainedshop/plugins/presets/base	registerBasePlugins()
Crypto	@unchainedshop/plugins/presets/crypto	registerCryptoPlugins()
All	@unchainedshop/plugins/presets/all	registerAllPlugins()
Switzerland	@unchainedshop/plugins/presets/countries/ch	registerSwissTaxPlugins()
European Union	@unchainedshop/plugins/presets/countries/eu	registerEuTaxPlugins()
United Kingdom	@unchainedshop/plugins/presets/countries/uk	registerUkTaxPlugins()
United States	@unchainedshop/plugins/presets/countries/us	registerUsSalesTaxPlugins()

Base Preset

Essential plugins for a minimal e-commerce setup:

• Files: GridFS (default storage backend), Temp Upload
• Payment: Invoice
• Delivery: Post
• Warehousing: Store, ERC Metadata
• Pricing: Free Payment, Free Delivery, Order Items, Order Discount, Order Delivery, Order Payment, Product Catalog Price, Product Discount
• Quotations: Manual
• Enrollments: Licensed
• Events: Node.js Event Emitter
• Workers: Bulk Import, Bulk Export, Zombie Killer, GC Guests, Invalidate Carts, Message, External, HTTP Request, Heartbeat, Email, Error Notifications

Crypto Preset

Cryptocurrency and token functionality. Does not include the base preset:

• Payment: Cryptopay (self-hosted crypto payments)
• Warehousing: ETH Minter (Ethereum token minting)
• Pricing: Product Price Rate Conversion
• Workers: Export Token, Update ECB Rates, Update Coinbase Rates, Update Token Ownership

import { registerBasePlugins } from '@unchainedshop/plugins/presets/base';
import { registerCryptoPlugins } from '@unchainedshop/plugins/presets/crypto';

registerBasePlugins();
registerCryptoPlugins();

All Preset

Registers the base, crypto, and Swiss tax presets plus:

• Payment: Datatrans v2, Stripe, Apple In-App Purchase, Payrexx, PostFinance Checkout, Saferpay, Invoice Prepaid
• Delivery: Send Message, Pick-Mup (store pickup)
• Filters: Strict Equal, Local Search
• Workers: Twilio SMS, BulkGate SMS, BudgetSMS, Push Notification, Enrollment Order Generator

Plugins that fail their onRegister configuration checks log a warning and skip their adapters and routes. This lets the all preset start with only the gateways you have configured. See plugin lifecycle behavior.

Country Presets

Each country preset registers product and delivery tax pricing plugins for its jurisdiction (ch: Swiss VAT, eu: EU VAT, uk: UK VAT, us: US sales tax). They contain only pricing plugins, so combine them with base:

import { registerBasePlugins } from '@unchainedshop/plugins/presets/base';
import { registerEuTaxPlugins } from '@unchainedshop/plugins/presets/countries/eu';

registerBasePlugins();
registerEuTaxPlugins();

Plugins Not Included in Any Preset

Register these individually with pluginRegistry.register:

• Minio / S3 file storage (@unchainedshop/plugins/files/minio) — register MinioPlugin instead of the base preset's GridFS plugin (the first registered file adapter wins)
• Example discount plugins (@unchainedshop/plugins/pricing/discount-half-price-manual, @unchainedshop/plugins/pricing/discount-100-off)

import { pluginRegistry } from '@unchainedshop/core';
import { HalfPriceManualPlugin } from '@unchainedshop/plugins/pricing/discount-half-price-manual';
import { HundredOffPlugin } from '@unchainedshop/plugins/pricing/discount-100-off';

pluginRegistry.register(HalfPriceManualPlugin);
pluginRegistry.register(HundredOffPlugin);

Custom Plugin Sets

Presets register fixed bundles and cannot leave out a single plugin. For a custom set, skip the preset and register the plugins you want individually; presets/base.ts is a good starting point. It also calls setEmitAdapter(NodeEventEmitter()), which a custom set has to do itself (or register another event emitter).

• registerAllPlugins() imports the crypto plugins, so it needs the optional @scure/* and @noble/* peer dependencies even if you do not use crypto payments.
• The first registered file adapter is the active file storage: register MinioPlugin before registerBasePlugins() to store files in MinIO/S3 (GridFS stays registered), or leave GridFS out of a custom set.
• Many plugins read their process.env configuration when they are imported, so load environment variables before importing plugins.

Best Practices

1. Start with Base: Begin with the base preset and add plugins as needed
2. Use All for Development: The all preset is great for development and testing all features
3. Production Optimization: In production, register only the plugins you need