VendurePluginMetadata

plugins

Other Vendure plugins that this plugin composes. Vendure registers these plugins before this plugin and adds them to its NestJS module imports.

configuration

A function which can modify the VendureConfig object before the server bootstraps.

shopApiExtensions

The plugin may extend the default Vendure GraphQL shop api by providing extended schema definitions and any required resolvers.

adminApiExtensions

The plugin may extend the default Vendure GraphQL admin api by providing extended schema definitions and any required resolvers.

entities

The plugin may define custom TypeORM database entities.

dashboard

compatibility

The plugin should define a valid semver version string to indicate which versions of Vendure core it is compatible with. Attempting to use a plugin with an incompatible version of Vendure will result in an error and the server will be unable to bootstrap.

If a plugin does not define this property, a message will be logged on bootstrap that the plugin is not guaranteed to be compatible with the current version of Vendure.

To effectively disable this check for a plugin, you can use an overly-permissive string such as >0.0.0.

Example

compatibility: '^3.0.0'

schema

Extensions to the schema. Passes the current schema as an optional argument, allowing the extension to be based on the existing schema.

Example

const schema = gql`extend type SearchReindexResponse {    timeTaken: Int!    indexedItemCount: Int!}`;

resolvers

An array of resolvers for the schema extensions. Should be defined as Nestjs GraphQL resolver classes, i.e. using the Nest @Resolver() decorator etc.

scalars

A map of GraphQL scalar types which should correspond to any custom scalars defined in your schema. Read more about defining custom scalars in the Apollo Server Custom Scalars docs