# mageworx/module-faq-graphql

`composer require mageworx/module-faq-graphql`

Canonical URL: https://packagento.com/mageworx/module-faq-graphql

## At a glance

- **Vendor**: mageworx (https://packagento.com/mageworx.md)
- **Latest version**: 1.0.0 — released 2026-04-08
- **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/mageworx/module-faq-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 mageworx/module-faq-graphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## README

GraphQL addon for the **MageWorx_Faq** module. Exposes FAQ data (blocks and Q&A items) via Magento GraphQL API for headless and Hyva storefronts.

### Requirements

- Magento 2.4.x with `Magento_GraphQl` module enabled
- `MageWorx_Faq` module installed and enabled

### Installation

The module is installed as part of the MageWorx FAQ package. After placing files run:

```bash
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush
```

### Queries

#### FAQ by Product

```graphql
{
  faqByProduct(product_id: 42) {
    blocks {
      block_id
      title
      description
      type
      sort_order
      items {
        item_id
        question_id
        answer_id
        sort_order
        question
        answer
      }
    }
  }
}
```

#### FAQ by Category

```graphql
{
  faqByCategory(category_id: 10) {
    blocks {
      title
      items {
        question_id
        question
        answer
      }
    }
  }
}
```

#### FAQ by CMS Page

```graphql
{
  faqByCmsPage(page_id: 5) {
    blocks {
      title
      items {
        question
        answer
      }
    }
  }
}
```

#### FAQ by Block (direct)

```graphql
{
  faqByBlock(block_id: 3) {
    blocks {
      title
      items {
        question
        answer
      }
    }
  }
}
```

#### Store Configuration

Frontend display settings are available via `storeConfig`:

```graphql
{
  storeConfig {
    mageworx_faq_enabled
    mageworx_faq_accordion_mode
    mageworx_faq_answers_default_state
    mageworx_faq_open_first_question
    mageworx_faq_show_block_titles
    mageworx_faq_answers_spoiler_limit
  }
}
```

### Response Types

| Type | Fields |
|------|--------|
| `FaqPage` | `blocks: [FaqBlock!]!` |
| `FaqBlock` | `block_id`, `title`, `description`, `type`, `sort_order`, `items` |
| `FaqItem` | `item_id`, `question_id`, `answer_id`, `sort_order`, `question`, `answer` |

### Store Scope

All queries automatically resolve values for the store determined by the request's `Store` header, with fallback to default (store 0) values.

### Caching

Responses are cached at the GraphQL layer using the `@cache` directive with `FaqIdentity` as the cache identity provider. Cache is invalidated when any FAQ block, question, or answer is modified in the admin panel — including per-store-view content changes.

### Anchor Links (headless)

`FaqItem.question_id` is a stable database ID that does not change on reordering. Headless storefronts can use it to build deep links to specific FAQ questions:

```
https://example.com/product.html#faq-question-{question_id}
```

This matches the anchor link format used by the standard Luma/Hyva frontend rendering in `MageWorx_Faq`.

## Recent Versions

| Version | Released |
|---|---|
| 1.0.0 | 2026-04-08 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=103 < 104 |
| magento/module-graph-ql | >=100.4 |
| magento/module-store-graph-ql | >=100.3 |
| mageworx/module-faq | >=1.0.0 |

## Quality

Latest release (1.0.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 | not tested | 1 | – | – |
| 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 | Pass | 0 |  |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 4 | valid; 4 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 | 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=["mageworx/module-faq-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

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