npm - @vendure/docs - Versions diffs - 0.0.0-202601210957 → 0.0.0-202601211028 - Mend

@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211028

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (582) hide show

package/docs/reference/typescript-api/events/event-types.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Event Types"
 generated: true
 ---
-## AccountRegistrationEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/account-registration-event.ts" sourceLine="13" packageName="@vendure/core" />
 This event is fired when a new user registers an account, either as a stand-alone signup or after
@@ -30,10 +26,6 @@ class AccountRegistrationEvent extends VendureEvent {
 </div>
-## AccountVerifiedEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/account-verified-event.ts" sourceLine="13" packageName="@vendure/core" />
 This event is fired when a users email address successfully gets verified after
@@ -58,13 +50,9 @@ class AccountVerifiedEvent extends VendureEvent {
 </div>
-## AdministratorEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/administrator-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/administrator#administrator">Administrator</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class AdministratorEvent extends VendureEntityEvent<Administrator, AdministratorInputTypes> {
@@ -85,13 +73,9 @@ class AdministratorEvent extends VendureEntityEvent<Administrator, Administrator
 </div>
-## AssetChannelEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/asset-channel-event.ts" sourceLine="15" packageName="@vendure/core" />
-This event is fired whenever an <a href='/reference/typescript-api/entities/asset#asset'>Asset</a> is assigned or removed
+This event is fired whenever an <DocsLink href="/reference/typescript-api/entities/asset#asset">Asset</DocsLink> is assigned or removed
 From a channel.
 ```ts title="Signature"
@@ -113,13 +97,9 @@ class AssetChannelEvent extends VendureEvent {
 </div>
-## AssetEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/asset-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/asset#asset'>Asset</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/asset#asset">Asset</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class AssetEvent extends VendureEntityEvent<Asset, AssetInputTypes> {
@@ -146,10 +126,6 @@ class AssetEvent extends VendureEntityEvent<Asset, AssetInputTypes> {
 </div>
-## AttemptedLoginEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/attempted-login-event.ts" sourceLine="14" packageName="@vendure/core" />
 This event is fired when an attempt is made to log in via the shop or admin API `login` mutation.
@@ -175,13 +151,9 @@ class AttemptedLoginEvent extends VendureEvent {
 </div>
-## ChangeChannelEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/change-channel-event.ts" sourceLine="17" packageName="@vendure/core" since="1.4" />
-This event is fired whenever an <a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a> entity is assigned or removed
+This event is fired whenever an <DocsLink href="/reference/typescript-api/entities/interfaces#channelaware">ChannelAware</DocsLink> entity is assigned or removed
 from a channel. The entity property contains the value before updating the channels.
 ```ts title="Signature"
@@ -203,13 +175,9 @@ class ChangeChannelEvent<T extends ChannelAware & VendureEntity> extends Vendure
 </div>
-## ChannelEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/channel-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class ChannelEvent extends VendureEntityEvent<Channel, ChannelInputTypes> {
@@ -230,13 +198,9 @@ class ChannelEvent extends VendureEntityEvent<Channel, ChannelInputTypes> {
 </div>
-## CollectionEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/collection-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/collection#collection'>Collection</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/collection#collection">Collection</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class CollectionEvent extends VendureEntityEvent<Collection, CollectionInputTypes> {
@@ -257,10 +221,6 @@ class CollectionEvent extends VendureEntityEvent<Collection, CollectionInputType
 </div>
-## CollectionModificationEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/collection-modification-event.ts" sourceLine="18" packageName="@vendure/core" />
 This event is fired whenever a Collection is modified in some way. The `productVariantIds`
@@ -288,13 +248,9 @@ class CollectionModificationEvent extends VendureEvent {
 </div>
-## CountryEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/country-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/country#country'>Country</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/country#country">Country</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class CountryEvent extends VendureEntityEvent<Country, CountryInputTypes> {
@@ -315,14 +271,10 @@ class CountryEvent extends VendureEntityEvent<Country, CountryInputTypes> {
 </div>
-## CouponCodeEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/coupon-code-event.ts" sourceLine="15" packageName="@vendure/core" since="1.4" />
-This event is fired whenever an coupon code of an active <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>
-is assigned or removed to an <a href='/reference/typescript-api/entities/order#order'>Order</a>.
+This event is fired whenever an coupon code of an active <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink>
+is assigned or removed to an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink>.
 ```ts title="Signature"
 class CouponCodeEvent extends VendureEvent {
@@ -343,13 +295,9 @@ class CouponCodeEvent extends VendureEvent {
 </div>
-## CustomerAddressEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/customer-address-event.ts" sourceLine="22" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/address#address'>Address</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/address#address">Address</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -377,13 +325,9 @@ class CustomerAddressEvent extends VendureEntityEvent<Address, CustomerAddressIn
 </div>
-## CustomerEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/customer-event.ts" sourceLine="22" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/customer#customer'>Customer</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -411,14 +355,10 @@ class CustomerEvent extends VendureEntityEvent<Customer, CustomerInputTypes> {
 </div>
-## CustomerGroupChangeEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/customer-group-change-event.ts" sourceLine="15" packageName="@vendure/core" since="1.4" />
-This event is fired whenever one or more <a href='/reference/typescript-api/entities/customer#customer'>Customer</a> is assigned to or removed from a
-<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>.
+This event is fired whenever one or more <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink> is assigned to or removed from a
+<DocsLink href="/reference/typescript-api/entities/customer-group#customergroup">CustomerGroup</DocsLink>.
 ```ts title="Signature"
 class CustomerGroupChangeEvent extends VendureEvent {
@@ -439,13 +379,9 @@ class CustomerGroupChangeEvent extends VendureEvent {
 </div>
-## CustomerGroupEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/customer-group-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/customer-group#customergroup">CustomerGroup</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class CustomerGroupEvent extends VendureEntityEvent<CustomerGroup, CustomerGroupInputTypes> {
@@ -466,13 +402,9 @@ class CustomerGroupEvent extends VendureEntityEvent<CustomerGroup, CustomerGroup
 </div>
-## FacetEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/facet-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/facet#facet'>Facet</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/facet#facet">Facet</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class FacetEvent extends VendureEntityEvent<Facet, FacetInputTypes> {
@@ -493,13 +425,9 @@ class FacetEvent extends VendureEntityEvent<Facet, FacetInputTypes> {
 </div>
-## FacetValueEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/facet-value-event.ts" sourceLine="26" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/facet-value#facetvalue">FacetValue</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class FacetValueEvent extends VendureEntityEvent<FacetValue, FacetValueInputTypes> {
@@ -520,13 +448,9 @@ class FacetValueEvent extends VendureEntityEvent<FacetValue, FacetValueInputType
 </div>
-## FulfillmentEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/fulfillment-event.ts" sourceLine="27" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a> is added. The type is always `created`.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/fulfillment#fulfillment">Fulfillment</DocsLink> is added. The type is always `created`.
 ```ts title="Signature"
 class FulfillmentEvent extends VendureEntityEvent<Fulfillment, CreateFulfillmentInput> {
@@ -547,13 +471,9 @@ class FulfillmentEvent extends VendureEntityEvent<Fulfillment, CreateFulfillment
 </div>
-## FulfillmentStateTransitionEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/fulfillment-state-transition-event.ts" sourceLine="13" packageName="@vendure/core" />
-This event is fired whenever an <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a> transitions from one <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a> to another.
+This event is fired whenever an <DocsLink href="/reference/typescript-api/entities/fulfillment#fulfillment">Fulfillment</DocsLink> transitions from one <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate">FulfillmentState</DocsLink> to another.
 ```ts title="Signature"
 class FulfillmentStateTransitionEvent extends VendureEvent {
@@ -574,13 +494,9 @@ class FulfillmentStateTransitionEvent extends VendureEvent {
 </div>
-## GlobalSettingsEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/global-settings-event.ts" sourceLine="16" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/global-settings#globalsettings'>GlobalSettings</a> is added. The type is always `updated`, because it's
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/global-settings#globalsettings">GlobalSettings</DocsLink> is added. The type is always `updated`, because it's
 only created once and never deleted.
 ```ts title="Signature"
@@ -602,13 +518,9 @@ class GlobalSettingsEvent extends VendureEntityEvent<GlobalSettings, UpdateGloba
 </div>
-## HistoryEntryEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/history-entry-event.ts" sourceLine="23" packageName="@vendure/core" since="1.4" />
-This event is fired whenever one <a href='/reference/typescript-api/entities/history-entry#historyentry'>HistoryEntry</a> is added, updated or deleted.
+This event is fired whenever one <DocsLink href="/reference/typescript-api/entities/history-entry#historyentry">HistoryEntry</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class HistoryEntryEvent extends VendureEntityEvent<HistoryEntry, HistoryInput> {
@@ -635,10 +547,6 @@ class HistoryEntryEvent extends VendureEntityEvent<HistoryEntry, HistoryInput> {
 </div>
-## IdentifierChangeEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/identifier-change-event.ts" sourceLine="13" packageName="@vendure/core" />
 This event is fired when a registered user successfully changes the identifier (ie email address)
@@ -663,10 +571,6 @@ class IdentifierChangeEvent extends VendureEvent {
 </div>
-## IdentifierChangeRequestEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/identifier-change-request-event.ts" sourceLine="13" packageName="@vendure/core" />
 This event is fired when a registered user requests to update the identifier (ie email address)
@@ -691,13 +595,9 @@ class IdentifierChangeRequestEvent extends VendureEvent {
 </div>
-## InitializerEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/initializer-event.ts" sourceLine="11" packageName="@vendure/core" since="1.7.0" />
-This event is fired when vendure finished initializing its services inside the <a href='/reference/typescript-api/services/initializer-service#initializerservice'>InitializerService</a>
+This event is fired when vendure finished initializing its services inside the <DocsLink href="/reference/typescript-api/services/initializer-service#initializerservice">InitializerService</DocsLink>
 ```ts title="Signature"
 class InitializerEvent extends VendureEvent {
@@ -718,10 +618,6 @@ class InitializerEvent extends VendureEvent {
 </div>
-## LoginEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/login-event.ts" sourceLine="12" packageName="@vendure/core" />
 This event is fired when a user successfully logs in via the shop or admin API `login` mutation.
@@ -745,10 +641,6 @@ class LoginEvent extends VendureEvent {
 </div>
-## LogoutEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/logout-event.ts" sourceLine="12" packageName="@vendure/core" />
 This event is fired when a user logs out via the shop or admin API `logout` mutation.
@@ -772,13 +664,9 @@ class LogoutEvent extends VendureEvent {
 </div>
-## OrderEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/order-event.ts" sourceLine="17" packageName="@vendure/core" />
-This event is fired whenever an <a href='/reference/typescript-api/entities/order#order'>Order</a> is added, updated
+This event is fired whenever an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -806,13 +694,9 @@ class OrderEvent extends VendureEntityEvent<Order, OrderInputTypes> {
 </div>
-## OrderLineEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/order-line-event.ts" sourceLine="13" packageName="@vendure/core" />
-This event is fired whenever an <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a> is added, updated
+This event is fired whenever an <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -834,17 +718,13 @@ class OrderLineEvent extends VendureEvent {
 </div>
-## OrderPlacedEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/order-placed-event.ts" sourceLine="17" packageName="@vendure/core" />
-This event is fired whenever an <a href='/reference/typescript-api/entities/order#order'>Order</a> is set as "placed", which by default is
+This event is fired whenever an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> is set as "placed", which by default is
 when it transitions from 'ArrangingPayment' to either 'PaymentAuthorized' or 'PaymentSettled'.
 Note that the exact point that it is set as "placed" can be configured according to the
-<a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>.
+<DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>.
 ```ts title="Signature"
 class OrderPlacedEvent extends VendureEvent {
@@ -865,13 +745,9 @@ class OrderPlacedEvent extends VendureEvent {
 </div>
-## OrderStateTransitionEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/order-state-transition-event.ts" sourceLine="13" packageName="@vendure/core" />
-This event is fired whenever an <a href='/reference/typescript-api/entities/order#order'>Order</a> transitions from one <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a> to another.
+This event is fired whenever an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> transitions from one <DocsLink href="/reference/typescript-api/orders/order-process#orderstate">OrderState</DocsLink> to another.
 ```ts title="Signature"
 class OrderStateTransitionEvent extends VendureEvent {
@@ -892,10 +768,6 @@ class OrderStateTransitionEvent extends VendureEvent {
 </div>
-## PasswordResetEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/password-reset-event.ts" sourceLine="12" packageName="@vendure/core" />
 This event is fired when a Customer requests a password reset email.
@@ -919,10 +791,6 @@ class PasswordResetEvent extends VendureEvent {
 </div>
-## PasswordResetVerifiedEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/password-reset-verified-event.ts" sourceLine="13" packageName="@vendure/core" since="1.4" />
 This event is fired when a password reset is executed with a verified token.
@@ -946,13 +814,9 @@ class PasswordResetVerifiedEvent extends VendureEvent {
 </div>
-## PaymentMethodEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/payment-method-event.ts" sourceLine="18" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -974,13 +838,9 @@ class PaymentMethodEvent extends VendureEntityEvent<PaymentMethod, PaymentMethod
 </div>
-## PaymentStateTransitionEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/payment-state-transition-event.ts" sourceLine="15" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/payment#payment'>Payment</a> transitions from one <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a> to another, e.g.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/payment#payment">Payment</DocsLink> transitions from one <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> to another, e.g.
 a Payment is authorized by the payment provider.
 ```ts title="Signature"
@@ -1002,13 +862,9 @@ class PaymentStateTransitionEvent extends VendureEvent {
 </div>
-## ProductChannelEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/product-channel-event.ts" sourceLine="15" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/product#product'>Product</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -1030,13 +886,9 @@ class ProductChannelEvent extends VendureEvent {
 </div>
-## ProductEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/product-event.ts" sourceLine="18" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/product#product'>Product</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -1064,13 +916,9 @@ class ProductEvent extends VendureEntityEvent<Product, ProductInputTypes> {
 </div>
-## ProductOptionEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/product-option-event.ts" sourceLine="26" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a> is added or updated.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/product-option#productoption">ProductOption</DocsLink> is added or updated.
 ```ts title="Signature"
 class ProductOptionEvent extends VendureEntityEvent<ProductOption, ProductOptionInputTypes> {
@@ -1091,13 +939,9 @@ class ProductOptionEvent extends VendureEntityEvent<ProductOption, ProductOption
 </div>
-## ProductOptionGroupChangeEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/product-option-group-change-event.ts" sourceLine="15" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/product-option-group#productoptiongroup'>ProductOptionGroup</a> is assigned or removed from a <a href='/reference/typescript-api/entities/product#product'>Product</a>.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/product-option-group#productoptiongroup">ProductOptionGroup</DocsLink> is assigned or removed from a <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink>.
 ```ts title="Signature"
 class ProductOptionGroupChangeEvent extends VendureEvent {
@@ -1118,13 +962,9 @@ class ProductOptionGroupChangeEvent extends VendureEvent {
 </div>
-## ProductOptionGroupEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/product-option-group-event.ts" sourceLine="24" packageName="@vendure/core" since="1.4" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/product-option-group#productoptiongroup'>ProductOptionGroup</a> is added or updated.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/product-option-group#productoptiongroup">ProductOptionGroup</DocsLink> is added or updated.
 ```ts title="Signature"
 class ProductOptionGroupEvent extends VendureEntityEvent<
@@ -1148,13 +988,9 @@ class ProductOptionGroupEvent extends VendureEntityEvent<
 </div>
-## ProductVariantChannelEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/product-variant-channel-event.ts" sourceLine="14" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> is assigned or removed from a <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> is assigned or removed from a <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink>.
 ```ts title="Signature"
 class ProductVariantChannelEvent extends VendureEvent {
@@ -1175,13 +1011,9 @@ class ProductVariantChannelEvent extends VendureEvent {
 </div>
-## ProductVariantEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/product-variant-event.ts" sourceLine="18" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -1209,13 +1041,9 @@ class ProductVariantEvent extends VendureEntityEvent<ProductVariant[], ProductVa
 </div>
-## ProductVariantPriceEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/product-variant-price-event.ts" sourceLine="17" packageName="@vendure/core" since="2.2.0" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/product-variant-price#productvariantprice">ProductVariantPrice</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class ProductVariantPriceEvent extends VendureEntityEvent<
@@ -1239,13 +1067,9 @@ class ProductVariantPriceEvent extends VendureEntityEvent<
 </div>
-## PromotionEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/promotion-event.ts" sourceLine="18" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -1267,13 +1091,9 @@ class PromotionEvent extends VendureEntityEvent<Promotion, PromotionInputTypes>
 </div>
-## ProvinceEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/province-event.ts" sourceLine="18" packageName="@vendure/core" since="2.0" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/province#province'>Province</a> is added, updated or deleted.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/province#province">Province</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class ProvinceEvent extends VendureEntityEvent<Province, ProvinceInputTypes> {
@@ -1294,13 +1114,9 @@ class ProvinceEvent extends VendureEntityEvent<Province, ProvinceInputTypes> {
 </div>
-## RefundEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/refund-event.ts" sourceLine="12" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/refund#refund'>Refund</a> is created
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/refund#refund">Refund</DocsLink> is created
 ```ts title="Signature"
 class RefundEvent extends VendureEvent {
@@ -1321,13 +1137,9 @@ class RefundEvent extends VendureEvent {
 </div>
-## RefundStateTransitionEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/refund-state-transition-event.ts" sourceLine="14" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/refund#refund'>Refund</a> transitions from one <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a> to another.
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/refund#refund">Refund</DocsLink> transitions from one <DocsLink href="/reference/typescript-api/payment/refund-state#refundstate">RefundState</DocsLink> to another.
 ```ts title="Signature"
 class RefundStateTransitionEvent extends VendureEvent {
@@ -1348,13 +1160,9 @@ class RefundStateTransitionEvent extends VendureEvent {
 </div>
-## RoleChangeEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/role-change-event.ts" sourceLine="16" packageName="@vendure/core" since="1.4" />
-This event is fired whenever one <a href='/reference/typescript-api/entities/role#role'>Role</a> is assigned or removed from a user.
+This event is fired whenever one <DocsLink href="/reference/typescript-api/entities/role#role">Role</DocsLink> is assigned or removed from a user.
 The property `roleIds` only contains the removed or assigned role ids.
 ```ts title="Signature"
@@ -1376,13 +1184,9 @@ class RoleChangeEvent extends VendureEvent {
 </div>
-## RoleEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/role-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
-This event is fired whenever one <a href='/reference/typescript-api/entities/role#role'>Role</a> is added, updated or deleted.
+This event is fired whenever one <DocsLink href="/reference/typescript-api/entities/role#role">Role</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class RoleEvent extends VendureEntityEvent<Role, RoleInputTypes> {
@@ -1403,10 +1207,6 @@ class RoleEvent extends VendureEntityEvent<Role, RoleInputTypes> {
 </div>
-## SearchEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/search-event.ts" sourceLine="18" packageName="@vendure/core" since="1.6.0" />
 This event is fired whenever a search query is executed.
@@ -1430,13 +1230,9 @@ class SearchEvent extends VendureEvent {
 </div>
-## SellerEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/seller-event.ts" sourceLine="19" packageName="@vendure/core" since="2.0.1" />
-This event is fired whenever one <a href='/reference/typescript-api/entities/seller#seller'>Seller</a> is added, updated or deleted.
+This event is fired whenever one <DocsLink href="/reference/typescript-api/entities/seller#seller">Seller</DocsLink> is added, updated or deleted.
 ```ts title="Signature"
 class SellerEvent extends VendureEntityEvent<Seller, SellerInputTypes> {
@@ -1457,13 +1253,9 @@ class SellerEvent extends VendureEntityEvent<Seller, SellerInputTypes> {
 </div>
-## ShippingMethodEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/shipping-method-event.ts" sourceLine="18" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/shipping-method#shippingmethod">ShippingMethod</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -1485,13 +1277,9 @@ class ShippingMethodEvent extends VendureEntityEvent<ShippingMethod, ShippingMet
 </div>
-## StockLocationEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/stock-location-event.ts" sourceLine="18" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/stock-location#stocklocation">StockLocation</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -1513,13 +1301,9 @@ class StockLocationEvent extends VendureEntityEvent<StockLocation, StockLocation
 </div>
-## StockMovementEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/stock-movement-event.ts" sourceLine="16" packageName="@vendure/core" since="1.1.0" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/stock-movement#stockmovement'>StockMovement</a> entity is created, which occurs when the saleable
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/stock-movement#stockmovement">StockMovement</DocsLink> entity is created, which occurs when the saleable
 stock level of a ProductVariant is altered due to things like sales, manual adjustments, and cancellations.
 ```ts title="Signature"
@@ -1547,13 +1331,9 @@ class StockMovementEvent extends VendureEvent {
 </div>
-## TaxCategoryEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/tax-category-event.ts" sourceLine="18" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/tax-category#taxcategory">TaxCategory</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -1575,13 +1355,9 @@ class TaxCategoryEvent extends VendureEntityEvent<TaxCategory, TaxCategoryInputT
 </div>
-## TaxRateEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/tax-rate-event.ts" sourceLine="18" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/tax-rate#taxrate">TaxRate</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -1603,10 +1379,6 @@ class TaxRateEvent extends VendureEntityEvent<TaxRate, TaxRateInputTypes> {
 </div>
-## TaxRateModificationEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/tax-rate-modification-event.ts" sourceLine="13" packageName="@vendure/core" />
 This event is fired whenever a TaxRate is changed
@@ -1630,13 +1402,9 @@ class TaxRateModificationEvent extends VendureEvent {
 </div>
-## ZoneEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/zone-event.ts" sourceLine="18" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> is added, updated
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink> is added, updated
 or deleted.
 ```ts title="Signature"
@@ -1658,13 +1426,9 @@ class ZoneEvent extends VendureEntityEvent<Zone, ZoneInputTypes> {
 </div>
-## ZoneMembersEvent
 <GenerationInfo sourceFile="packages/core/src/event-bus/events/zone-members-event.ts" sourceLine="15" packageName="@vendure/core" />
-This event is fired whenever a <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> gets <a href='/reference/typescript-api/entities/country#country'>Country</a> members assigned or removed
+This event is fired whenever a <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink> gets <DocsLink href="/reference/typescript-api/entities/country#country">Country</DocsLink> members assigned or removed
 The `entity` property contains the zone with the already updated member field.
 ```ts title="Signature"