# scandipwa/customer-graph-ql

> N/A

`composer require scandipwa/customer-graph-ql`

Canonical URL: https://packagento.com/scandipwa/customer-graph-ql

## At a glance

- **Vendor**: scandipwa (https://packagento.com/scandipwa.md)
- **Latest version**: 4.1.0 — released 2024-07-14
- **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/scandipwa/customer-graph-ql 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/customer-graph-ql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

N/A

## README

**CustomerGraphQl** provides type and resolver information for the GraphQl module
to generate customer information endpoints. 

This module extends the M2 GraphQl customer queries and mutations. 
New endpoints will be documented in future releases.

### Custom query documentation

#### Mutation `forgotPassword`

```graphql
mutation ForgotPassword($email: String!) {
  	forgotPassword(email: $email) {
  		status
	}
}
```

The variables for input above might look like:

```json
{
    "email": "alfreds+valid12@gmail.com"
}
```

#### Mutation `resetPassword`

```graphql
mutation ResetPassword(
  $token: String!,
  $password: String!,
  $password_confirmation: String!
) {
  resetPassword(
    token: $token,
  	password: $password,
  	password_confirmation: $password_confirmation
  ) {
    status
  }
}
```

```json
{
  "token": "7nk0Ch7D5SZsPHWKycAyGdonAM9MnHRw",
  "password": "MyNewPassword123_",
	"password_confirmation": "MyNewPassword123_"
}
```

#### Mutation `confirmCustomerEmail`

Here is an example use of it:

```graphql
mutation ConfirmCustomerEmail(
    $password: String!
    $key: String!
    $email: String!
) {
    confirmCustomerEmail(
        password: $password
        key: $key
        email: $email
    ) {
        status
        token
        customer {
            id
            firstname
            lastname
            email
            is_subscribed
            addresses {
                city
                country_id
                street
                telephone
                firstname
                lastname
                postcode
                street
                default_shipping
                default_billing
            }
        }
    }
}
```

The variables for input above might look like:

```json
{
    "key": "0129309912",
    "email": "alfreds+valid12@gmail.com",
    "password": "Testing123_"
}
```

#### Mutation `resendConfirmationEmail`

> ⚠️ This is not tested but implemented !!! ⚠️

Here is an example use of it:

```graphql
mutation ResendConfirmationEmail(
    $email: String!
) {
    resendConfirmationEmail(
        email: $email
    ) {
        status
    }
}
```

The variables for input above might look like:

```json
{
    "email": "alfreds+valid12@gmail.com"
}
```

## Recent Versions

| Version | Released |
|---|---|
| 4.1.0 | 2024-07-14 |
| 4.0.5 | 2023-04-12 |
| 4.0.4 | 2022-07-27 |
| 4.0.3 | 2022-07-16 |
| 4.0.2 | 2022-07-11 |
| 4.0.1 | 2022-07-06 |
| 4.0.0 | 2022-06-24 |
| 3.1.14 | 2022-06-09 |
| 3.1.13 | 2022-05-26 |
| 3.1.12 | 2022-03-30 |

Showing 10 of 34 versions. Full release history on https://packagento.com/scandipwa/customer-graph-ql.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | * |
| magento/module-authorization | * |
| magento/module-catalog | * |
| magento/module-customer | * |
| magento/module-customer-graph-ql | ^100.3 |
| magento/module-graph-ql | * |
| magento/module-integration | * |
| magento/module-store | * |

## Quality

Latest release (4.1.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 | Pass | Pass | – | – |
| 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 | 51 | 51 warnings (ruleset: Magento2) — 32 auto-fixable with phpcbf |
| PHPMD | Warning | 4 | 4 rule violations (UnusedPrivateField:2, ExcessiveParameterList:1, UnusedFormalParameter:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 7 | valid; 7 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 | 12 | 12 | – | – |
| 2.4.8 | – | 13 | 28 | – |
| 2.4.9 | – | – | 29 | 29 |


### 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/customer-graph-ql"],
  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.