medusa

Bugs

• fix(medusa): Variant update should include the id for the listeners to be able to identify the entity (#3539) @adrien2p

Features

This release contains significant performance improvements in the Products domain. Please see this pull request for a detailed overview of the tests we have run, as well as the impact of the improvements.

• feat(medusa): Improve performance of Products domain (#3417) @adrien2p

Bugs

• fix(medusa): Issue on fixed total amount discount when using includes tax (#3472) @pepijn-vanvlaanderen

Features

Bulk emit events
This release contains an improvement of the events system in Medusa. We've updated the EventBusService.emit method to now support bulk emitting a collection of events. This is useful in bulk upsert scenarios and significantly improves performance.

Note, these changes are backward compatible so that you can use emit to send a single event, as usual.

Single emit

await eventBusService.emit("product.created", { id: product.id }, { attempts: 4 })

Bulk emit

let events = [
  {
    eventName: "product.created",
    data: { id: product.id }
    opts: { attempts: 5 }
  }, 
  {
    eventName: "product.created",
    data: { id: product2.id }
    opts: { attempts: 3 }
  }
]

await eventBusService.emit(events)

• feat(medusa): Bulk emit events (#3407) @adrien2p

Chore

• chores(medusa): Improve draft order creation perf flow (#3431) @adrien2p

Migrations & Upgrades

Overview

This release contains a migration to ensure that the product_variant_inventory table is in its correct state. We mistakenly modified a column name in an already released migration, which naturally can lead to issues if the first migration has already been applied.

The issue was reported in #3379.

Actions Required

After updating your Medusa server and before running it, run the following command to run the latest migrations:

medusa migrations run

Features

Global event options
This release contains an improvement of the events system in Medusa. Until now, the core EventBusService.emit calls have been closed for configuration. This changes in this release with the introduction of an option event_options, which is configurable in your project config in medusa-config.js.

Example:

module.exports = {
  projectConfig: {
    redis_url: REDIS_URL,
    database_url: DATABASE_URL,
    database_type: "postgres",
    store_cors: STORE_CORS,
    admin_cors: ADMIN_CORS,
    event_options: {
      removeOnComplete: 5
    }
  },
  plugins,
};

The available option is in Bull's documentation.

The attempts option on core emit calls is currently still fixed to 1.

Important: options passed in this config will be applied globally to all EventBusService.emit calls. You can still overwrite these options in your custom emit calls as they take precedence over the global options.

• feat(medusa): Add global job options for events (#3394) @olivermrbl

Bugs

• fix(medusa): Remove default job age option from EventBus (#3388) @olivermrbl
• fix(medusa): Create migration to ensure correct variant inventory column (#3384) @pKorsholm

Bugs

• fix(medusa): Creating Product with Sales Channels disabled (#3357) @riqwan

Features

• feat(medusa): Use Bull jobId option to identify duplicates (#3351) @olivermrbl

Bugs

• fix(medusa): Delete all payment sessions when cart total is 0 (#3346) @adrien2p

Bugs

• fix(medusa): Fix regression in job scheduler service (#3335) @pepijn-vanvlaanderen

Features

• feat(medusa): Configurable returnable_items on order decorate totals (#3276) @adrien2p

Bugs

• fix(medusa-js): Export resources classes and make client public (#3271) @kasperkristensen
• fix(medusa): Received quantity on return lines (#3267) @olivermrbl
• fix(oas): patch circular references in docs (#3285) @patrick-medusajs

Chores

• chore(medusa): Revert AbstractPaymentService deprecation (#3298)
• chore(docs): manually generated API reference to fix load issue (#3286) @shahednasser
• chore: changed trigger for docs generation actions (#3304) @shahednasser

Features

• feat(medusa) - delete cascade modules associations (#3190) @carlos-r-l-rodrigues
• feat(oas) - accurate model OAS representation - F to O (#3210) @patrick-medusajs
• feat(medusa): Improve addShippingMethod on store cart route (#3222) @adrien2p
• feat(medusa): Allow empty fields/expand (#3220) @adrien2p
• feat(oas) - accurate model OAS representation - PA to PU (#3223) @patrick-medusajs
• feat(oas) - accurate model OAS representation - R to U (#3250) @patrick-medusajs

Bugs

• fix(medusa): Pass query transformer config in storefront controllers (#3219) @fPolic
• fix(medusa): Missing refund amount when creating claim (#3224) @olivermrbl
• fix(medusa-plugin-sendgrid): Undefined order in method to build GiftCard data (#3238) @olivermrbl
• fix(medusa): Missing withTransaction on calculateDiscountForLineItem (#3247) @adrien2p
• fix(medusa): Discount allocation precision issues (#3244) @adrien2p
• fix(medusa): Missing withTransaction on update in get-cart.ts (#3246) @adrien2p
• fix(medusa): Add missing scoped transaction on update currency endpoint (#3254) @josetr
• fix(medusa): Default sales channel on product create (#3249) @carlos-r-l-rodrigues
• fix(medusa): Refund amount on returns in claim flow (#3237) @olivermrbl

Chores

• chore: Update ignored files for npm (#3217) @adrien2p
• chore(medusa): New totals calc. in Swap creation (#3191) @adrien2p

Migrations & Upgrades

Overview

In the last couple of releases, we've started to roll out Product Categories. The API layer is guarded by a feature flag, but the changes/additions to the database schema are not. This release introduces another migration for Product Categories so you are required to run migrations to ensure your server works as expected.

Actions Required

After updating your Medusa server and before running it, run the following command to run the latest migrations:

medusa migrations run

Features

• feat(medusa): Include name in session options (#3186) @pevey
• feat(medusa): Preserve custom adjustments when refreshing adjustments (#3085) @fPolic
• feat(medusa): Decorate OrderEdit LineItems with totals (#3108) @fPolic
• feat(medusa): Include rolling in session options config (#3184) @pevey
• feat(medusa-payment-stripe): Avoid unnecessary customer update if the stripe id already exists (#3046) @adrien2p
• feat(medusa): Option to override existing cron job (#2989) @olivermrbl
• feat(medusa): Expose session options (#3162) @olivermrbl
• feat(medusa): TransactionOrchestrator variant creation (#3097) @carlos-r-l-rodrigues
• feat(medusa): Run shared module migrations (#3109) @carlos-r-l-rodrigues
• feat(medusa): batch remove products from a category (#3141) @riqwan
• feat(medusa): Products can be added to categories in batch request (#3123) @riqwan
• feat(medusa): add or remove categories from products (#3114) @riqwan
• feat(medusa): Added models + repo for products in multiple categories (#3083) @riqwan
• feat(medusa): Add inventory for variants (#2970) @pKorsholm
• feat(oas): accurate model OAS representation - A to D (#3203) @patrick-medusajs
• feat(oas): sanitize circular reference for Redocly (#3198) @patrick-medusajs
• feat(oas): declare x-codegen on Store routes (#3074) @patrick-medusajs
• feat(oas): declare x-codegen on Admin routes - A to D (#3090) @patrick-medusajs
• feat(oas): Improve OAS by adding missing type object to schemas (#3177) @patrick-medusajs
• feat(oas): declare x-codegen on Admin routes - D to PRI (#3092) @patrick-medusajs
• feat(oas): declare x-codegen on Admin routes - PRO to R (#3093) @patrick-medusajs
• feat(oas): declare x-codegen on Admin routes - S to V (#3102) @patrick-medusajs
• feat(oas): declare x-codegen on Admin routes - S to V (#3102) @patrick-medusajs
• feat(medusa): Filter products by category params in store/admin (#3155) @riqwan
• feat(medusa-js): added resources for product categories (#3157) @riqwan
• feat(medusa,stock-location,inventory): Integration tests (#3149) @carlos-r-l-rodrigues

Bugs

• fix(medusa): Applying Discounts (with Conditions) on DraftOrders and Carts (#3197) @adrien2p
• fix(medusa): Allow method.data to be passed when creating/updating ShippingMethods in ClaimService (#3205) @kasperkristensen
• fix(medusa): Deleting product prices (#3152) @kasperkristensen
• fix(medusa): Shipping profile CRUD (#3154) @kasperkristensen
• fix(medusa): fields params usage in the storefront endpoints (#2980) @fPolic
• fix(stock-location): Stock location address required (#3065) @carlos-r-l-rodrigues
• fix(medusa-payment-stripe): Resend capture event to ensure auto-capture (#3100) @olivermrbl
• fix(medusa-plugin-sendgrid): Inject GiftCardService to eliminate undefined error (#2941) @RegisHubelia
• fix(medusa): Upsert addresses on Orders (#3153) @olivermrbl
• fix(medusa-react): Fix production.min.js causing invalid hook usage error in CJS environments (#3144) @kasperkristensen
• fix(medusa-payment-stripe): Prevent Stripe events from retrying (#3160) @olivermrbl
• fix(medusa): ShippingOption type on listAndCount (#2040) @adrien2p

Chores

• chore: chore: Patch bump all dependencies + minor bumps winston (#3185) @olivermrbl
• chore(-payment-): Cleanup PaymentProvider plugins (#3011) @adrien2p
• chore(integration-tests): Flaky tests (#3126) @adrien2p
• chore: fixed OAS using incorrect store resource (#3138) @shahednasser
• chore: fixed OAS using incorrect store resource (#3140) @shahednasser
• chore: recommended meaningful oas fixes (#3159) @riqwan
• chore(medusa): refactor service test for product categories (#3161) @riqwan

Docs

• docs: improved SEO of documentation (#3117) @shahednasser
• docs: added product category events to reference (#3118) @shahednasser
• docs: added user guide for order editing (#3120) @shahednasser
• docs: fixed mobile usability of tooltips (#3124) @shahednasser
• docs: added publish plugin documentation (#3137) @shahednasser
• docs: added information about metadata attribute (#3139) @shahednasser
• chore(docs): updated docusaurus to v2.3.0 (#3145) @shahednasser
• docs: fix type in Spaces documentation (#3150) @rafalfortunski
• docs: add and use react-tooltip (#3176) @danielbarion
• docs: updated docusaurus to the latest version 2.3.1 (#3181) @shahednasser

Bugs

• fix(medusa): Allow deleting metadata fields (#3055) @kasperkristensen
• fix(medusa): Move migration to correct folder (#3067) @olivermrbl
• fix(medusa): Only add Sales Channel relation + field when enabled (#3069) @olivermrbl

Docs

• docs: added migration guide for Medusa React (#3066) @shahednasser

Migrations & Upgrades

Important
This version enables Order Editing and Payment Collection by default. Migrations are required.

In your project, run:

medusa migrations run

Features

• feat(medusa): Nested Categories Admin Update Endpoint (#2986) @riqwan
• feat(medusa-react): Upgrade react-query and clean up dependencies (#2969) @kasperkristensen
• feat(medusa): Emit events on product category mutations (#3003) @riqwan
• feat(medusa): Allow custom created_by on order edits (#3007) @olivermrbl
• feat(medusa): Retrieve (service + controller) a product category (#3004) @riqwan
• feat(medusa, stock-location, inventory): Allow modules to integrate with core (#2997) @carlos-r-l-rodrigues
• feat(medusa): Validate module required properties (#3029) @carlos-r-l-rodrigues
• feat(medusa): List (service + controller) product categories #3004 (#3023) @riqwan
• feat(medusa): Transaction Orchestrator (#2861) @carlos-r-l-rodrigues
• feat(medusa, medusa-js, medusa-react): Add endpoint to retrieve product tags from the storefront (#3051) @kasperkristensen

Bugs

• fix(medusa): Rename quantity to required quantity (#2963) @pKorsholm
• fix(medusa): Draft order totals not working with custom items (#3008) @adrien2p
• fix(medusa, medusa-payment-paypal): Add missing data in Payment Collection input (#3010) @adrien2p
• fix(medusa): test, build and watch scripts (#3025) @adrien2p
• fix(medusa): Add module config to transaction base service (#3033) @olivermrbl
• fix(medusa): Legacy total service to accept custom items (#3027) @adrien2p
• fix(medusa-js, medusa-react): Fix issue with JS client bundle (#3038) @kasperkristensen
• fix(medusa): Draft order inventory management (#3040) @pKorsholm

Chores

• chore(oas): replace response with $ref to res class JSDoc OAS (A-C) (#3002) @patrick-medusajs
• chore(oas): fixed oas for product category endpoints and model (#3014) @shahednasser
• chore(oas): replace response with $ref class JSDoc (Admin O-PRI) (#3018) @patrick-medusajs
• chore(oas): replace response with $ref class JSDoc (Admin D-N) (#3015) @patrick-medusajs
• chore(oas): replace response with $ref class JSDoc (Admin SHI-V) (#3031) @patrick-medusajs
• chore(oas): replace response with $ref class JSDoc (Store A-PAY) @patrick-medusajs
• chore(feature-flags): Remove OrderEditing feature flag (#3006) @olivermrbl

Docs

• docs: added publishable API keys documentation pages (#2972) @shahednasser
• docs: Temporarily remove note on peer deps in documentation (#2988) @olivermrbl
• docs: fix note about migration script in upgrade guide (#2996) @shahednasser
• docs: updated user guide following sidebar redesign of admin (#2998) @shahednasser
• docs: fix search bar not focused when using keyboard shortcut (#2999) @shahednasser
• docs: added middleware documentation (#3000) @shahednasser
• docs: improved feedback component (#3026) @shahednasser
• docs: fixed note about custom database schema (#3049) @shahednasser
• docs: added a troubleshooting guide for updates (#3057) @shahednasser

Migrations & Upgrades

Important

This version enables Sales Channels and Publishable Keys by default. We strongly recommend you run the upgrade guide to migrate all your existing products into the default sales channel, which will be created upon the first subsequent server start.

Please refer to this guide on upgrading to v1.7.3.

Features

• feat(medusa): search orders by customer phone and name (#2913) @pKorsholm
• feat(medusa): Add ProductVariantInventoryService (#2883) @pKorsholm
• feat(medusa): Include external_id in CreateProductInput type (#2498) @chiubaca
• feat(medusa): Stock location module (#2907) @carlos-r-l-rodrigues
• feat(medusa): Pass location upon receiving returns (#2949) @pKorsholm
• feat(medusa): Add ProductCategory model (#2945) @riqwan
• feat(medusa): Disable subscriber when no search engine is installed (#2958) @adrien2p
• feat(medusa): Reliable retrying of jobs (#2947) @olivermrbl
• feat(medusa): Create fulfillment with location (#2931) @pKorsholm
• feat(medusa): Get route for admin product categories API (#2961) @riqwan
• feat(medusa): Introduce Payment Processor API (#2737) @adrien2p
• feat(medusa): Nested Categories Admin List Endpoint (#2973)
• feat(medusa-js): Bundle package using Rollup (#2964) @kasperkristensen
• feat(medusa): Nested Categories Admin Delete Endpoint (#2975) @riqwan
• feat(medusa): Update payment session management (#2937) @adrien2p
• feat(medusa, inventory): Inventory Management module (#2956) @carlos-r-l-rodrigues
• feat(medusa): Migrate setPaymentSession to use new session flow (#2982) @adrien2p
• feat(medusa): added admin create endpoint for nested categories (#2985) @riqwan

Bugs

• fix(medusa): Add tax inclusive flag to return lines from line item (#2909) @olivermrbl
• fix(medusa): Remove redundant Redis delete call when invalidating cache entries (#2943) @olivermrbl
• fix(medusa): Custom repository take/skip when called without relations ( #2962) @adrien2p
• fix(medusa): Repository util mention of entity specifics (#2965) @adrien2p
• fix(medusa): Cancel order missing refunds relation (#2976) @adrien2p
• fix(medusa-payment-manual): Correct wrongly used input data (#2979) @adrien2p
• fix(medusa): Rename location migration (#2987) @olivermrbl

Chores

• tests(integration): Randomize option value name (#2918) @pKorsholm
• chore: refactor payment collection setPaymentSession (#2928) @adrien2p
• chore(integration-tests): Add test for database options (#2707) @olivermrbl
• chore: star prompt (#2955) @srindom
• refactor(medusa): move repository specs into its own folder (#2952) @riqwan
• chore(feature-flags): Publishable Keys enabled by default (#2967) @olivermrbl
• chore(feature-flags): Sales Channels enabled by default (#2966) @olivermrbl

Docs

• docs: added a feedback component in quickstart guides (#2894) @shahednasser
• docs: added troubleshooting docs (#2900) @shahednasser
• docs: shortened summaries in API reference (#2902) @shahednasser
• docs: add git as in the prerequisites section of the Quickstart Guide (#2892) @akarsh-jain-790
• docs: added Customers conceptual guide (#2908) @shahednasser
• docs: added Implement Customer Profiles documentation (#2910) @shahednasser
• docs: added Manage Customers documentation (#2911) @shahednasser
• docs: added a note about watching changes (#2917) @shahednasser
• chore(docs): added eslint to lint documentation code blocks (#2920) @shahednasser
• docs: updated steps in MinIO documentation (#2922) @shahednasser
• docs: fix wrong key for order placed in sendgrid docs (#2923) @pepiyu
• docs: added missing oas tag of uploads endpoints (#2924) @shahednasser
• docs: changed behavior of feedback component (#2929) @shahednasser
• docs: fixed oas tag of price list products endpoint (#2933) @shahednasser
• docs: added gift card documentation guides (#2939) @shahednasser
• docs: changed details related to new payment method signatures (#2876) @shahednasser
• docs: small fixes based on friction log (#2954) @shahednasser
• docs: Correct import products url (#2960) @binzcodes
• docs: changed links on the homepage (#2981) @shahednasser

Bugs

hotfix(medusa): Assign jobSchedulerService in EventBus (#2889)

Features

• feat(medusa): Ordering products on retrieval (#2815) @adrien2p
• feat(medusa-plugin-sendgrid) Add refund created event to sendgrid (#2740) @a-finocchiaro
• feat(medusa): Allow all relations on /admin/* endpoints (#2763) @fPolic
• feat(medusa): CSV formatter accounts for comma and semicolon (#2789) @adrien2p
• feat(medusa): Add has_account to list-customers query params (#2811) @pKorsholm
• feat(medusa): Validate required id before retrieving (#2738) @carlos-r-l-rodrigues
• feat(medusa,medusa-payment-stripe): Move database mutation from plugin to core (#2743) @adrien2p
• feat(medusa): Extract cron job logic to its own service (#2821) @olivermrbl
• feat(medusa-file-s3): Allow all AWS options in config (#2809) @pKorsholm
• feat(medusa): Allow custom database schema (#2819) @josetr
• feat(medusa): Allow creating DraftOrders without items (#2719) @josetr
• feat(medusa): Extend Module Resolution configuration (#2864) @pKorsholm

Bugs

• fix(medusa-core-utils): getConfigFile typings (#2783) @adrien2p
• fix(medusa): Totals on draft orders (#2785) @pKorsholm
• fix(medusa): Batch job not saving the errors properly (#2812) @adrien2p
• fix(medusa): Fix q param on /admin/price-lists/:id/products (#2813) @kasperkristensen
• fix(medusa): Gift card values & taxes are calculated correctly (#2777) @riqwan
• fix(medusa): Include items.variant relation in order calculation (#2869) @adrien2p

Chores

• chore(medusa): Remove unused event from order service (#2793) @pKorsholm
• chore(medusa): Replace inline Redis cache in favour of the CacheService (#2802) @adrien2p
• chore(oas): PascalCase for schemas + remove x-resourceId (#2847) @patrick-medusajs
• chore(oas): replace requestBody with $ref to req class JSDoc OAS (#2867) @patrick-medusajs

Docs

• docs: added an upgrade guide for 1.7.0 (#2750) @shahednasser
• docs: made changes to CORS usage/config (#2784) @shahednasser
• docs: changed the steps to run tests in local dev (#2786) @shahednasser
• docs: updated event reference (#2791) @shahednasser
• docs: added order claim documentation (#2805) @shahednasser
• docs: added upgrade guide for admin (#2816) @shahednasser
• docs: added region-related documentation pages (#2845) @shahednasser
• docs: Update gatsby occurance to vite (#2860) @chemicalkosek
• docs: add a note about running migrations after changing database type (#2699) @jonjahr
• docs: add test medusa cli after installation in set up dev env docs (#2866) @DebashisCodes
• docs: added customize medusa admin docs (#2870) @shahednasser

Migrations & Upgrades

This version contains a fix around tax calculation on gift cards that require you to run a migration and a script. Please refer to this guide on upgrading to v1.7.1.

Breaking changes

• feat(medusa)!: Claim customer orders (#2710) (see upgrade guide below)

Features

• feat(medusa): Trigger staging deployment (#2695)
• feat(medusa): Allow passing idempotency key to service layer create (#2701)
• feat(medusa): Performance improvements of Carts domain (#2648)
• feat(medusa): Claim customer orders (#2710)
• feat(medusa): Allow to assign a Collection to a Product on import (#2764)
• feat(medusa): Allow regexp in CORS configuration (#1935)

Bugs

• fix(medusa-payment-stripe): Hooks import (#2666)
• fix(medusa): Order service legacy decorate totals should add totals to items (#2667)
• fix(medusa): Use correct auth middleware in GET /store/auth (#2687)
• fix(medusa): Discounts service create validates against at least 1 region (#2729)
• fix(medusa): Decorate order with totals in store domain (#2747)
• fix(medusa): Update line item adjustments upon cart discount removal (#2751)
• fix(medusa): Keep country_code when partially updating cart addresses (#2683)
• fix(medusa): Creating tax lines in cart completion strategy (#2761)
• fix(medusa): Throw on flat rate shipping options with no amount (#2628)
• fix(medusa): Payment status on refunds (#2770)
• fix(medusa, medusa-react): Typing of optional fields on multiple product endpoints (#2771)

Chores

• chore: Update Awilix to v8 (#2668)
• chore(medusa-core-utils): Migrate to TS (#2670)

Docs

• docs: fixed tooltip causing overflow in codeblocks (#2679)
• docs: fixed error in code in override price selection (#2689)
• docs: added credentials option to fetch examples (#2694)
• docs: added deploy to railway docs (#2697)
• docs: added Create a Discount user guide (#2705)
• docs: added user guide for Manage Discounts (#2706)
• docs: added Discounts Architecture documentation (#2709)
• docs: added Use Discounts in Checkout documentation
• chore(docs): remove unused files from www directory (#2722)
• docs: Added Manage Discounts using Admin APIs doc (#2730)
• docs: delete unused doc files (#2732)
• docs: redesigned code blocks (#2745)
• docs: added Klarna documentation (#2746)
• docs: use correct publish directory for netlify deploy (#2741)
• docs: update environment variable used in admin's deploy guides (#2748)

Migrations & Upgrades

Upgrading to v1.7.0

Features

• perf(medusa): Shipping options + TransactionBaseService initialization (#2632)
  • Over 250x improvement (!)
• feat(medusa): Module Resolution API (#2597)
• feat(medusa): Cart and totals computational optimizations (#2475)

Bug fixes

• fix(medusa-payment-stripe): handle webhook serialization failure (#2607)
• fix(medusa): Transaction lock issues on create/update cart items (#2612)
• fix(medusa, medusa-plugin-discount-generator, medusa-plugin-restock-notification): Bump Medusa package versions (#2623)
• fix(draft-order): Create tax-inclusive draft order with discount (#2579)
• fix(medusa-payment-stripe): Missing transactions in Stripe provider (#2603)

Bugs

• fix(medusa): Separate JWT auth strategies per domain (#2646)

Bugs

• hotfix(medusa-payment-stripe): Support provider specific intent options (#2581)
• hotfix(medusa): Deleted region are missing on order retrieval (#2583)

Docs

• docs: added user guide for tax-inclusive pricing (#2580)
• docs: added settings user guides (#2586)
• docs: update readme (#2587)

Features

• feat(medusa,medusa-js,medusa-react): Store API product types (#2552)
• feat(medusa): Add support for retrying failed event bus jobs (#2566)

Bugs

• fix(medusa): Order/Cart decorate totals should assign the items totals ( #2546)
• fix(medusa-telemetry): Fix incorrect import (#2574)
• fix(medusa): fix missing throw in the store cart create-payment-sessions (#2568)

Docs

• docs: added meta image (#2550)
• docs: redesigned announcement bar (#2559)
• docs: added code blocks without headers (#2560)
• docs: added upgrade guide for 1.6.1 (#2561)
• docs: added manage customer user guide (#2562)
• docs: added manage collections user guide (#2564)
• docs: added "users" user guides (#2565)
• docs: migrated images to cloudinary from imgur (#2569)