Skip to content

The complete open source platform to run your entire marketplace. Storefront, vendor panel, admin console, and integrations in one enterprise-grade platform you own.

5.0 KB
Raw Blame
import {
  AuthenticatedMedusaRequest,
  MedusaNextFunction,
  MedusaResponse,
} from "@medusajs/framework"
import { PermissionRight } from "@mercurjs/types"

import { requirePermission } from "../utils/permissions-middleware"

type CoreRoutePermission = {
  pattern: RegExp
  key: string
  methods?: Partial<Record<string, PermissionRight>>
}

const byMethod = (method: string): PermissionRight =>
  method === "GET" || method === "HEAD"
    ? "view"
    : method === "DELETE"
      ? "manage"
      : "edit"

// First match wins, so specific rules come before their domain's catch-all.
export const CORE_ROUTE_PERMISSIONS: CoreRoutePermission[] = [
  { pattern: /^\/admin\/sellers\/[^/]+\/(approve|suspend|unsuspend|terminate|unterminate)$/, key: "sellers.approval" },
  { pattern: /^\/admin\/products\/[^/]+\/(confirm|reject|request-changes)$/, key: "products.review" },
  { pattern: /^\/admin\/product-changes\/[^/]+\/(confirm|decline|cancel)$/, key: "products.review" },

  { pattern: /^\/admin\/orders\/[^/]+\/(refund|credit-lines)/, key: "orders.refunds" },
  { pattern: /^\/admin\/payments\/[^/]+\/refund/, key: "orders.refunds" },
  { pattern: /^\/admin\/(returns|claims|exchanges)(\/|$)/, key: "orders.returns" },
  { pattern: /^\/admin\/(order-edits|order-changes)(\/|$)/, key: "orders.edits" },
  { pattern: /^\/admin\/(orders|draft-orders)(\/|$)/, key: "orders" },
  { pattern: /^\/admin\/(payments|payment-collections)(\/|$)/, key: "payments" },

  { pattern: /^\/admin\/customer-groups(\/|$)/, key: "customer_groups" },
  { pattern: /^\/admin\/customers(\/|$)/, key: "customers" },

  { pattern: /^\/admin\/product-categories(\/|$)/, key: "product_categories" },
  { pattern: /^\/admin\/collections(\/|$)/, key: "product_collections" },
  { pattern: /^\/admin\/product-types(\/|$)/, key: "product_types" },
  { pattern: /^\/admin\/product-tags(\/|$)/, key: "product_tags" },
  { pattern: /^\/admin\/(products|product-variants|product-options)(\/|$)/, key: "products" },
  { pattern: /^\/admin\/inventory-items(\/|$)/, key: "inventory_items" },
  { pattern: /^\/admin\/reservations(\/|$)/, key: "reservations" },
  { pattern: /^\/admin\/stock-locations(\/|$)/, key: "stock_locations" },
  { pattern: /^\/admin\/price-preferences(\/|$)/, key: "price_preferences" },
  { pattern: /^\/admin\/price-lists(\/|$)/, key: "price_lists" },
  { pattern: /^\/admin\/promotions(\/|$)/, key: "promotions" },
  { pattern: /^\/admin\/campaigns(\/|$)/, key: "campaigns" },
  { pattern: /^\/admin\/shipping-profiles(\/|$)/, key: "shipping_profiles" },
  { pattern: /^\/admin\/(shipping-options|shipping-option-types)(\/|$)/, key: "shipping_options" },
  { pattern: /^\/admin\/(fulfillment-sets|fulfillment-providers|fulfillments)(\/|$)/, key: "fulfillment_sets" },

  { pattern: /^\/admin\/(regions|currencies)(\/|$)/, key: "regions" },
  { pattern: /^\/admin\/(tax-regions|tax-rates|tax-providers)(\/|$)/, key: "tax_regions" },
  { pattern: /^\/admin\/sales-channels(\/|$)/, key: "sales_channels" },
  { pattern: /^\/admin\/return-reasons(\/|$)/, key: "return_reasons" },
  { pattern: /^\/admin\/refund-reasons(\/|$)/, key: "refund_reasons" },
  // The shell and most forms read the store (currencies, default region and sales channel).
  { pattern: /^\/admin\/stores(\/[^/]+)?$/, key: "store", methods: { GET: undefined } },
  { pattern: /^\/admin\/stores(\/|$)/, key: "store" },
  { pattern: /^\/admin\/invites(\/|$)/, key: "users" },
  // Reading and editing your own profile needs no users permission.
  { pattern: /^\/admin\/users\/me$/, key: "users", methods: { GET: undefined, POST: undefined } },
  { pattern: /^\/admin\/users(\/|$)/, key: "users" },
  { pattern: /^\/admin\/api-keys(\/|$)/, key: "api_keys" },
  { pattern: /^\/admin\/(translations|locales)(\/|$)/, key: "translations" },
  { pattern: /^\/admin\/notifications(\/|$)/, key: "notifications" },
  { pattern: /^\/admin\/workflows-executions(\/|$)/, key: "workflow_executions" },
  { pattern: /^\/admin\/(search|search-indexes|index|views|property-labels|plugins|layouts)(\/|$)/, key: "store" },
]

export function matchCoreRoutePermission(
  path: string,
  method: string
): { key: string; right: PermissionRight } | null | undefined {
  const rule = CORE_ROUTE_PERMISSIONS.find((candidate) =>
    candidate.pattern.test(path)
  )

  if (!rule) {
    return undefined
  }

  const upper = method.toUpperCase()
  if (rule.methods && upper in rule.methods) {
    const right = rule.methods[upper]
    return right ? { key: rule.key, right } : null
  }

  return { key: rule.key, right: byMethod(upper) }
}

/**
 * Guards the core Medusa admin routes Mercur exposes. The map is Mercur's own
 * and deliberately independent of Medusa's route `policies` declarations.
 */
export function enforceCoreRoutePermissions(
  req: AuthenticatedMedusaRequest,
  res: MedusaResponse,
  next: MedusaNextFunction
) {
  const path = (req.originalUrl ?? req.url).split("?")[0]
  const match = matchCoreRoutePermission(path, req.method)

  if (!match) {
    return next()
  }

  return requirePermission(match.key, match.right)(req, res, next)
}