CHANGELOG.md

2.1.0 (2023-10-11)

Fixes

• admin-ui Correctly display job retries (d3107fd), closes #1467
• admin-ui Fix back/forward nav issues with data table filters (58cb5a5)
• admin-ui Fix border colour of affixed input (e2cb74b)
• admin-ui Fix component for new Angular extension route API (6fe1bd0)
• admin-ui Fix error when data table filters not defined (2425a33)
• admin-ui Give all data table columns immutable ids (73a78db)
• admin-ui Improve RTL styles (056d205)
• admin-ui Limit FacetValues in Facet list component (b445955), closes #1257
• admin-ui Reinstate serialized filter state in url (a5bc0c1)
• admin-ui Update active filter preset on back/forward navigation (844876e)
• admin-ui Use correct defaults for nullable custom fields (#2360) (88430e5), closes #2360
• core Downgrade ForbiddenError from Error to Warn log level (c186392), closes #2383
• core Export EntityId and Money decorators (4664dee)
• core Fix circular dependency issue in SQLiteSearchStrategy (f2e2e32)
• core Fix resolution of facet valueList for postgres (1d8fe47)
• job-queue-plugin Correct behaviour of job list query with BullMQ (c148a92), closes #2120 #1327
• job-queue-plugin Correct retry setting for BullMQ jobs (972ba0e), closes #1467
• ui-devkit Fix scaffold logic for custom providers (2f2ddb5)

Features

• admin-ui Add data table filter presets functionality (a656ef2)
• admin-ui Add filter preset support to Collection list (cbfb402)
• admin-ui Add image carousel to asset preview dialog (#2370) (cd7b2bf), closes #2370 #2129
• admin-ui Add initial React support for UI extensions (1075dd7)
• admin-ui Add more native React UI components (04e03f8)
• admin-ui Add Persian/Farsi i18n messages (#2418) (1193863), closes #2418
• admin-ui Add useRouteParams react hook (b63fb7f)
• admin-ui Admin UI rtl with Arabic translation improvements (#2322) (44ea12b), closes #2322
• admin-ui Allow custom components in data table columns (d3474dd), closes #2347 #2353
• admin-ui Allow custom React components in data table columns (5cde775), closes #2347 #2353
• admin-ui Display original quantity after order has been modified (a36c6e0)
• admin-ui Enable Nepali translations (342fafa)
• admin-ui Expose providers to nav menu routerLink function (1bae40e)
• admin-ui Implement custom components in Collection data table (4ab7c1e)
• admin-ui Implement custom components in order detail data table (#2420) (e92e820), closes #2420
• admin-ui Implement drag-and-drop reorder of filter presets (8e06705)
• admin-ui Implement filter preset renaming (8b52e6f)
• admin-ui Implement job queue filtering by status (baeb036)
• admin-ui Implement react Card component (c588a1f)
• admin-ui Implement relative date filtering (d07a5f3)
• admin-ui Implement simplified API for UI route extensions (b9ca367)
• admin-ui Implement values pagination for Facet detail view (4cf1826), closes #1257
• admin-ui Improve dev mode extension point display (4678930)
• admin-ui Improve naming & layout of catalog & stock locations (8452300)
• admin-ui Improved control over ActionBar buttons (065a2b4)
• admin-ui Initial support for React UI extensions (83d5756)
• admin-ui Style improvements to table and form input borders (5287287)
• admin-ui Support for React-based custom detail components (55d9ffc)
• admin-ui Update to Angular v16.2 (608d5d3)
• cli Implement plugin scaffold command (a6df4c1)
• cli Include custom CRUD permissions with plugin scaffold (0c62b6f)
• core Add Facet.valueList resolver for paginated values (09c7175), closes #1257
• core Add maximum coupon usage (#2331) (bdd2720), closes #2331 #2330
• core Pass variant to ProductVariantPriceCalculationStrategy (fee995c), closes #2398
• core Support bi-directional relations in customFields (#2365) (0313ce5), closes #2365
• core Update NestJS to v10, Apollo Server v4 (b675fda)
• create Allow selection of package manager (6561bb7)
• create Better defaults for project scaffold (fa683e7)
• email-plugin Expose template vars to template loader (#2243) (78ea016), closes #2243 #2242
• job-queue-plugin Implement default cleanup of old BullMQ jobs (6c1d7bb), closes #1425
• payments-plugin Allow custom params to be passed to Stripe API (1b29097), closes #2412
• ui-devkit Add experimental wrapper for shared ui providers (daf6f8c)

BREAKING CHANGE

• In the Admin UI, the "stock locations" list and detail views have been moved from the "catalog" module to the "settings" module. Also, the menu item & breadcrumb for "inventory" has been renamed to "products". This is an end-user breaking change rather than a code breaking change. Any UI extensions that link to a /catalog/inventory/... route will still work as there is a redirect in place to /catalog/products/....

• The update of Apollo Server to v4 includes some breaking changes if you have defined any custom ApolloServerPlugins. See the Apollo migration guide for full details: https://www.apollographql.com/docs/apollo-server/migration/

• The new Promotion.usageLimit field will require a non-destructive database migration to be performed. You should not need to do any manual migration work - it is a straightforward addition of a field to a table.

• The ForbiddenError now defaults to a "warning" rather than "error" log level. Previously this was causing too much noise in logging services and the new level better reflects the severity of the error.

2.0.10 (2023-10-11)

Fixes

• core Use correct Money type on ProductVariantPrice.price field (446f61c)
• payments-plugin List missing available Mollie payment methods for orders api (#2435) (23a0499), closes #2435

2.0.9 (2023-09-29)

Fixes

• core Fix discount calculation error edge-case (7549aad), closes #2385

2.0.8 (2023-09-27)

Fixes

• admin-ui Fix creating nullable string fields (7e2c17a), closes #2343
• admin-ui Fix link to Asset detail from asset picker (4539de3), closes #2411
• core Implement Refund lines fields resolver (6b4da6c), closes #2406
• core Prevent negative total from compounded promotions (0740c87), closes #2385
• payments-plugin Fix stripe payment transaction handling (#2402) (fd8a777), closes #2402
• admin-ui Add image carousel to asset preview dialog (#2370) (bd834d0), closes #2370 #2129

2.0.7 (2023-09-08)

Fixes

• admin-ui Add custom field support to Customer list (298e90c)
• admin-ui Added and improved Italian translations (#2371) (19292a8), closes #2371
• admin-ui Correct handling of ID filters in data tables (52ddd96)
• admin-ui Data table filters react to page navigation (2471350)
• admin-ui Fix alignment of facet value chip (7eb43ef)
• admin-ui Fix channel switcher icon style (6e70794)
• admin-ui Fix filter shortcut triggering from rich text component (e6f95b3), closes #2384
• admin-ui Fix styling of custom field tabs (ef3d2f9)
• admin-ui Reinstate multi-deletion of Assets (a203e50), closes #380
• admin-ui Use appropriate default values for custom fields (85a8866), closes #2362
• admin-ui Aligns items horizontally in the Chip component (19d3e51)
• admin-ui Add price field on variation dialog modal (#2378) (5b99bae), closes #2378
• core Fix channel association on promotion update (#2376) (47e688d), closes #2376

2.0.6 (2023-08-11)

Fixes

• admin-ui Apply max dimensions to relation asset preview (8169c4e), closes #2320
• admin-ui Correctly display decimal tax rate in order summary (1f507fa), closes #2339
• admin-ui Correctly display widget titles in dropdown (59a1d5d), closes #2334
• admin-ui Fix error when saving multiple new variant options (e5ad0ee), closes #2326
• admin-ui Fix header overlap on empty data tables (ada153e), closes #2323 #2325
• admin-ui Fix updating variant tax category (ff29e9a), closes #2336
• admin-ui Fix width of affixed inputs (75d51ed)
• admin-ui Fulfillment button takes existing state into account (ef357cd)
• admin-ui Fulfillment dialog enforces max quantity (571b157), closes #2329
• admin-ui Prevent product creation without variants (3364559), closes #2337
• core Fix entity hydration of nested array entities (55009a5), closes #2013
• core Fix logic relating to partial fulfillments (6f48ee2), closes #2324 #2191
• core Prevent fulfillments with too great a quantity (579459a), closes #2329

2.0.5 (2023-07-27)

Fixes

• admin-ui Add channelTokenKey to AdminUiConfig (#2307) (5162d0c), closes #2307
• admin-ui Add custom detail component locationId and action bar items to draft order detail (#2286) (27c9ae7), closes #2286
• admin-ui Add missing Russian translation strings (#2309) (9524add), closes #2309
• admin-ui Add product variant name filter in product variant list (#2271) (b17494d), closes #2271
• admin-ui Allow period in slug (7c9d110), closes #2304
• admin-ui Fix creation of zero tax rates (5f898b4), closes #2312
• core Do not publish CollectionModificationEvent if no changes (75f6dec)
• core Export missing search plugin types (23af791)
• core Fix createRefund amount on cancelled OrderLines (2b49edf), closes #2302
• core Fix incorrect allocation logic in default fulfillment process (f6881bf), closes #2306
• core Fix startup error with readonly Administrator custom fields (cae55a6)
• core Fix typo in option searchStrategy (#2305) (8cd15e1), closes #2305
• core Improved CockroachDB compatibility for DefaultSearchPlugin (b8d8dec)
• core Publish AccountRegistrationEvent when creating Customer via admin (e0bd036)
• core Use MoneyStrategy in Surcharges (#2294) (efee8ec), closes #2294
• payments-plugin: Only find payment methods in the current channel (bbea69), closes #2308

Features

Note: although we now have complete translations for Arabic & Hebrew, the right-to-left layout support is still in progress, so if you use these languages you will encounter layout issues.

• admin-ui all Arabic tokens translated (100%) (#2287) (83ecec9), closes #2287
• admin-ui Hebrew support (#2313) (2814142), closes #2313

2.0.4 (2023-07-13)

Fixes

• admin-ui Allow target attribute on <a> tags in rich text editor (8f72e1e), closes #2281
• admin-ui Display custom fields in StockLocation detail view (d36ac84)
• admin-ui Fix display of Address custom fields in customer detail view (189e714), closes #2272
• admin-ui Fix layout of select customer dropdown items (3f8a1da)
• admin-ui Fix top left logo when using setBranding (120a0bb), closes #2225
• admin-ui Prevent list filter hotkey F firing from input elements (c426f8d)
• asset-server-plugin Better handling of malformed images (593e0e2), closes #2275
• core Add timeout logic to session cache handling (a817a1a)
• core Correctly update StockLocation custom fields (1cb676a)
• core Fix admin authentication when no native auth in shop API (8fb9719), closes #2282
• core Fix draft orders not getting correctly placed (4d01ab5), closes #2105
• core Add currencyCode option to RequestContextService.create (#2277) (2f336a7), closes #2277

2.0.3 (2023-07-04)

Fixes

• admin-ui-plugin Enable metricsSummary query without serving UI app (fba0739), closes #2261
• admin-ui 100% brazilian portuguese translation coverage (#2262) (0d76b10), closes #2262
• admin-ui 100% german translation coverage (#2248) (60c9e86), closes #2248
• admin-ui Add missing permission to metrics widget (3353c6e)
• admin-ui Add missing search index rebuild trigger (92f35d0)
• admin-ui Allow vertical resize of textarea (86853ec), closes #2255
• admin-ui Correct location id for product-variant-detail action bar (ebaff3a)
• admin-ui Correctly sort customer orders in detail view (86a17af)
• admin-ui Fix description layout on shipping method detail page (9b9119c)
• admin-ui Fix low limit of facet value selector component (1b13e7a), closes #2251
• admin-ui Fix position of main nav status badge (8669ef4)
• admin-ui Fix product multi select form input (b5947ec), closes #2249
• admin-ui Fix quantity label in order table (#2259) (bb4c9e5), closes #2259
• admin-ui Fix query filter option in order list component (#2258) (7b56942), closes #2258 #2257
• admin-ui Fix updating product variant asset (b590bdd)
• admin-ui Improve keyboard controls for data table filters (00f0155)
• admin-ui Make dropdowns keyboard-accessible (d9c6cdd)
• admin-ui Set page to 1 when changing list filters (f2f60c3)
• admin-ui Style improvements to chip & ng-select (bcffd9c)
• admin-ui Styling improvements to custom field relation controls (fb8aca6)
• admin-ui Update es translation (#2260) (fbc4dff), closes #2260
• admin-ui Use SKU to filter product variant list (52a09a4)
• admin-ui Prevent XSS attack vector in rich text editor (GHSA-gm68-572p-q28r)
• core Correctly set currencyCode when assigning variants to channel (5e13b0e), closes #2228
• core Delete user sessions & token upon user-deletion (#2241) (b989607), closes #2241
• core Disable graphql playground according to apiOptions setting (b9a0200), closes #2246
• core Fix Asset.tags resolution in Shop API (555666c), closes #1754
• core Fix issue updating customer email address when no native auth (79aab66)
• core Fix null reference error when hydrating entity (5a2b2b7), closes #2264
• core Update variants when changing channel defaultCurrencyCode (2303328), closes #2190
• core Use more secure default for cookie sameSite option (4a10d67)
• email-plugin Add warning when running devMode with transport (7498901), closes #2253
• payments-plugin Add compatibility metadata to payment plugins (2dbfa2b)

Perf

• core Improve performance of Product.facetValues resolver (#2239) (a0e891a), closes #2239

Features

• admin-ui Add product variant bulk actions (assign/delete channel, delete) (#2238) (b25ddcd), closes #2238

2.0.2 (2023-06-19)

Fixes

• admin-ui Allow collections to be moved to root (23b3f05), closes #2236
• admin-ui Allow options to be passed to ChartComponent (161b757)
• admin-ui Fix channel creation when pricesIncludeTax is false (36fe1a5), closes #2217
• admin-ui Fix mobile layout for asset list (5f7ac8c), closes #2206
• admin-ui Fix routerLink to the order overview (#2235) (cb37b3e), closes #2235
• admin-ui Fix styling for very long breadcrumbs (44c2c88)
• admin-ui Update fr translation (#2232) (e12770e), closes #2232
• core Channel cache can handle more than 1000 channels (2218d42), closes #2233

2.0.1 (2023-06-13)

Fixes

• admin-ui Add missing primary button states (93d2285)
• admin-ui Allow setting tab route config (3fb170e)
• admin-ui Fix customers breadcrumb link (#2218) (edaa867), closes #2218
• admin-ui Fix pagination on options editor view (dda5e67)
• admin-ui Fix styling of address card component (ea92bd1)
• admin-ui Fix tab label for product detail component (cb81848)
• admin-ui Improve feedback on attempting to create variant (e50b271), closes #2210
• admin-ui Improve readability of role permissions table (95dabdc), closes #2224
• admin-ui List newly-created customers (6483aad), closes #2213
• admin-ui Preserve ui language settings after refresh (dcae0d9), closes #2211
• admin-ui Prevent duplicate order state change on manual payment (eadc479), closes #2204
• admin-ui Redirect to the right page on forbidden errors if an internal loginUrl is provided (#2175) (c0630fb), closes #2175
• admin-ui Small style fixes (33eee17)
• asset-server-plugin Update Sharp to fix macOS 10.13+ support (043c7ff)
• core Add missing SellerEvent and correctly update relations (4f421d3), closes #2216
• core Correctly update Seller custom fields (4a4691d)
• core Expose the topLevelOnly collections option in Shop API (ed28743)
• core Fix channel creation with defaultCurrencyCode field (3aa72ab), closes #2217
• core Fix order state change from default payment process (0e5129e), closes #2204
• job-queue-plugin Fix graceful shutdown for BullMQJobQueueStrategy (7c51eab), closes #2222

2.0.0 (2023-06-07)

Fixes

• asset-server-plugin Change image format with no other transforms (#2104) (6cf1608), closes #2104
• core Correctly remove invalid promotion couponCodes from Order (7a1c127)
• core Fix concurrent order address update edge case (f4ca9b2)
• core Fix updating channel currencyCode (7e01ecf), closes #2114
• core Translatable fields default to empty string if falsy (e119154)
• core Fix error messages containing colon char (2cfc874), closes #2153
• core Fix issues with Promotion & PaymentMethod null descriptions (7b407de)
• create Use "create" version for all Vendure dependencies (844b9ba)
• payments-plugin Make peer dependencies optional (98c764c)
• testing More graceful shutdown (aa91bd0)
• ui-devkit Fix baseHref configuration (c7836b2), closes #1794

Features

• admin-ui Rename vdr-product-selector (9d9275c)
• admin-ui Add filter inheritance control to Collection detail view (7f1b01e), closes #1382
• admin-ui Update collection preview on filter inheritance toggle (1a4aced)
• admin-ui Add support for translatable PaymentMethods (06efc50), closes #1184
• admin-ui Add support for translatable Promotions (00bd433), closes #1990
• admin-ui New app layout with updated nav menu (e6f8584), closes #1645
• admin-ui Update to Angular v16.x (0c503b4)
• admin-ui Implement custom fields updating of ProductOptionGroup and ProductOption entities (d2a0824)
• admin-ui-plugin Add simple metrics support via new metricSummary query (717d265). Thanks to @martijnvdbrug for providing the initial implementation, on which this is based!
• asset-server-plugin Update to Sharp v0.31
• asset-server-plugin Update s3 asset storage strategy to use AWS sdk v3 (#2102) (d628659), closes #2102
• core Update all major dependencies to NestJS v8, Apollo Server v3, GraphQL v16
• core Update to TypeScript v4.9.5 (99da585)
• core Added a unique index to Order.code (aa6025d)
• core Collections can control inheritance of filters (5d4206f), closes #1382
• core Update codegen errors plugin to use object inputs (6b9b2a4)
• core Add currencyCode to variant price model (24e558b), closes #1691
• core Add ProductVariantPriceSelectionStrategy (efe23d1), closes #1691
• core Implement Admin API operations for stock location, e2e tests (7913b9a), closes #1545
• core Implement data model & APIs for multi-location stock (905c1df), closes #1545
• core Implement GuestCheckoutStrategy (7e0f1d1), closes #911 #762
• core Implement localeText custom field type (6a3c61f), closes #2000
• core Implement MoneyStrategy (61ac041), closes #1835
• core Make PaymentMethod entity translatable (2a4b3bc), closes #1184
• core Make Promotion entity translatable, add description (dada243), closes #1990
• core Normalize email addresses for native auth (ad7eab8), closes #1515
• core Collection preview handles filter inheritance (3d2c0fb)
• core Add support for PromotionAction side effects (1a4a117), closes #1798
• core Add filter method to EventBus (#1930) (7eabaa7), closes #1930
• core Expose tags on Assets for shop api (#1754) (d9316df), closes #1754
• core Create underlying APIs to support multivendor Orders (3d9f7e8), closes #1329
• core Extract hard-coded fulfillment state & process (cdb2b75)
• core Extract hard-coded order state & process (cff3b91)
• core Extract hard-coded payment state & process (4c5c946)
• core Add compatibility check to VendurePlugin metadata (d18d350), closes #1471
• core Add quantity arg to OrderItemPriceCalculationStrategy (02a0864), closes #1920
• core Export VENDURE_VERSION constant (b2a910a), closes #1471
• core Implement Regions & support for Provinces (7b8f5bf), closes #76
• core Allow specifying transaction isolation level (#2116) (bf2b1f5), closes #2116
• core Add topLevelOnly filter to collection list query (66b8c75)
• core Add bulk delete mutations (2f5e096)
• core Add facetValueId filter to products/variants list queries (00b8268)
• core Allow variant options to be added & removed (8cb9b27)
• core Channels mutation now returns PaginatedList (d7a3447)
• core ChannelService.findAll() returns PaginatedList (53fa2a0)
• core Move global stock & language settings into Channel (2748a6e)
• core TaxCategories query now returns PaginatedList (ddcd0fc)
• core Zones query now returns PaginatedList (afbb408)
• email-plugin Add support for dynamic templates & SMTP settings (c6686cd), closes #2043 #2044
• job-queue-plugin Update bullmq & redis dependencies (#2020) (eb0b73f), closes #2020
• payments-plugin Make Mollie plugin redirecturl dynamic (#2094) (b452419), closes #2094 #2093
• payments-plugin Make Stripe plugin channel-aware (#2058) (3b88702), closes #2058
• testing Turn productsCsvPath into an optional property for test server initialization (#2038) (4c2b118), closes #2038
• ui-devkit Add "exclude" option to UI extensions (#2009) (dd6eee3), closes #2009
• ui-devkit Support module path mappings for UI extensions (#1994) (6d57c86), closes #1994

Performance

• core Re-architect Order model for massive perf improvement on large orders, closes #1981
• core Add indices to many-to-one relations (01e369f), closes #1502
• core Add indexes to Product & Collection slugs (937cf67)

BREAKING CHANGES

When updating from v1.x, please see the Migration Guide.

• The Admin UI app has been refreshed, including upgrading to Angular v16 as well as a host of style, layout & functional improvements. If you have ui extensions, they should still work but the layout will look somewhat broken. A full upgrade guide will be published with the final v2 release, but for now, wrapping all your custom pages in <vdr-page-block> (or <div class="page-block">) will improve things.
• If you use any of the scoped method of the Admin UI DataService, you might find that some no longer exist. They are now deprecated and will eventually be removed. Use the dataService.query() and dataService.mutation() methods only, passing your own GraphQL documents.
• ChannelService.findAll() will now return a PaginatedList instead of a Channel[]
• The channels mutation now returns a PaginatedList rather than a simple array of Channels.
• The taxCategories mutation now returns a PaginatedList rather than a simple array of TaxCategory objects.
• The zones query now returns a PaginatedList rather than a simple array of Zone objects. Likewise, the ZoneService.findAll() method also returns a paginated list. The old behaviour of ZoneService.findAll() (all Zones, cached for rapid access) can now be found under the new ZoneService.getAllWithMembers() method.
• The Admin UI component vdr-product-selector has been renamed to vdr-product-variant-selector to more accurately represent what it does. If you are using vdr-product-selector if any ui extensions code, update it to use the new selector.
• There's a breaking change you'll need to handle if you are using a CustomOrderProcess, CustomFulfillmentProcess or CustomPaymentProcess. Details in the migration guide.
• The Channel.currencyCode field has been renamed to defaultCurrencyCode, and a new currencyCode field has been added to the ProductVariantPrice entity.
• The introduction of the new MoneyStrategy includes a new GraphQL Money scalar, which replaces Int used in v1.x. In practice, this is still a number type and should not break any client applications. One point to note is that Money is based on the Float scalar and therefore can represent decimal values, allowing fractions of cents to be represented.
• The minimum Redis recommended version is 6.2.0
• The Promotion entity is now translatable, which means existing promotions will need to be migrated to the new DB schema and care taken to preserve the name data. Also the GraphQL API for creating and updating Promotions, as well as the corresponding PromotionService methods have changed to take a translations array for setting the name and description in a given language.
• A new Region entity has been introduced, which is a base class for Country and the new Province entity. The Zone.members property is now an array of Region rather than Country, since Zones may now be composed of both countries and provinces. If you have defined any custom fields on Country, you'll need to change it to Region in your custom fields config.
• If you are using the s3 storage strategy of the AssetServerPlugin, it has been updated to use v3 of the AWS SDKs. This update introduces an improved modular architecture to the AWS sdk, resulting in smaller bundle sizes. You need to install the @aws-sdk/client-s3 & @aws-sdk/lib-storage packages, and can remove the aws-sdk package.
• The Stripe plugin has been made channel aware. This means your api key and webhook secret are now stored in the database, per channel, instead of environment variables. Details are in the migration guide.

1.x

Changelogs for versions prior to v2.0.0 can be found in the CHANGELOG_v1.md file.