Events

import { OnModuleInit } from '@nestjs/common';import { EventBus, ProductEvent, PluginCommonModule, VendurePlugin } from '@vendure/core';import { StorefrontBuildService } from './services/storefront-build.service';@VendurePlugin({    imports: [PluginCommonModule],})export class StorefrontBuildPlugin implements OnModuleInit {    constructor(        private eventBus: EventBus, // [!code highlight]        private storefrontBuildService: StorefrontBuildService,    ) {}    onModuleInit() {        this.eventBus.ofType(ProductEvent).subscribe(event => { // [!code highlight]            this.storefrontBuildService.triggerBuild(); // [!code highlight]        }); // [!code highlight]    }}

import { Injectable, OnModuleInit } from '@nestjs/common';import {    EventBus,    PluginCommonModule,    VendurePlugin,    ProductEvent,    ProductVariantEvent,} from '@vendure/core';@VendurePlugin({    imports: [PluginCommonModule],})export class MyPluginPlugin implements OnModuleInit {    constructor(private eventBus: EventBus) {}    onModuleInit() {        this.eventBus            .filter(event => event instanceof ProductEvent || event instanceof ProductVariantEvent) // [!code highlight]            .subscribe(event => {                // the event will be a ProductEvent or ProductVariantEvent            });    }}

import { Injectable } from '@nestjs/common';import { EventBus, ProductEvent, RequestContext, Product } from '@vendure/core';@Injectable()export class MyPluginService {    constructor(private eventBus: EventBus) {}    async doSomethingWithProduct(ctx: RequestContext, product: Product) {        // ... do something        await this.eventBus.publish(new ProductEvent(ctx, product, 'updated')); // [!code highlight]    }}

import { ID, RequestContext, VendureEvent } from '@vendure/core';import { ProductReviewInput } from '../types';/** * @description * This event is fired whenever a ProductReview is submitted. */export class ReviewSubmittedEvent extends VendureEvent {    constructor(        public ctx: RequestContext,        public input: ProductReviewInput,    ) {        super();    }}

import { Injectable } from '@nestjs/common';import { EventBus, ProductReviewService, RequestContext } from '@vendure/core';import { ReviewSubmittedEvent } from '../events/review-submitted.event';import { ProductReviewInput } from '../types';@Injectable()export class ProductReviewService {    constructor(        private eventBus: EventBus,        private productReviewService: ProductReviewService,    ) {}    async submitReview(ctx: RequestContext, input: ProductReviewInput) {        this.eventBus.publish(new ReviewSubmittedEvent(ctx, input)); // [!code highlight]        // handle creation of the new review        // ...    }}

import { ID, RequestContext, VendureEntityEvent } from '@vendure/core';import { BlogPost } from '../entities/blog-post.entity';import { CreateBlogPostInput, UpdateBlogPostInput } from '../types';type BlogPostInputTypes = CreateBlogPostInput | UpdateBlogPostInput | ID | ID[];/** * This event is fired whenever a BlogPost is added, updated * or deleted. */export class BlogPostEvent extends VendureEntityEvent<BlogPost, BlogPostInputTypes> {    constructor(        ctx: RequestContext,        entity: BlogPost,        type: 'created' | 'updated' | 'deleted',        input?: BlogPostInputTypes,    ) {        super(entity, type, ctx, input);    }}

import { Injectable, OnModuleInit } from '@nestjs/common';import { EventBus, PluginCommonModule, VendurePlugin } from '@vendure/core';import { filter } from 'rxjs/operators';import { BlogPostEvent } from './events/blog-post-event';@VendurePlugin({    imports: [PluginCommonModule],    // ...})export class BlogPlugin implements OnModuleInit {    constructor(private eventBus: EventBus) {}    onModuleInit() {        this.eventBus            .ofType(BlogPostEvent) // [!code highlight]            .pipe(filter(event => event.type === 'created')) // [!code highlight]            .subscribe(event => { // [!code highlight]                const blogPost = event.entity; // [!code highlight]                // do something with the newly created BlogPost // [!code highlight]            }); // [!code highlight]    }}

import { Injectable, OnModuleInit } from '@nestjs/common';import { EventBus, PluginCommonModule, VendurePlugin, CustomerEvent } from '@vendure/core';import { CustomerSyncService } from './services/customer-sync.service';@VendurePlugin({    imports: [PluginCommonModule],})export class MyPluginPlugin implements OnModuleInit {    constructor(        private eventBus: EventBus,        private customerSyncService: CustomerSyncService,    ) {}    onModuleInit() {        this.eventBus.registerBlockingEventHandler({ // [!code highlight]            event: CustomerEvent, // [!code highlight]            id: 'sync-customer-details-handler', // [!code highlight]            handler: async event => { // [!code highlight]                // This hypothetical service method would do nothing // [!code highlight]                // more than adding a new job to the job queue. This gives us // [!code highlight]                // the guarantee that the job is added before the publishing // [!code highlight]                // code is able to continue, while minimizing the time spent // [!code highlight]                // in the event handler. // [!code highlight]                await this.customerSyncService.triggerCustomerSyncJob(event); // [!code highlight]            }, // [!code highlight]        }); // [!code highlight]    }}

// In one part of your code basethis.eventBus.registerBlockingEventHandler({    type: CustomerEvent,    id: 'sync-customer-details-handler',    handler: async event => {        // ...    },});// In another part of your code basethis.eventBus.registerBlockingEventHandler({    type: CustomerEvent,    id: 'check-customer-details-handler',    handler: async event => {        // ...    },    before: 'sync-customer-details-handler', // [!code highlight]});