# etechflow/module-rich-snippets

> Hyva-native rich snippets (schema.org JSON-LD) for Keystation/Lockstation.

`composer require etechflow/module-rich-snippets`

Canonical URL: https://packagento.com/etechflow/module-rich-snippets

## At a glance

- **Vendor**: etechflow (https://packagento.com/etechflow.md)
- **Latest version**: 1.2.1 — released 2026-06-22
- **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/etechflow/module-rich-snippets 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 etechflow/module-rich-snippets:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Hyva-native rich snippets (schema.org JSON-LD) for Keystation/Lockstation.

## README

Hyvä-native structured-data module for Magento 2 / Adobe Commerce. Emits a single
cross-linked schema.org **JSON-LD `@graph`** per page plus **OpenGraph + Twitter
Card** meta. A leaner, self-owned alternative to Mirasvit_SeoMarkup.

### Schema coverage

| Page | Output (one `@graph` per page) |
|------|--------------------------------|
| Product | `Product` / `ProductGroup` (+ `variesBy`/`hasVariant` for configurables) with tax-aware `Offer`/`AggregateOffer`, sale `UnitPriceSpecification`, `priceValidUntil`, `itemCondition`, payment/delivery methods, `AggregateRating` + `Review`, `BreadcrumbList`, `Organization`, `WebSite` |
| Category / landing | current-page `ItemList` + `BreadcrumbList` + `Organization` + `WebSite` |
| CMS + home | `WebPage` + `Organization` + `WebSite` |
| All pages | `og:*` + `twitter:*` meta, and the `og:` head `prefix` |

Entities are linked by `@id` (e.g. `Offer.seller` and `WebSite.publisher` resolve
to the single `Organization` node).

### Architecture

- **Block classes render via `_toHtml()`** (`Block/Product`, `Category`, `Cms`, `Meta`)
  returning the `<script>`/`<meta>` string directly — **no `.phtml` templates**. This is
  deliberate: in production mode with HTML minification, new module templates require a
  preprocessed copy; rendering from PHP sidesteps that entirely.
- Schema-building logic lives in `ViewModel/*` (`Product`, `Category`, `CmsPage`, `Site`,
  `Breadcrumbs`, `OpenGraph`, `Config`) so it is unit-testable and reusable.
- Prices are tax-aware (honour `tax/display/type`) and use the active store currency.

### Configuration

**Stores → Configuration → Etechflow → Rich Snippets**

| Path | Default | Notes |
|------|---------|-------|
| `etechflow_richsnippets/general/enabled` | `0` | Master switch. OFF = emits nothing (safe alongside another provider). |
| `etechflow_richsnippets/product/enabled` | `1` | |
| `etechflow_richsnippets/product/variants_enabled` | `1` | ProductGroup for configurables |
| `etechflow_richsnippets/product/{brand,mpn,gtin13,condition}_attribute` | brand/sku/–/– | Attribute-code overrides |
| `etechflow_richsnippets/category/enabled` | `1` | |
| `etechflow_richsnippets/opengraph/enabled` | `1` | OpenGraph + Twitter |
| `etechflow_richsnippets/cms/enabled` | `1` | CMS + home WebPage |

### Install

```bash
bin/magento module:enable Etechflow_RichSnippets
bin/magento setup:upgrade
rm -rf generated/code/* generated/metadata/*   # required: di:compile won't clean this itself
bin/magento setup:di:compile
bin/magento cache:flush
## then flip the master switch on:
bin/magento config:set etechflow_richsnippets/general/enabled 1
```

If replacing another provider (e.g. Mirasvit), disable its output first to avoid
duplicate schema. To avoid a duplicate breadcrumb, suppress the theme's native
breadcrumb JSON-LD (this module's breadcrumb is the full category path).

### Tests

```bash
vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist app/code/Etechflow/RichSnippets/Test/Unit
```

## Changelog

All notable changes to this module are documented here.

### v1.0.0 — 2026-06-05

Initial public release.

Hyva-native rich snippets (schema.org JSON-LD @graph) + OpenGraph + Twitter Card meta. Lean alternative to Mirasvit_SeoMarkup. Tax-aware pricing.

## Recent Versions

| Version | Released |
|---|---|
| 1.2.1 | 2026-06-22 |
| 1.1.1 | 2026-06-16 |
| 1.1.0 | 2026-06-16 |
| 1.0.0 | 2026-06-05 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=103.0 |
| magento/module-backend | >=102.0 |
| magento/module-catalog | >=104.0 |
| magento/module-cms | >=104.0 |
| magento/module-store | >=101.0 |
| php | ~8.1.0\|\|~8.2.0\|\|~8.3.0\|\|~8.4.0 |

## Quality

Latest release (1.2.1) fails 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 | 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 | Fail | 112 | 3 errors, 109 warnings (ruleset: Magento2) — 39 auto-fixable with phpcbf |
| PHPMD | Warning | 39 | 39 rule violations (IfStatementAssignment:17, EmptyCatchBlock:6, UnusedFormalParameter:5, CyclomaticComplexity:4, NPathComplexity:3) |
| Cpd | Warning | 1 | 1 duplicated chunk spanning 42 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 6 | valid; 6 advisory notes (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 | 19 | 19 | – | – |
| 2.4.8 | – | 19 | 19 | – |
| 2.4.9 | – | – | 19 | N/A |


### 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=["etechflow/module-rich-snippets"],
  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

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