# scandipwa/catalog-graphql

> Catalog-specific modifications for ScandiPWA

`composer require scandipwa/catalog-graphql`

Canonical URL: https://packagento.com/scandipwa/catalog-graphql

## At a glance

- **Vendor**: scandipwa (https://packagento.com/scandipwa.md)
- **Latest version**: 3.4.0 — released 2024-07-14
- **Pricing**: Free
- **Package type**: Magento 2 theme
- **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/scandipwa/catalog-graphql 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 scandipwa/catalog-graphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Catalog-specific modifications for ScandiPWA

## README

This module extends Magento 2 Catalog GraphQl definitions.

### What is inside?

1. Fixes the `pageSizeBySearchEngine` argument in `PageSizeProvider` class. See more in [di.xml](./src/etc/di.xml)

2. Adds following fields to `ProductFilterInput`:

    - `category_url_key`, 

    - `category_url_path`,

    - `color`, 

    - `size`, 

    - `shoes_size`.

3. Defines custom resolver to get configurable products when filtering by custom attribute.

4. Defines custom resolver to filter products by category URL key or path.

5. Fixes the Layered Navigation when filtering by category.

6. Adds `thumbnail` to `MediaGalleryEntry` type. See more in [schema.graphqls](./src/etc/schema.graphqls).
 
7.  Adds support for product list `min_price` and `max_price` values.

## Changelog

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

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### [1.4.4] - 2019-07-19
#### Changed
- fixed logic for recognizing attributes (broken in 1.4.0 due to attributes are not auto-imported to the schema)
- fixed a bug when products could not be filtered with custom attribute w/o a category in the same request


### [1.4.1] - 2019-07-08
#### Added
- `min_price, max_price` fields for accurate price filter

#### Changed
- filterable attributes are added via `di.xml`
- layered navigation (filters) now utilizes the same collection (avoiding loading unnecessary data)

### [1.4.0] - 2019-07-02
#### Changed
- attributes are not auto-injected into schema (reduce bootstrap time) 

### [1.0.0] - 2019-03-08
#### Added
- custom resolver to `category` field
- type `ProductThumbnails` to `ProductInterface` interface

#### Changed
- elasticsearch page size
- `category` field input options with `url_path`
- `products` field input options with:
- - Configurable products attributes (`color`, `size`, `shoes_size`)
- - Category URL (`category_url_key`, `category_url_path`)

## Recent Versions

| Version | Released |
|---|---|
| 3.4.0 | 2024-07-14 |
| 3.3.6 | 2024-03-11 |
| 3.3.5 | 2024-03-06 |
| 3.3.4 | 2023-04-04 |
| 3.3.3 | 2022-12-27 |
| 3.3.2 | 2022-12-05 |
| 3.3.1 | 2022-07-11 |
| 3.3.0 | 2022-07-06 |
| 3.2.13 | 2022-06-11 |
| 3.2.12 | 2022-05-12 |

Showing 10 of 138 versions. Full release history on https://packagento.com/scandipwa/catalog-graphql.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | * |
| magento/module-bundle-graph-ql | ^100.3 |
| magento/module-catalog | * |
| magento/module-catalog-graph-ql | ^100.4.1 |
| magento/module-catalog-inventory | * |
| magento/module-catalog-widget | * |
| magento/module-configurable-product-graph-ql | ^100.3 |
| magento/module-eav | * |
| magento/module-elasticsearch | * |
| magento/module-graph-ql | * |
| magento/module-rule | * |
| magento/module-store | * |
| magento/module-swatches | * |
| magento/module-widget | * |
| scandipwa/performance | ^1.1.0 |

## Quality

Latest release (3.4.0) 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 | 1 | 1 | – | – |
| 2.4.8 | – | 1 | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### 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 | 261 | 261 warnings (ruleset: Magento2) — 192 auto-fixable with phpcbf |
| PHPMD | Warning | 53 | 53 rule violations (UnusedFormalParameter:41, UnusedLocalVariable:4, MissingImport:2, UnusedPrivateField:1, ExcessiveParameterList:1) |
| Cpd | Warning | 2 | 2 duplicated chunks spanning 52 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 11 | valid; 11 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 | 10 | 10 | – | – |
| 2.4.8 | – | 10 | 12 | – |
| 2.4.9 | – | – | 12 | 12 |


### 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=["scandipwa/catalog-graphql"],
  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

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