Webbers medusa

@webbers/webbers-medusa

Quality-of-life admin customizations for Medusa v2, extracted from the Frecious backend so they can be reused across projects.

Features

• Notes — free-text notes on any entity, shown in the admin detail sidebar. Ships customer and order notes (with links + widgets); the generic note module, /admin/note endpoint and note component are reusable so other plugins can attach notes to their own entities (see "Attaching notes to your own entities").
• Anonymize customer — AVG/GDPR data scrub for a customer across customer, cart and order records, plus any host-configured extra tables (superadmin only). See "Configuring extra tables".
• Transfer guest orders — merge unassigned guest orders (matched by email) into a customer account.
• Edit customer email — change a registered customer's email atomically across customer and auth identity, plus any host-configured extra tables (clears the cached Klaviyo id). See "Configuring extra tables".
• Order discount breakdown — sidebar widget summarising the discount codes applied to an order, with amounts and percentages.
• Order notifications — sidebar widget listing the transactional emails sent for an order.
• Always-free promotion — flag a promotion as "always free shipping". Ships the data model, workflows, link and admin widget; the host app wires the trigger (see below).
• Disallow price-list discounts — a toggle on the price-list detail page that stops discount/promotion codes from overriding that price list. Ships the data model, link, workflows, admin API + widget, and a store add-to-cart endpoint that enforces it; the storefront wires the endpoint (see below).

Toggling features

The plugin adds a Settings → Webbers QoL page in the admin with a switch per feature. Toggling a feature off:

• hides its admin widget — every widget reads the flags via useFeatureEnabled(key) and renders nothing when disabled; and
• blocks its endpoints — a featureGuard middleware returns 403 for the feature's API routes (see src/api/middlewares.ts).

Flags are persisted by the bundled webbers_settings module (table webbers_feature_flag) and default to ON when no row exists, so the plugin is fully active out of the box. The canonical list of features lives in src/feature-flags.ts (shared by the server and admin builds).

Always-free is widget-only gating: disabling it hides the promotion switch, but the actual link is still written by the host app's promotion hooks, so leave the hooks in place if you rely on existing always-free promotions.

After installing, run the migration so the flag table exists:

npx medusa db:migrate

What's included

Installation

Install the plugin in your Medusa app:

1npm install @webbers/webbers-medusa
2# or, during local development:
3npx medusa plugin:add @webbers/webbers-medusa

Register it in the host app's medusa-config.ts:

1plugins: [
2  {
3    resolve: '@webbers/webbers-medusa',
4    options: {},
5  },
6]

After installing, run the migrations so the plugin's tables exist:

npx medusa db:migrate

Runtime dependencies in the host app

• A custom_query module exposing PSQLQuery / PSQLTransaction — the anonymize, transfer-guest-orders, edit-email and order-notifications routes resolve it from the container by key (custom_query). It is intentionally not bundled here so the host app keeps a single shared instance.

This plugin has no dependency on any subscriptions package (or any other domain module). The anonymize / edit-email routines only touch customer, cart and order tables out of the box; any extra tables (e.g. subscription) are declared by the host via plugin options — see "Configuring extra tables" below.

Configuring extra tables (anonymize / edit-email)

The anonymize and edit-email routines scrub the core Medusa tables on their own. To include tables owned by other modules — without this plugin depending on them — declare them in the plugin options in your medusa-config.ts. Every table/column name is validated (^[A-Za-z_][A-Za-z0-9_]*$) and all statements run inside the same transaction as the core scrub, so atomicity is preserved.

1plugins: [
2  {
3    resolve: '@webbers/webbers-medusa',
4    options: {
5      anonymize: {
6        // Domain for the generated anonymized email (anon+<ts>@<domain>). Default: anonymized.invalid
7        emailDomain: 'example.com',
8        // Tables with a customer-id column: set email columns to the anon email, null the rest.
9        customerScopedTables: [
10          { table: 'subscription', emailColumns: ['email'], nullColumns: ['payment_config'] },
11        ],
12        // Address tables reached via a parent table's billing/shipping FKs (nulled out).
13        // customerIdColumn/billingColumn/shippingColumn/nullColumns are optional (sensible defaults).
14        addressTables: [
15          { addressTable: 'subscription_address', parentTable: 'subscription' },
16        ],
17      },
18      editEmail: {
19        // Tables whose email column should follow the customer's new email.
20        // emailColumn defaults to 'email', customerIdColumn to 'customer_id'.
21        emailSyncTables: [{ table: 'subscription' }],
22      },
23    },
24  },
25]

Attaching notes to your own entities

The note module, the /admin/note endpoint (entity_type / type are free-form strings) and the note component are generic. To add notes to another entity from a separate plugin or your app — e.g. subscriptions — depend on @webbers/webbers-medusa and:

