# matusstafura/magento2-vatid-validation

> Vat Id input validation for Magento 2

`composer require matusstafura/magento2-vatid-validation`

Canonical URL: https://packagento.com/matusstafura/magento2-vatid-validation

## At a glance

- **Vendor**: matusstafura (https://packagento.com/matusstafura.md)
- **Latest version**: v0.2.0 — released 2025-08-04
- **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/matusstafura/magento2-vatid-validation 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 matusstafura/magento2-vatid-validation:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Vat Id input validation for Magento 2

## README

A lightweight module that adds client-side **VAT ID validation** to key Magento 2 forms like checkout and customer address forms.
This is helpful for EU country based commerce, that needs to verify VAT ID via VIES.

---

### 📋 Description

Magento 2 by default allows invalid or incorrectly formatted VAT IDs during checkout, which can lead to customer entry errors and issues with tax/VAT compliance like VIES check.

This module adds **smart VAT ID validation per country**, using patterns based on the official EU formats.

<table>
  <tr>
    <td><strong>Default Magento 2 behavior:</strong><br><img src="./docs/before.jpg" alt="before validation" width="400"/></td>
    <td><strong>With this module enabled:</strong><br><img src="./docs/after.jpg" alt="after validation" width="400"/></td>
  </tr>
</table>

#### ✅ Features
- Validates VAT ID format based on the selected country
- Works on:
  - 🛒 Checkout (shipping & billing addresses)
- Translation-ready (`i18n/sk_SK.csv` and `%1` placeholders supported)
- Fully frontend (JS-based) — no backend override

---

### 📦 Installation

#### Option 1: Composer (Recommended)

```bash
composer require matusstafura/magento2-vatid-validation
````

#### Option 2: Manual Installation (for testing or customization)

```bash
git clone https://github.com/matusstafura/magento2-vatid-validation.git app/code/MatusStafura/VatIdValidation
```

Then run:

```bash
bin/magento module:enable MatusStafura_VatIdValidation
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
```

### 🚀 TODO

* ⏳ Option to override per store (via admin config)

---

### 🤝 Contributing

Contributions are welcome!

1. Fork the repo
2. Create a new branch:

```bash
git checkout -b feature/your-feature-name
```

3. Make your changes
4. Push to your fork:

```bash
git push origin feature/your-feature-name
```

5. Open a pull request

---

### 📃 License

MIT

---

### ☕ Support

If you find this module helpful:

[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/matusstafura)

## Changelog

All notable changes to this project will be documented in this file.

---

### [v0.2.0] – 2025-08-04
#### Added
- ✅ Admin configuration option to enable/disable validation per store view.

---

### [v0.1.0] – 2025-07
#### Added
- 📱 Initial release of the Magento 2 Vat Id Validation module.
- 🧪 Regex validation for EU countries.
- 🛒 Validation support in checkout forms.
- 🌐 Translations: `en_US`, `sk_SK`, `de_DE`, `hu_HU`, `cs_CZ`, `nl_NL`.

---

## Recent Versions

| Version | Released |
|---|---|
| v0.2.0 | 2025-08-04 |
| v0.1.0 | 2025-08-02 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | ^103.0.1 |
| php | >=8.1 |

## Quality

Latest release (v0.2.0) 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 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### 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 | 3 | 3 warnings (ruleset: Magento2), 1 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Pass | 0 |  |

#### 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 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### 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 | Pass | 0 |  |
| 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=["matusstafura/magento2-vatid-validation"],
  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

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