Implementing HasCustomFields

From Vendure v2.2, it is possible to add support for custom fields to your custom entities. This is useful when you are defining a custom entity as part of a plugin which is intended to be used by other developers. For example, a plugin which defines a new entity for storing product reviews might want to allow the developer to add custom fields to the review entity.

Defining entities that support custom fields

First you need to update your entity class to implement the HasCustomFields interface, and provide an empty class which will be used to store the custom field values:

src/plugins/reviews/entities/product-review.entity.ts

import {    DeepPartial,    HasCustomFields,    Product,    VendureEntity,    ID,    EntityId,} from '@vendure/core';import { Column, Entity, ManyToOne } from 'typeorm';export class CustomProductReviewFields {} // [!code highlight]@Entity()export class ProductReview extends VendureEntity implements HasCustomFields { // [!code highlight]    constructor(input?: DeepPartial<ProductReview>) {        super(input);    }    @Column(() => CustomProductReviewFields) // [!code highlight]    customFields: CustomProductReviewFields; // [!code highlight]        @ManyToOne(() => Product)    product: Product;    @EntityId()    productId: ID;    @Column()    text: string;    @Column()    rating: number;}

Type generation

Given the above entity your API extension might look like this:

Graphql

type ProductReview implements Node {  id: ID!  createdAt: DateTime!  updatedAt: DateTime!  product: Product!  productId: ID!  text: String!  rating: Int!}input CreateProductReviewInput {  productId: ID!  text: String!  rating: Int!}input UpdateProductReviewInput {  id: ID!  productId: ID  text: String  rating: Int}

Notice the lack of manually defining customFields on the types, this is because Vendure extends the types automatically once your entity implements HasCustomFields.

:::important Naming convention In order for Vendure to find the correct input types to extend to, they must conform to the naming convention of:

Create<EntityName>Input
Update<EntityName>Input

And if your entity is supporting translations:

Implementing HasCustomFields

Defining entities that support custom fields

First you need to update your entity class to implement the HasCustomFields interface, and provide an empty class which will be used to store the custom field values:

src/plugins/reviews/entities/product-review.entity.ts

import {    DeepPartial,    HasCustomFields,    Product,    VendureEntity,    ID,    EntityId,} from '@vendure/core';import { Column, Entity, ManyToOne } from 'typeorm';export class CustomProductReviewFields {} // [!code highlight]@Entity()export class ProductReview extends VendureEntity implements HasCustomFields { // [!code highlight]    constructor(input?: DeepPartial<ProductReview>) {        super(input);    }    @Column(() => CustomProductReviewFields) // [!code highlight]    customFields: CustomProductReviewFields; // [!code highlight]        @ManyToOne(() => Product)    product: Product;    @EntityId()    productId: ID;    @Column()    text: string;    @Column()    rating: number;}

Type generation

Given the above entity your API extension might look like this:

Graphql

type ProductReview implements Node {  id: ID!  createdAt: DateTime!  updatedAt: DateTime!  product: Product!  productId: ID!  text: String!  rating: Int!}input CreateProductReviewInput {  productId: ID!  text: String!  rating: Int!}input UpdateProductReviewInput {  id: ID!  productId: ID  text: String  rating: Int}

Notice the lack of manually defining customFields on the types, this is because Vendure extends the types automatically once your entity implements HasCustomFields.

:::important Naming convention In order for Vendure to find the correct input types to extend to, they must conform to the naming convention of:

Create<EntityName>Input

Update<EntityName>Input

Implementing HasCustomFields

Defining entities that support custom fields

Type generation

Implementing HasCustomFields

Defining entities that support custom fields

Type generation

Supporting custom fields in your services

Updating config

Migrations