1. Define the link between your module and the note module:

   1import { defineLink } from '@medusajs/framework/utils';
   2import MyModule from '../modules/my-module';
   3import NoteModule from '@webbers/webbers-medusa/modules/note';
   4
   5export default defineLink(MyModule.linkable.myEntity, NoteModule.linkable.note);

2. Render a note widget in your entity's detail zone that calls /admin/note with your entity_type (the module's registration key). The notes feature flag guards the endpoint, so the note stays hidden/blocked when notes are disabled in Settings → Webbers QoL.

This keeps the QoL plugin free of any dependency on your module while still owning the note storage.

Activating the always-free promotion behaviour

Toggling the widget writes additional_data.always_free on the promotion (the plugin's middleware whitelists that field). Turning that flag into an always_free link requires a handler on Medusa's promotion workflow hooks. Medusa allows only one handler per workflow hook, and a real app usually does other work in promotionsCreated/promotionsUpdated too — so the plugin does not register these hooks for you. Add them in your app's src/workflows/hooks/promotions:

promotion-created.ts

1import { createPromotionsWorkflow } from '@medusajs/medusa/core-flows';
2import {
3  createAlwaysFreeFromPromotionWorkflow,
4  CreateAlwaysFreeFromPromotionWorkflowInput,
5} from '@webbers/webbers-medusa/workflows';
6
7createPromotionsWorkflow.hooks.promotionsCreated(async ({ promotions, additional_data }, { container }) => {
8  const workflow = createAlwaysFreeFromPromotionWorkflow(container);
9
10  for (const promotion of promotions) {
11    // ...any other app-specific work you already do here...
12    await workflow.run({
13      input: { promotion, additional_data } as CreateAlwaysFreeFromPromotionWorkflowInput,
14    });
15  }
16});

promotion-updated.ts

1import { updatePromotionsWorkflow } from '@medusajs/medusa/core-flows';
2import { ContainerRegistrationKeys } from '@medusajs/framework/utils';
3import {
4  createAlwaysFreeFromPromotionWorkflow,
5  CreateAlwaysFreeFromPromotionWorkflowInput,
6  updateAlwaysFreeFromPromotionWorkflow,
7  UpdateAlwaysFreeFromPromotionStepInput,
8} from '@webbers/webbers-medusa/workflows';
9import PromotionAlwaysFreeLink from '@webbers/webbers-medusa/links/promotion-always-free';
10
11updatePromotionsWorkflow.hooks.promotionsUpdated(async ({ promotions, additional_data }, { container }) => {
12  const query = container.resolve(ContainerRegistrationKeys.QUERY);
13  const create = createAlwaysFreeFromPromotionWorkflow(container);
14  const update = updateAlwaysFreeFromPromotionWorkflow(container);
15
16  for (const promotion of promotions) {
17    const existing = await query.graph({
18      entity: PromotionAlwaysFreeLink.entryPoint,
19      fields: ['*'],
20      filters: { promotion_id: promotion.id },
21    });
22
23    if (!existing?.data?.length) {
24      await create.run({ input: { promotion, additional_data } as CreateAlwaysFreeFromPromotionWorkflowInput });
25    } else {
26      await update.run({ input: { promotion, additional_data } as UpdateAlwaysFreeFromPromotionStepInput });
27    }
28  }
29});

The plugin emits no .d.ts (declaration: false, to avoid a createWorkflow type-portability error), so these imports resolve to any in the host app unless it sets noImplicitAny. That is intentional — keep the casts above so the hook bodies stay type-checked.

Reading the flag elsewhere (e.g. a fulfillment provider deciding shipping is free) can join the link table directly:

1SELECT af.always_free
2FROM promotion p
3LEFT JOIN promotion_promotion_promotion_addition_always_free paf ON paf.promotion_id = p.id
4LEFT JOIN always_free af ON af.id = paf.always_free_id
5WHERE p.id = ?

Activating the disallow-price-list-discounts behaviour

The admin widget writes metadata.disallow_discounts onto the price list's extended record (price_list_ext, linked to Medusa's price_list). The toggle only records intent — the enforcement happens when items are added to the cart.

The plugin ships the enforcement endpoint at POST /store/carts/:id/line-item-price-list. It behaves like Medusa's built-in add-to-cart, but when the body's metadata.price_list_id points at a price list flagged disallow_discounts, it sets is_discountable: false on the line item (and stamps metadata.disallowed_discounts_pricelist = true). When the Disallow price-list discounts feature is toggled off, the endpoint skips that logic and behaves as a plain add-to-cart, so it is safe to call unconditionally.

To activate the behaviour, have the storefront add price-list items through this endpoint instead of the default POST /store/carts/:id/line-items:

1await sdk.client.fetch(`/store/carts/${cartId}/line-item-price-list`, {
2  method: 'POST',
3  body: {
4    variant_id: variantId,
5    quantity,
6    metadata: { price_list_id: priceListId },
7  },
8});

Build

pnpm --filter @webbers/webbers-medusa build