search-resolver

VTEX IO app (vtex.search-resolver) implementing the GraphQL resolvers for the catalog, search, and orders schema published by vtex.search-graphql. It powers PDP, PLP, autocomplete, and Intelligent Search storefront contracts.

This is the resolver layer of the search stack:

• Schema (the contract): vtex.search-graphql
• Resolvers (this app): vtex.search-resolver
• Backend HTTP wrapper: vtex.intelligent-search-api
• Storefront consumer: vtex.search-result (PLP), vtex.delivery-promise-components (postal/pickup)

See AGENTS.md for the full architectural walkthrough.

---

Prerequisites

• Node.js 20 (managed via .nvmrc — use nvm use)
• Yarn (v1)
• VTEX Toolbelt: npm i -g vtex
• An active VTEX account and development workspace: vtex login <account>

How to run

Install dependencies and refresh VTEX IO typings:

make dev

Link the app to your development workspace:

make link
# or equivalently: make run

How to test

Unit tests (Jest 29 + ts-jest, in node/):

make test

E2E tests run via the vtex/search-tests Cypress suite on PR, against the biggy account (vtex/action-io-app-cypress).

Pre-PR gate (matches the repo's yarn verify script — lint + test):

make check

Coverage report:

make coverage

How to publish

⚠️ These commands affect production. Always confirm the target account/workspace first.

vtex publish        # publishes a new app package to the registry
vtex deploy         # promotes a release candidate to stable

Version bumps use vtex release <patch|minor|major> stable.

Documentation

• Architecture and platform integration: AGENTS.md
• Domain glossary: docs/glossary.md
• Data model: docs/data-model.md
• SDD model guide: docs/sdd/model-guide.md
• Specs (multi-repo aggregator): is-io-specs/.specify/ — constitution, plans, tasks live in the parent
• Schema-of-record: vtex/search-graphql
• Changelog: CHANGELOG.md