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/entities/channel.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Channel"
 generated: true
 ---
-## Channel
 <GenerationInfo sourceFile="packages/core/src/entity/channel/channel.entity.ts" sourceLine="37" packageName="@vendure/core" />
 A Channel represents a distinct sales channel and configures defaults for that

package/docs/reference/typescript-api/entities/collection.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "Collection"
 generated: true
 ---
-## Collection
 <GenerationInfo sourceFile="packages/core/src/entity/collection/collection.entity.ts" sourceLine="35" packageName="@vendure/core" />
-A Collection is a grouping of <a href='/reference/typescript-api/entities/product#product'>Product</a>s based on various configurable criteria.
+A Collection is a grouping of <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink>s based on various configurable criteria.
 ```ts title="Signature"
 class Collection extends VendureEntity implements Translatable, HasCustomFields, ChannelAware, Orderable {

package/docs/reference/typescript-api/entities/country.mdx CHANGED Viewed

@@ -2,15 +2,11 @@
 title: "Country"
 generated: true
 ---
-## Country
 <GenerationInfo sourceFile="packages/core/src/entity/region/country.entity.ts" sourceLine="14" packageName="@vendure/core" />
-A country to which is available when creating / updating an <a href='/reference/typescript-api/entities/address#address'>Address</a>. Countries are
-grouped together into <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>s which are in turn used to determine applicable shipping
-and taxes for an <a href='/reference/typescript-api/entities/order#order'>Order</a>.
+A country to which is available when creating / updating an <DocsLink href="/reference/typescript-api/entities/address#address">Address</DocsLink>. Countries are
+grouped together into <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink>s which are in turn used to determine applicable shipping
+and taxes for an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink>.
 ```ts title="Signature"
 class Country extends Region {

package/docs/reference/typescript-api/entities/customer-group.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "CustomerGroup"
 generated: true
 ---
-## CustomerGroup
 <GenerationInfo sourceFile="packages/core/src/entity/customer-group/customer-group.entity.ts" sourceLine="17" packageName="@vendure/core" />
-A grouping of <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>s which enables features such as group-based promotions
+A grouping of <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink>s which enables features such as group-based promotions
 or tax rules.
 ```ts title="Signature"

package/docs/reference/typescript-api/entities/customer-history-entry.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "CustomerHistoryEntry"
 generated: true
 ---
-## CustomerHistoryEntry
 <GenerationInfo sourceFile="packages/core/src/entity/history-entry/customer-history-entry.entity.ts" sourceLine="14" packageName="@vendure/core" />
-Represents an event in the history of a particular <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>.
+Represents an event in the history of a particular <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink>.
 ```ts title="Signature"
 class CustomerHistoryEntry extends HistoryEntry {

package/docs/reference/typescript-api/entities/customer.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "Customer"
 generated: true
 ---
-## Customer
 <GenerationInfo sourceFile="packages/core/src/entity/customer/customer.entity.ts" sourceLine="22" packageName="@vendure/core" />
 This entity represents a customer of the store, typically an individual person. A Customer can be
-a guest, in which case it has no associated <a href='/reference/typescript-api/entities/user#user'>User</a>. Customers with registered account will
+a guest, in which case it has no associated <DocsLink href="/reference/typescript-api/entities/user#user">User</DocsLink>. Customers with registered account will
 have an associated User entity.
 ```ts title="Signature"

package/docs/reference/typescript-api/entities/facet-value.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "FacetValue"
 generated: true
 ---
-## FacetValue
 <GenerationInfo sourceFile="packages/core/src/entity/facet-value/facet-value.entity.ts" sourceLine="23" packageName="@vendure/core" />
-A particular value of a <a href='/reference/typescript-api/entities/facet#facet'>Facet</a>.
+A particular value of a <DocsLink href="/reference/typescript-api/entities/facet#facet">Facet</DocsLink>.
 ```ts title="Signature"
 class FacetValue extends VendureEntity implements Translatable, HasCustomFields, ChannelAware {

package/docs/reference/typescript-api/entities/facet.mdx CHANGED Viewed

@@ -2,17 +2,13 @@
 title: "Facet"
 generated: true
 ---
-## Facet
 <GenerationInfo sourceFile="packages/core/src/entity/facet/facet.entity.ts" sourceLine="25" packageName="@vendure/core" />
-A Facet is a class of properties which can be applied to a <a href='/reference/typescript-api/entities/product#product'>Product</a> or <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>.
+A Facet is a class of properties which can be applied to a <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> or <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>.
 They are used to enable [faceted search](https://en.wikipedia.org/wiki/Faceted_search) whereby products
 can be filtered along a number of dimensions (facets).
-For example, there could be a Facet named "Brand" which has a number of <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>s representing
+For example, there could be a Facet named "Brand" which has a number of <DocsLink href="/reference/typescript-api/entities/facet-value#facetvalue">FacetValue</DocsLink>s representing
 the various brands of product, e.g. "Apple", "Samsung", "Dell", "HP" etc.
 ```ts title="Signature"

package/docs/reference/typescript-api/entities/fulfillment.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "Fulfillment"
 generated: true
 ---
-## Fulfillment
 <GenerationInfo sourceFile="packages/core/src/entity/fulfillment/fulfillment.entity.ts" sourceLine="18" packageName="@vendure/core" />
-This entity represents a fulfillment of an Order or part of it, i.e. which <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>s have been
+This entity represents a fulfillment of an Order or part of it, i.e. which <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>s have been
 delivered to the Customer after successful payment.
 ```ts title="Signature"

package/docs/reference/typescript-api/entities/global-settings.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "GlobalSettings"
 generated: true
 ---
-## GlobalSettings
 <GenerationInfo sourceFile="packages/core/src/entity/global-settings/global-settings.entity.ts" sourceLine="14" packageName="@vendure/core" />
 Stores global settings for the whole application

package/docs/reference/typescript-api/entities/history-entry.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "HistoryEntry"
 generated: true
 ---
-## HistoryEntry
 <GenerationInfo sourceFile="packages/core/src/entity/history-entry/history-entry.entity.ts" sourceLine="16" packageName="@vendure/core" />
-An abstract entity representing an entry in the history of an Order (<a href='/reference/typescript-api/entities/order-history-entry#orderhistoryentry'>OrderHistoryEntry</a>)
-or a Customer (<a href='/reference/typescript-api/entities/customer-history-entry#customerhistoryentry'>CustomerHistoryEntry</a>).
+An abstract entity representing an entry in the history of an Order (<DocsLink href="/reference/typescript-api/entities/order-history-entry#orderhistoryentry">OrderHistoryEntry</DocsLink>)
+or a Customer (<DocsLink href="/reference/typescript-api/entities/customer-history-entry#customerhistoryentry">CustomerHistoryEntry</DocsLink>).
 ```ts title="Signature"
 class HistoryEntry extends VendureEntity implements HasCustomFields {

package/docs/reference/typescript-api/entities/interfaces.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Interfaces"
 generated: true
 ---
-## ChannelAware
 <GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="17" packageName="@vendure/core" />
 Entities which can be assigned to Channels should implement this interface.
@@ -26,10 +22,6 @@ interface ChannelAware {
 </div>
-## SoftDeletable
 <GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="28" packageName="@vendure/core" />
 Entities which can be soft deleted should implement this interface.
@@ -50,10 +42,6 @@ interface SoftDeletable {
 </div>
-## Orderable
 <GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="39" packageName="@vendure/core" />
 Entities which can be ordered relative to their siblings in a list.
@@ -74,10 +62,6 @@ interface Orderable {
 </div>
-## Taggable
 <GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="50" packageName="@vendure/core" />
 Entities which can have Tags applied to them.
@@ -98,10 +82,6 @@ interface Taggable {
 </div>
-## Translatable
 <GenerationInfo sourceFile="packages/core/src/common/types/locale-types.ts" sourceLine="29" packageName="@vendure/core" />
 Entities which have localizable string properties should implement this type.

package/docs/reference/typescript-api/entities/order-history-entry.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "OrderHistoryEntry"
 generated: true
 ---
-## OrderHistoryEntry
 <GenerationInfo sourceFile="packages/core/src/entity/history-entry/order-history-entry.entity.ts" sourceLine="14" packageName="@vendure/core" />
-Represents an event in the history of a particular <a href='/reference/typescript-api/entities/order#order'>Order</a>.
+Represents an event in the history of a particular <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink>.
 ```ts title="Signature"
 class OrderHistoryEntry extends HistoryEntry {

package/docs/reference/typescript-api/entities/order-line-reference.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "OrderLineReference"
 generated: true
 ---
-## FulfillmentLine
 <GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/fulfillment-line.entity.ts" sourceLine="16" packageName="@vendure/core" />
-This entity represents a line from an <a href='/reference/typescript-api/entities/order#order'>Order</a> which has been fulfilled by a <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>.
+This entity represents a line from an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which has been fulfilled by a <DocsLink href="/reference/typescript-api/entities/fulfillment#fulfillment">Fulfillment</DocsLink>.
 ```ts title="Signature"
 class FulfillmentLine extends OrderLineReference {
@@ -44,13 +40,9 @@ class FulfillmentLine extends OrderLineReference {
 </div>
-## OrderLineReference
 <GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/order-line-reference.entity.ts" sourceLine="15" packageName="@vendure/core" />
-This is an abstract base class for entities which reference an <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>.
+This is an abstract base class for entities which reference an <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>.
 ```ts title="Signature"
 class OrderLineReference extends VendureEntity {
@@ -87,13 +79,9 @@ class OrderLineReference extends VendureEntity {
 </div>
-## OrderModificationLine
 <GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/order-modification-line.entity.ts" sourceLine="16" packageName="@vendure/core" />
-This entity represents a line from an <a href='/reference/typescript-api/entities/order#order'>Order</a> which has been modified by an <a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a>.
+This entity represents a line from an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which has been modified by an <DocsLink href="/reference/typescript-api/entities/order-modification#ordermodification">OrderModification</DocsLink>.
 ```ts title="Signature"
 class OrderModificationLine extends OrderLineReference {
@@ -129,13 +117,9 @@ class OrderModificationLine extends OrderLineReference {
 </div>
-## RefundLine
 <GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/refund-line.entity.ts" sourceLine="16" packageName="@vendure/core" />
-This entity represents a line from an <a href='/reference/typescript-api/entities/order#order'>Order</a> which has been refunded by a <a href='/reference/typescript-api/entities/refund#refund'>Refund</a>.
+This entity represents a line from an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which has been refunded by a <DocsLink href="/reference/typescript-api/entities/refund#refund">Refund</DocsLink>.
 ```ts title="Signature"
 class RefundLine extends OrderLineReference {

package/docs/reference/typescript-api/entities/order-line.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "OrderLine"
 generated: true
 ---
-## OrderLine
 <GenerationInfo sourceFile="packages/core/src/entity/order-line/order-line.entity.ts" sourceLine="32" packageName="@vendure/core" />
-A single line on an <a href='/reference/typescript-api/entities/order#order'>Order</a> which contains information about the <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> and
+A single line on an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which contains information about the <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> and
 quantity ordered, as well as the price and tax information.
 ```ts title="Signature"
@@ -109,7 +105,7 @@ class OrderLine extends VendureEntity implements HasCustomFields {
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`}   />
-The <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> of the <a href='/reference/typescript-api/entities/seller#seller'>Seller</a> for a multivendor setup.
+The <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink> of the <DocsLink href="/reference/typescript-api/entities/seller#seller">Seller</DocsLink> for a multivendor setup.
 ### sellerChannelId
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
@@ -119,8 +115,8 @@ The <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> of
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>`}   />
-The <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a> to which this line has been assigned.
-This is determined by the configured <a href='/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy'>ShippingLineAssignmentStrategy</a>.
+The <DocsLink href="/reference/typescript-api/entities/shipping-line#shippingline">ShippingLine</DocsLink> to which this line has been assigned.
+This is determined by the configured <DocsLink href="/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy">ShippingLineAssignmentStrategy</DocsLink>.
 ### shippingLineId
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
@@ -130,7 +126,7 @@ This is determined by the configured <a href='/reference/typescript-api/shipping
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`}   />
-The <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> which is being ordered.
+The <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> which is being ordered.
 ### productVariantId
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
@@ -175,7 +171,7 @@ The <a href='/reference/typescript-api/entities/product-variant#productvariant'>
 <MemberInfo kind="property" type={`number`}   />
-The quantity of this OrderLine at the time the order was placed (as per the <a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>).
+The quantity of this OrderLine at the time the order was placed (as per the <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>).
 ### initialListPrice
 <MemberInfo kind="property" type={`number`}   />
@@ -187,7 +183,7 @@ the Order has been performed.
 <MemberInfo kind="property" type={`number`}   />
-This is the price as listed by the ProductVariant (and possibly modified by the <a href='/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy'>OrderItemPriceCalculationStrategy</a>),
+This is the price as listed by the ProductVariant (and possibly modified by the <DocsLink href="/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy">OrderItemPriceCalculationStrategy</DocsLink>),
 which, depending on the current Channel, may or may not include tax.
 ### listPriceIncludesTax

package/docs/reference/typescript-api/entities/order-modification.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "OrderModification"
 generated: true
 ---
-## OrderModification
 <GenerationInfo sourceFile="packages/core/src/entity/order-modification/order-modification.entity.ts" sourceLine="21" packageName="@vendure/core" />
 An entity which represents a modification to an order which has been placed, and

package/docs/reference/typescript-api/entities/order.mdx CHANGED Viewed

@@ -2,17 +2,13 @@
 title: "Order"
 generated: true
 ---
-## Order
 <GenerationInfo sourceFile="packages/core/src/entity/order/order.entity.ts" sourceLine="43" packageName="@vendure/core" />
-An Order is created whenever a <a href='/reference/typescript-api/entities/customer#customer'>Customer</a> adds an item to the cart. It contains all the
-information required to fulfill an order: which <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>s in what quantities;
+An Order is created whenever a <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink> adds an item to the cart. It contains all the
+information required to fulfill an order: which <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>s in what quantities;
 the shipping address and price; any applicable promotions; payments etc.
-An Order exists in a well-defined state according to the <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a> type. A state machine
+An Order exists in a well-defined state according to the <DocsLink href="/reference/typescript-api/orders/order-process#orderstate">OrderState</DocsLink> type. A state machine
 is used to govern the transition from one state to another.
 ```ts title="Signature"
@@ -124,7 +120,7 @@ class Order extends VendureEntity implements ChannelAware, HasCustomFields {
 <MemberInfo kind="property" type={`string`}   />
 A unique code for the Order, generated according to the
-<a href='/reference/typescript-api/orders/order-code-strategy#ordercodestrategy'>OrderCodeStrategy</a>. This should be used as an order reference
+<DocsLink href="/reference/typescript-api/orders/order-code-strategy#ordercodestrategy">OrderCodeStrategy</DocsLink>. This should be used as an order reference
 for Customers, rather than the Order's id.
 ### state
@@ -138,14 +134,14 @@ for Customers, rather than the Order's id.
 Whether the Order is considered "active", meaning that the
 Customer can still make changes to it and has not yet completed
 the checkout process.
-This is governed by the <a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>.
+This is governed by the <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>.
 ### orderPlacedAt
 <MemberInfo kind="property" type={`Date`}   />
 The date & time that the Order was placed, i.e. the Customer
 completed the checkout and the Order is no longer "active".
-This is governed by the <a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>.
+This is governed by the <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>.
 ### customer
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`}   />
@@ -232,7 +228,7 @@ i.e. the Order is no longer active.
 The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
 discounts which have been prorated (proportionally distributed) amongst the OrderItems.
 To get a total of all OrderLines which does not account for prorated discounts, use the
-sum of <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>'s `discountedLinePrice` values.
+sum of <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>'s `discountedLinePrice` values.
 ### subTotalWithTax
 <MemberInfo kind="property" type={`number`}   />

package/docs/reference/typescript-api/entities/orderable-asset.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "OrderableAsset"
 generated: true
 ---
-## OrderableAsset
 <GenerationInfo sourceFile="packages/core/src/entity/asset/orderable-asset.entity.ts" sourceLine="18" packageName="@vendure/core" />
 This base class is extended in order to enable specific ordering of the one-to-many

package/docs/reference/typescript-api/entities/payment-method.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "PaymentMethod"
 generated: true
 ---
-## PaymentMethod
 <GenerationInfo sourceFile="packages/core/src/entity/payment-method/payment-method.entity.ts" sourceLine="21" packageName="@vendure/core" />
-A PaymentMethod is created automatically according to the configured <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>s defined
-in the <a href='/reference/typescript-api/payment/payment-options#paymentoptions'>PaymentOptions</a> config.
+A PaymentMethod is created automatically according to the configured <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink>s defined
+in the <DocsLink href="/reference/typescript-api/payment/payment-options#paymentoptions">PaymentOptions</DocsLink> config.
 ```ts title="Signature"
 class PaymentMethod extends VendureEntity implements Translatable, ChannelAware, HasCustomFields {

package/docs/reference/typescript-api/entities/payment.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "Payment"
 generated: true
 ---
-## Payment
 <GenerationInfo sourceFile="packages/core/src/entity/payment/payment.entity.ts" sourceLine="20" packageName="@vendure/core" />
 A Payment represents a single payment transaction and exists in a well-defined state
-defined by the <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a> type.
+defined by the <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> type.
 ```ts title="Signature"
 class Payment extends VendureEntity implements HasCustomFields {

package/docs/reference/typescript-api/entities/product-option-group.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "ProductOptionGroup"
 generated: true
 ---
-## ProductOptionGroup
 <GenerationInfo sourceFile="packages/core/src/entity/product-option-group/product-option-group.entity.ts" sourceLine="20" packageName="@vendure/core" />
-A grouping of one or more <a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>s.
+A grouping of one or more <DocsLink href="/reference/typescript-api/entities/product-option#productoption">ProductOption</DocsLink>s.
 ```ts title="Signature"
 class ProductOptionGroup extends VendureEntity implements Translatable, HasCustomFields, SoftDeletable {

package/docs/reference/typescript-api/entities/product-option.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "ProductOption"
 generated: true
 ---
-## ProductOption
 <GenerationInfo sourceFile="packages/core/src/entity/product-option/product-option.entity.ts" sourceLine="21" packageName="@vendure/core" />
-A ProductOption is used to differentiate <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>s from one another.
+A ProductOption is used to differentiate <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>s from one another.
 ```ts title="Signature"
 class ProductOption extends VendureEntity implements Translatable, HasCustomFields, SoftDeletable {

package/docs/reference/typescript-api/entities/product-variant-price.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "ProductVariantPrice"
 generated: true
 ---
-## ProductVariantPrice
 <GenerationInfo sourceFile="packages/core/src/entity/product-variant/product-variant-price.entity.ts" sourceLine="20" packageName="@vendure/core" />
 A ProductVariantPrice is a Channel-specific price for a ProductVariant. For every Channel to

package/docs/reference/typescript-api/entities/product-variant.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "ProductVariant"
 generated: true
 ---
-## ProductVariant
 <GenerationInfo sourceFile="packages/core/src/entity/product-variant/product-variant.entity.ts" sourceLine="38" packageName="@vendure/core" />
 A ProductVariant represents a single stock keeping unit (SKU) in the store's inventory.
-Whereas a <a href='/reference/typescript-api/entities/product#product'>Product</a> is a "container" of variants, the variant itself holds the
+Whereas a <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> is a "container" of variants, the variant itself holds the
 data on price, tax category etc. When one adds items to their cart, they are adding
 ProductVariants, not Products.

package/docs/reference/typescript-api/entities/product.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "Product"
 generated: true
 ---
-## Product
 <GenerationInfo sourceFile="packages/core/src/entity/product/product.entity.ts" sourceLine="26" packageName="@vendure/core" />
-A Product contains one or more <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>s and serves as a container for those variants,
+A Product contains one or more <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>s and serves as a container for those variants,
 providing an overall name, description etc.
 ```ts title="Signature"

package/docs/reference/typescript-api/entities/promotion.mdx CHANGED Viewed

@@ -2,17 +2,13 @@
 title: "Promotion"
 generated: true
 ---
-## Promotion
 <GenerationInfo sourceFile="packages/core/src/entity/promotion/promotion.entity.ts" sourceLine="61" packageName="@vendure/core" />
 A Promotion is used to define a set of conditions under which promotions actions (typically discounts)
 will be applied to an Order.
-Each assigned <a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a> is checked against the Order, and if they all return `true`,
-then each assign <a href='/reference/typescript-api/promotions/promotion-action#promotionitemaction'>PromotionItemAction</a> / <a href='/reference/typescript-api/promotions/promotion-action#promotionlineaction'>PromotionLineAction</a> / <a href='/reference/typescript-api/promotions/promotion-action#promotionorderaction'>PromotionOrderAction</a> / <a href='/reference/typescript-api/promotions/promotion-action#promotionshippingaction'>PromotionShippingAction</a> is applied to the Order.
+Each assigned <DocsLink href="/reference/typescript-api/promotions/promotion-condition#promotioncondition">PromotionCondition</DocsLink> is checked against the Order, and if they all return `true`,
+then each assign <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionitemaction">PromotionItemAction</DocsLink> / <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionlineaction">PromotionLineAction</DocsLink> / <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionorderaction">PromotionOrderAction</DocsLink> / <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionshippingaction">PromotionShippingAction</DocsLink> is applied to the Order.
 ```ts title="Signature"
 class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable, HasCustomFields, Translatable {

package/docs/reference/typescript-api/entities/province.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "Province"
 generated: true
 ---
-## Province
 <GenerationInfo sourceFile="packages/core/src/entity/region/province.entity.ts" sourceLine="13" packageName="@vendure/core" />
-A Province represents an administrative subdivision of a <a href='/reference/typescript-api/entities/country#country'>Country</a>. For example, in the
+A Province represents an administrative subdivision of a <DocsLink href="/reference/typescript-api/entities/country#country">Country</DocsLink>. For example, in the
 United States, the country would be "United States" and the province would be "California".
 ```ts title="Signature"

package/docs/reference/typescript-api/entities/refund.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Refund"
 generated: true
 ---
-## Refund
 <GenerationInfo sourceFile="packages/core/src/entity/refund/refund.entity.ts" sourceLine="19" packageName="@vendure/core" />
 A refund the belongs to an order