# mageme/module-eu-withdrawal-hyva

> Hyva theme compatibility for mageme/module-eu-withdrawal. Re-renders the customer-facing withdrawal form (4-step SPA + lookup) and order-view integrations using pure Alpine.js + Tailwind utilities — no KO, no jQuery, no Magewire dependency. Hyva checkout integration (precontract block + waiver step) is shipped separately. NOT legal advice — see README disclaimer.

`composer require mageme/module-eu-withdrawal-hyva`

Canonical URL: https://packagento.com/mageme/module-eu-withdrawal-hyva

## At a glance

- **Vendor**: mageme (https://packagento.com/mageme.md)
- **Latest version**: 1.0.4 — released 2026-06-21
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mageme/module-eu-withdrawal-hyva and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mageme/module-eu-withdrawal-hyva:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Hyva theme compatibility for mageme/module-eu-withdrawal. Re-renders the customer-facing withdrawal form (4-step SPA + lookup) and order-view integrations using pure Alpine.js + Tailwind utilities — no KO, no jQuery, no Magewire dependency. Hyva checkout integration (precontract block + waiver step) is shipped separately. NOT legal advice — see README disclaimer.

## README

> Hyva theme compatibility for the EU Withdrawal customer flow — pure Tailwind and Alpine.js, no KnockoutJS, no jQuery.

[![Latest Version](https://img.shields.io/packagist/v/mageme/module-eu-withdrawal-hyva.svg?style=flat-square)](https://packagist.org/packages/mageme/module-eu-withdrawal-hyva)
[![Downloads](https://img.shields.io/packagist/dt/mageme/module-eu-withdrawal-hyva.svg?style=flat-square)](https://packagist.org/packages/mageme/module-eu-withdrawal-hyva)
[![Hyva](https://img.shields.io/badge/Hyva-1.3.11%2B-21CFD5.svg?style=flat-square)](https://www.hyva.io)
[![PHP](https://img.shields.io/badge/PHP-8.1%20%7C%208.2%20%7C%208.3%20%7C%208.4%20%7C%208.5-777BB4.svg?style=flat-square)](https://php.net)
[![License](https://img.shields.io/badge/license-MageMe%20EULA-blue.svg?style=flat-square)](https://mageme.com/license/)

Hyva theme companion for [`mageme/module-eu-withdrawal`](https://github.com/mageme/module-eu-withdrawal). Re-renders the storefront-facing withdrawal flow with the Hyva design system. Install it when your storefront runs on a Hyva theme.

**[Documentation](https://docs.mageme.com)** · **[Base module](https://github.com/mageme/module-eu-withdrawal)** · **[Get Pro features](https://mageme.com/magento-2-withdrawal-button-extension.html)**

---

### What it does

Hyva-native rendering for the customer-facing parts of the base module:

- **Withdrawal flow** at `/withdraw-contract/` — the guided flow (find order → select items → review & confirm) for both the guest lookup and the logged-in order picker.
- **Customer account** — the "Withdrawal requests" section.
- **Sales order view** — the "Start return" button and active-withdrawal banner.

Tailwind utility classes and a single Alpine component replace the base module's KnockoutJS. **No compliance behaviour is added or removed** — this is purely a theme-rendering layer.

For **Hyva Checkout** (the pre-contract block and waiver step on the checkout itself), install the separate [Hyva Checkout companion](https://github.com/mageme/module-eu-withdrawal-hyva-checkout).

### Requirements

- **EU Withdrawal** base module (pulled automatically)
- `hyva-themes/magento2-theme-module` **≥ 1.3.11**
- Magento **2.4.4–2.4.9**, **PHP 8.1–8.5**

### Install

```bash
composer require mageme/module-eu-withdrawal-hyva
bin/magento module:enable MageMe_EUWithdrawal Hyva_MageMeEUWithdrawal
bin/magento setup:upgrade
bin/magento cache:flush
```

Recompile the Hyva Tailwind bundle so the classes used by this module are picked up (substitute your child theme's `web/tailwind/` path if applicable):

```bash
cd vendor/hyva-themes/magento2-default-theme/web/tailwind
npm install && npm run build
```

### Custom Magento development

Need a feature an extension doesn't cover, or a bespoke Magento build? MageMe takes on custom extension development and integration work.

→ **[Custom Magento development](https://mageme.com/magento-services/custom-development)**

### Support

- Documentation: [docs.mageme.com](https://docs.mageme.com)
- Bug reports and feature requests: [GitHub Issues](https://github.com/mageme/module-eu-withdrawal-hyva/issues)

### Disclaimer

This is a **technical theme-compatibility shim** — it re-implements the flow in Alpine + Tailwind and adds or removes no compliance functionality. The merchant is responsible for verifying the flow renders correctly under their Hyva theme and version before going to production. See the base module's [full disclaimer](https://docs.mageme.com).

### License

Distributed **free of charge** as a free-tier companion, governed by the **MageMe End User License Agreement** ([mageme.com/license](https://mageme.com/license/)).

---

**MageMe** builds Magento 2 and Adobe Commerce extensions for B2B merchants — form building, quoting, catalog control, and EU compliance.

## Changelog

* Other: Internal cleanup of the withdrawal form's inline-script handling.

### 1.0.3

+ New: Full order selection mode support in the withdrawal form
- Fix: final confirmation button now renders the legally required "Confirm withdrawal" label in the customer's language instead of "Submit return request"
+ New: Extension points for the Pro photo evidence step on the withdrawal form
* Other: Mobile layout polish on the withdrawal form (full-bleed cards, tighter spacing)

### 1.0.2

- Fix: The withdrawal refund summary now reflects order-level discounts and other custom totals.

### 1.0.1

+ New: "Show more" in the order picker — load more eligible orders on demand.

### 1.0.0

+ New: First public release. Hyva theme compatibility for the EU Withdrawal customer flow — the lookup form, the four-step withdrawal flow, the customer-account "Withdrawal requests" section, and the order-view withdraw button, all rebuilt with Tailwind and Alpine.js.

## Recent Versions

| Version | Released |
|---|---|
| 1.0.4 | 2026-06-21 |
| 1.0.3 | 2026-06-17 |
| 1.0.2 | 2026-06-08 |
| 1.0.1 | 2026-06-03 |
| 1.0.0 | 2026-06-01 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| hyva-themes/magento2-theme-module | ^1.3.11 |
| mageme/module-eu-withdrawal | ^1.0 |
| php | ~8.1.0\|\|~8.2.0\|\|~8.3.0\|\|~8.4.0\|\|~8.5.0 |

## Quality

Latest release (1.0.4) passes the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | not tested | not tested | – | – |
| 2.4.8 | – | not tested | not tested | – |
| 2.4.9 | – | – | not tested | not tested |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 243 | 243 warnings (ruleset: Magento2) — 4 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Error | Error | – | – |
| 2.4.8 | – | Error | Error | – |
| 2.4.9 | – | – | Error | Error |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | N/A | 0 | no resolvable dependency tree to audit — Your requirements could not be resolved to an installable set of packages. Problem 1 |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mageme/module-eu-withdrawal-hyva"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mageme is a Magento 2 vendor on Packagento. See https://packagento.com/mageme.md for their full catalogue.

