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/payment/dummy-payment-handler.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "DummyPaymentHandler"
 generated: true
 ---
-## dummyPaymentHandler
 <GenerationInfo sourceFile="packages/core/src/config/payment/dummy-payment-method-handler.ts" sourceLine="27" packageName="@vendure/core" />
 A dummy PaymentMethodHandler which simply creates a Payment without any integration

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

@@ -2,13 +2,9 @@
 title: "PaymentMethodConfigOptions"
 generated: true
 ---
-## PaymentMethodConfigOptions
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="255" packageName="@vendure/core" />
-Defines the object which is used to construct the <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>.
+Defines the object which is used to construct the <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink>.
 ```ts title="Signature"
 interface PaymentMethodConfigOptions<T extends ConfigArgs> extends ConfigurableOperationDefOptions<T> {
@@ -31,7 +27,7 @@ interface PaymentMethodConfigOptions<T extends ConfigArgs> extends ConfigurableO
 This function provides the logic for creating a payment. For example,
 it may call out to a third-party service with the data and should return a
-<a href='/reference/typescript-api/payment/payment-method-types#createpaymentresult'>CreatePaymentResult</a> object contains the details of the payment.
+<DocsLink href="/reference/typescript-api/payment/payment-method-types#createpaymentresult">CreatePaymentResult</DocsLink> object contains the details of the payment.
 ### settlePayment
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a><T>`}   />
@@ -61,7 +57,7 @@ omitted and any Refunds will have to be settled manually by an administrator.
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`}   />
-This function, when specified, will be invoked before any transition from one <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a> to another.
+This function, when specified, will be invoked before any transition from one <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> to another.
 The return value (a sync / async `boolean`) is used to determine whether the transition is permitted.

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

@@ -2,14 +2,10 @@
 title: "PaymentMethodEligibilityChecker"
 generated: true
 ---
-## PaymentMethodEligibilityChecker
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-eligibility-checker.ts" sourceLine="47" packageName="@vendure/core" />
 The PaymentMethodEligibilityChecker class is used to check whether an order qualifies for a
-given <a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>.
+given <DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink>.
 *Example*
@@ -45,13 +41,9 @@ class PaymentMethodEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends
 </div>
-## PaymentMethodEligibilityCheckerConfig
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-eligibility-checker.ts" sourceLine="20" packageName="@vendure/core" />
-Configuration passed into the constructor of a <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker'>PaymentMethodEligibilityChecker</a> to
+Configuration passed into the constructor of a <DocsLink href="/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker">PaymentMethodEligibilityChecker</DocsLink> to
 configure its behavior.
 ```ts title="Signature"
@@ -73,13 +65,9 @@ interface PaymentMethodEligibilityCheckerConfig<T extends ConfigArgs> extends Co
 </div>
-## CheckPaymentMethodEligibilityCheckerFn
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-eligibility-checker.ts" sourceLine="83" packageName="@vendure/core" />
-A function which implements logic to determine whether a given <a href='/reference/typescript-api/entities/order#order'>Order</a> is eligible for
+A function which implements logic to determine whether a given <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> is eligible for
 a particular payment method. If the function resolves to `false` or a string, the check is
 considered to have failed. A string result can be used to provide information about the
 reason for ineligibility, if desired.

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

@@ -2,10 +2,6 @@
 title: "PaymentMethodHandler"
 generated: true
 ---
-## PaymentMethodHandler
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="354" packageName="@vendure/core" />
 A PaymentMethodHandler contains the code which is used to generate a Payment when a call to the
@@ -13,7 +9,7 @@ A PaymentMethodHandler contains the code which is used to generate a Payment whe
 third-party payment gateway before the Payment is created and can also define actions to fire
 when the state of the payment is changed.
-PaymentMethodHandlers are instantiated using a <a href='/reference/typescript-api/payment/payment-method-config-options#paymentmethodconfigoptions'>PaymentMethodConfigOptions</a> object, which
+PaymentMethodHandlers are instantiated using a <DocsLink href="/reference/typescript-api/payment/payment-method-config-options#paymentmethodconfigoptions">PaymentMethodConfigOptions</DocsLink> object, which
 configures the business logic used to create, settle and refund payments.
 *Example*

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

@@ -2,13 +2,9 @@
 title: "Payment Method Types"
 generated: true
 ---
-## CreatePaymentResult
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="30" packageName="@vendure/core" />
-This object is the return value of the <a href='/reference/typescript-api/payment/payment-method-types#createpaymentfn'>CreatePaymentFn</a>.
+This object is the return value of the <DocsLink href="/reference/typescript-api/payment/payment-method-types#createpaymentfn">CreatePaymentFn</DocsLink>.
 ```ts title="Signature"
 interface CreatePaymentResult {
@@ -33,12 +29,12 @@ are being used for the order.
 <MemberInfo kind="property" type={`Exclude<<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, 'Error'>`}   />
-The <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a> of the resulting Payment.
+The <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> of the resulting Payment.
 In a single-step payment flow, this should be set to `'Settled'`.
 In a two-step flow, this should be set to `'Authorized'`.
-If using a <a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>, may be something else
+If using a <DocsLink href="/reference/typescript-api/payment/payment-process#paymentprocess">PaymentProcess</DocsLink>, may be something else
 entirely according to your business logic.
 ### transactionId
@@ -68,13 +64,9 @@ url which must then be passed to the storefront app.
 </div>
-## CreatePaymentErrorResult
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="83" packageName="@vendure/core" />
-This object is the return value of the <a href='/reference/typescript-api/payment/payment-method-types#createpaymentfn'>CreatePaymentFn</a> when there has been an error.
+This object is the return value of the <DocsLink href="/reference/typescript-api/payment/payment-method-types#createpaymentfn">CreatePaymentFn</DocsLink> when there has been an error.
 ```ts title="Signature"
 interface CreatePaymentErrorResult {
@@ -116,13 +108,9 @@ interface CreatePaymentErrorResult {
 </div>
-## CreateRefundResult
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="98" packageName="@vendure/core" />
-This object is the return value of the <a href='/reference/typescript-api/payment/payment-method-types#createrefundfn'>CreateRefundFn</a>.
+This object is the return value of the <DocsLink href="/reference/typescript-api/payment/payment-method-types#createrefundfn">CreateRefundFn</DocsLink>.
 ```ts title="Signature"
 interface CreateRefundResult {
@@ -152,13 +140,9 @@ interface CreateRefundResult {
 </div>
-## SettlePaymentResult
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="112" packageName="@vendure/core" />
-This object is the return value of the <a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a> when the Payment
+This object is the return value of the <DocsLink href="/reference/typescript-api/payment/payment-method-types#settlepaymentfn">SettlePaymentFn</DocsLink> when the Payment
 has been successfully settled.
 ```ts title="Signature"
@@ -183,13 +167,9 @@ interface SettlePaymentResult {
 </div>
-## SettlePaymentErrorResult
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="125" packageName="@vendure/core" />
-This object is the return value of the <a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a> when the Payment
+This object is the return value of the <DocsLink href="/reference/typescript-api/payment/payment-method-types#settlepaymentfn">SettlePaymentFn</DocsLink> when the Payment
 could not be settled.
 ```ts title="Signature"
@@ -216,7 +196,7 @@ The state to transition this Payment to upon unsuccessful settlement.
 Defaults to `Error`. Note that if using a different state, it must be
 legal to transition to that state from the `Authorized` state according
 to the PaymentState config (which can be customized using the
-<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>).
+<DocsLink href="/reference/typescript-api/payment/payment-process#paymentprocess">PaymentProcess</DocsLink>).
 ### errorMessage
 <MemberInfo kind="property" type={`string`}   />
@@ -231,13 +211,9 @@ also be persisted as `Payment.errorMessage`.
 </div>
-## CancelPaymentResult
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="153" packageName="@vendure/core" />
-This object is the return value of the <a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentfn'>CancelPaymentFn</a> when the Payment
+This object is the return value of the <DocsLink href="/reference/typescript-api/payment/payment-method-types#cancelpaymentfn">CancelPaymentFn</DocsLink> when the Payment
 has been successfully cancelled.
 ```ts title="Signature"
@@ -262,13 +238,9 @@ interface CancelPaymentResult {
 </div>
-## CancelPaymentErrorResult
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="165" packageName="@vendure/core" />
-This object is the return value of the <a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentfn'>CancelPaymentFn</a> when the Payment
+This object is the return value of the <DocsLink href="/reference/typescript-api/payment/payment-method-types#cancelpaymentfn">CancelPaymentFn</DocsLink> when the Payment
 could not be cancelled.
 ```ts title="Signature"
@@ -295,7 +267,7 @@ The state to transition this Payment to upon unsuccessful cancellation.
 Defaults to `Error`. Note that if using a different state, it must be
 legal to transition to that state from the `Authorized` state according
 to the PaymentState config (which can be customized using the
-<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>).
+<DocsLink href="/reference/typescript-api/payment/payment-process#paymentprocess">PaymentProcess</DocsLink>).
 ### errorMessage
 <MemberInfo kind="property" type={`string`}   />
@@ -310,15 +282,11 @@ also be persisted as `Payment.errorMessage`.
 </div>
-## CreatePaymentFn
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="193" packageName="@vendure/core" />
-This function contains the logic for creating a payment. See <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a> for an example.
+This function contains the logic for creating a payment. See <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink> for an example.
-Returns a <a href='/reference/typescript-api/payment/payment-method-types#createpaymentresult'>CreatePaymentResult</a>.
+Returns a <DocsLink href="/reference/typescript-api/payment/payment-method-types#createpaymentresult">CreatePaymentResult</DocsLink>.
 ```ts title="Signature"
 type CreatePaymentFn<T extends ConfigArgs> = (
@@ -330,13 +298,9 @@ type CreatePaymentFn<T extends ConfigArgs> = (
     method: PaymentMethod,
 ) => CreatePaymentResult | CreatePaymentErrorResult | Promise<CreatePaymentResult | CreatePaymentErrorResult>
 ```
-## SettlePaymentFn
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="209" packageName="@vendure/core" />
-This function contains the logic for settling a payment. See <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a> for an example.
+This function contains the logic for settling a payment. See <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink> for an example.
 ```ts title="Signature"
 type SettlePaymentFn<T extends ConfigArgs> = (
@@ -347,13 +311,9 @@ type SettlePaymentFn<T extends ConfigArgs> = (
     method: PaymentMethod,
 ) => SettlePaymentResult | SettlePaymentErrorResult | Promise<SettlePaymentResult | SettlePaymentErrorResult>
 ```
-## CancelPaymentFn
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="224" packageName="@vendure/core" />
-This function contains the logic for cancelling a payment. See <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a> for an example.
+This function contains the logic for cancelling a payment. See <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink> for an example.
 ```ts title="Signature"
 type CancelPaymentFn<T extends ConfigArgs> = (
@@ -364,13 +324,9 @@ type CancelPaymentFn<T extends ConfigArgs> = (
     method: PaymentMethod,
 ) => CancelPaymentResult | CancelPaymentErrorResult | Promise<CancelPaymentResult | CancelPaymentErrorResult>
 ```
-## CreateRefundFn
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="239" packageName="@vendure/core" />
-This function contains the logic for creating a refund. See <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a> for an example.
+This function contains the logic for creating a refund. See <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink> for an example.
 ```ts title="Signature"
 type CreateRefundFn<T extends ConfigArgs> = (

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

@@ -2,13 +2,9 @@
 title: "PaymentOptions"
 generated: true
 ---
-## PaymentOptions
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="873" packageName="@vendure/core" />
-Defines payment-related options in the <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>.
+Defines payment-related options in the <DocsLink href="/reference/typescript-api/configuration/vendure-config#vendureconfig">VendureConfig</DocsLink>.
 ```ts title="Signature"
 interface PaymentOptions {
@@ -26,14 +22,14 @@ interface PaymentOptions {
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>[]`}   />
-Defines which <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>s are available when configuring
-<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>s
+Defines which <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink>s are available when configuring
+<DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink>s
 ### paymentMethodEligibilityCheckers
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker'>PaymentMethodEligibilityChecker</a>[]`}   />
-Defines which <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker'>PaymentMethodEligibilityChecker</a>s are available when configuring
-<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>s
+Defines which <DocsLink href="/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker">PaymentMethodEligibilityChecker</DocsLink>s are available when configuring
+<DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink>s
 ### customPaymentProcess
 <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`}   />
@@ -44,13 +40,13 @@ Defines which <a href='/reference/typescript-api/payment/payment-method-eligibil
 <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-payment-process#defaultpaymentprocess'>defaultPaymentProcess</a>`}  since="2.0.0"  />
 Allows the definition of custom states and transition logic for the payment process state machine.
-Takes an array of objects implementing the <a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a> interface.
+Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/payment-process#paymentprocess">PaymentProcess</DocsLink> interface.
 ### refundProcess
 <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-refund-process#defaultrefundprocess'>defaultRefundProcess</a>`}   />
 Allows the definition of custom states and transition logic for the refund process state machine.
-Takes an array of objects implementing the <a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a> interface.
+Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/refund-process#refundprocess">RefundProcess</DocsLink> interface.
 </div>

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

@@ -2,10 +2,6 @@
 title: "PaymentProcess"
 generated: true
 ---
-## PaymentProcess
 <GenerationInfo sourceFile="packages/core/src/config/payment/payment-process.ts" sourceLine="33" packageName="@vendure/core" since="2.0.0" />
 A PaymentProcess is used to define the way the payment process works as in: what states a Payment can be
@@ -13,7 +9,7 @@ in, and how it may transition from one state to another. Using the `onTransition
 PaymentProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
 hook allows logic to be executed after a state change.
-For detailed description of the interface members, see the <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a> docs.
+For detailed description of the interface members, see the <DocsLink href="/reference/typescript-api/state-machine/state-machine-config#statemachineconfig">StateMachineConfig</DocsLink> docs.
 :::info

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

@@ -2,10 +2,6 @@
 title: "PaymentState"
 generated: true
 ---
-## PaymentState
 <GenerationInfo sourceFile="packages/core/src/service/helpers/payment-state-machine/payment-state.ts" sourceLine="27" packageName="@vendure/core" />
 These are the default states of the payment process.

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

@@ -2,13 +2,9 @@
 title: "PaymentStates"
 generated: true
 ---
-## PaymentStates
 <GenerationInfo sourceFile="packages/core/src/service/helpers/payment-state-machine/payment-state.ts" sourceLine="19" packageName="@vendure/core" />
-An interface to extend standard <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>.
+An interface to extend standard <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink>.
 ```ts title="Signature"
 interface PaymentStates {

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

@@ -2,10 +2,6 @@
 title: "PaymentTransitionData"
 generated: true
 ---
-## PaymentTransitionData
 <GenerationInfo sourceFile="packages/core/src/service/helpers/payment-state-machine/payment-state.ts" sourceLine="41" packageName="@vendure/core" />
 The data which is passed to the `onStateTransitionStart` function configured when constructing

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

@@ -2,10 +2,6 @@
 title: "RefundProcess"
 generated: true
 ---
-## RefundProcess
 <GenerationInfo sourceFile="packages/core/src/config/refund/refund-process.ts" sourceLine="25" packageName="@vendure/core" />
 A RefundProcess is used to define the way the refund process works as in: what states a Refund can be
@@ -13,7 +9,7 @@ in, and how it may transition from one state to another. Using the `onTransition
 RefundProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
 hook allows logic to be executed after a state change.
-For detailed description of the interface members, see the <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a> docs.
+For detailed description of the interface members, see the <DocsLink href="/reference/typescript-api/state-machine/state-machine-config#statemachineconfig">StateMachineConfig</DocsLink> docs.
 ```ts title="Signature"
 interface RefundProcess<State extends keyof CustomRefundStates | string> extends InjectableStrategy {

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

@@ -2,10 +2,6 @@
 title: "RefundState"
 generated: true
 ---
-## RefundState
 <GenerationInfo sourceFile="packages/core/src/service/helpers/refund-state-machine/refund-state.ts" sourceLine="27" packageName="@vendure/core" />
 These are the default states of the refund process.

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

@@ -2,13 +2,9 @@
 title: "RefundStates"
 generated: true
 ---
-## RefundStates
 <GenerationInfo sourceFile="packages/core/src/service/helpers/refund-state-machine/refund-state.ts" sourceLine="19" packageName="@vendure/core" />
-An interface to extend standard <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>.
+An interface to extend standard <DocsLink href="/reference/typescript-api/payment/refund-state#refundstate">RefundState</DocsLink>.
 ```ts title="Signature"
 interface RefundStates {

package/docs/reference/typescript-api/payment/refund-transition-data.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "RefundTransitionData"
 generated: true
 ---
-## RefundTransitionData
 <GenerationInfo sourceFile="packages/core/src/service/helpers/refund-state-machine/refund-state.ts" sourceLine="35" packageName="@vendure/core" />
 The data which is passed to the state transition handler of the RefundStateMachine.

package/docs/reference/typescript-api/plugin/plugin-common-module.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "PluginCommonModule"
 generated: true
 ---
-## PluginCommonModule
 <GenerationInfo sourceFile="packages/core/src/plugin/plugin-common.module.ts" sourceLine="30" packageName="@vendure/core" />
 This module provides the common services, configuration, and event bus capabilities
@@ -14,11 +10,11 @@ repeat the same boilerplate for each individual plugin.
 The PluginCommonModule exports:
-* `EventBusModule`, allowing the injection of the <a href='/reference/typescript-api/events/event-bus#eventbus'>EventBus</a> service.
+* `EventBusModule`, allowing the injection of the <DocsLink href="/reference/typescript-api/events/event-bus#eventbus">EventBus</DocsLink> service.
 * `ServiceModule` allowing the injection of any of the various entity services such as ProductService, OrderService etc.
 * `ConfigModule`, allowing the injection of the ConfigService.
-* `JobQueueModule`, allowing the injection of the <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a>.
-* `HealthCheckModule`, allowing the injection of the <a href='/reference/typescript-api/health-check/health-check-registry-service#healthcheckregistryservice'>HealthCheckRegistryService</a>.
+* `JobQueueModule`, allowing the injection of the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink>.
+* `HealthCheckModule`, allowing the injection of the <DocsLink href="/reference/typescript-api/health-check/health-check-registry-service#healthcheckregistryservice">HealthCheckRegistryService</DocsLink>.
 ```ts title="Signature"
 class PluginCommonModule {

package/docs/reference/typescript-api/plugin/plugin-utilities.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Plugin Utilities"
 generated: true
 ---
-## createProxyHandler
 <GenerationInfo sourceFile="packages/core/src/plugin/plugin-utils.ts" sourceLine="37" packageName="@vendure/core" />
 Creates a proxy middleware which proxies the given route to the given port.
@@ -44,13 +40,9 @@ Parameters
 <MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/plugin/plugin-utilities#proxyoptions'>ProxyOptions</a>`} />
-## ProxyOptions
 <GenerationInfo sourceFile="packages/core/src/plugin/plugin-utils.ts" sourceLine="74" packageName="@vendure/core" />
-Options to configure proxy middleware via <a href='/reference/typescript-api/plugin/plugin-utilities#createproxyhandler'>createProxyHandler</a>.
+Options to configure proxy middleware via <DocsLink href="/reference/typescript-api/plugin/plugin-utilities#createproxyhandler">createProxyHandler</DocsLink>.
 ```ts title="Signature"
 interface ProxyOptions {

package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "VendurePluginMetadata"
 generated: true
 ---
-## VendurePluginMetadata
 <GenerationInfo sourceFile="packages/core/src/plugin/vendure-plugin.ts" sourceLine="23" packageName="@vendure/core" />
 Defines the metadata of a Vendure plugin. This interface is an superset of the [Nestjs ModuleMetadata](https://docs.nestjs.com/modules)
@@ -33,7 +29,7 @@ interface VendurePluginMetadata extends ModuleMetadata {
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/plugin/vendure-plugin-metadata#pluginconfigurationfn'>PluginConfigurationFn</a>`}   />
-A function which can modify the <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a> object before the server bootstraps.
+A function which can modify the <DocsLink href="/reference/typescript-api/configuration/vendure-config#vendureconfig">VendureConfig</DocsLink> object before the server bootstraps.
 ### shopApiExtensions
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/plugin/vendure-plugin-metadata#apiextensiondefinition'>APIExtensionDefinition</a>`}   />
@@ -71,7 +67,7 @@ To effectively disable this check for a plugin, you can use an overly-permissive
 :::note
 Since Vendure v3.1.0, it is possible to ignore compatibility errors for specific plugins by
-passing the `ignoreCompatibilityErrorsForPlugins` option to the <a href='/reference/typescript-api/common/bootstrap#bootstrap'>bootstrap</a> function.
+passing the `ignoreCompatibilityErrorsForPlugins` option to the <DocsLink href="/reference/typescript-api/common/bootstrap#bootstrap">bootstrap</DocsLink> function.
 :::
 *Example*
@@ -82,10 +78,6 @@ compatibility: '^3.0.0'
 </div>
-## APIExtensionDefinition
 <GenerationInfo sourceFile="packages/core/src/plugin/vendure-plugin.ts" sourceLine="80" packageName="@vendure/core" />
 An object which allows a plugin to extend the Vendure GraphQL API.
@@ -131,13 +123,9 @@ Read more about defining custom scalars in the
 </div>
-## PluginConfigurationFn
 <GenerationInfo sourceFile="packages/core/src/plugin/vendure-plugin.ts" sourceLine="119" packageName="@vendure/core" />
-This method is called before the app bootstraps and should be used to perform any needed modifications to the <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>.
+This method is called before the app bootstraps and should be used to perform any needed modifications to the <DocsLink href="/reference/typescript-api/configuration/vendure-config#vendureconfig">VendureConfig</DocsLink>.
 ```ts title="Signature"
 type PluginConfigurationFn = (

package/docs/reference/typescript-api/plugin/vendure-plugin.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "VendurePlugin"
 generated: true
 ---
-## VendurePlugin
 <GenerationInfo sourceFile="packages/core/src/plugin/vendure-plugin.ts" sourceLine="164" packageName="@vendure/core" />
 The VendurePlugin decorator is a means of configuring and/or extending the functionality of the Vendure server. A Vendure plugin is

package/docs/reference/typescript-api/products-stock/catalog-options.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "CatalogOptions"
 generated: true
 ---
-## CatalogOptions
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="722" packageName="@vendure/core" />
 Options related to products and collections.
@@ -27,7 +23,7 @@ interface CatalogOptions {
 <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a><any>>`} default={`defaultCollectionFilters`}   />
-Allows custom <a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a>s to be defined.
+Allows custom <DocsLink href="/reference/typescript-api/configuration/collection-filter#collectionfilter">CollectionFilter</DocsLink>s to be defined.
 ### productVariantPriceSelectionStrategy
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/product-variant-price-selection-strategy#productvariantpriceselectionstrategy'>ProductVariantPriceSelectionStrategy</a>`} default={`<a href='/reference/typescript-api/configuration/product-variant-price-selection-strategy#defaultproductvariantpriceselectionstrategy'>DefaultProductVariantPriceSelectionStrategy</a>`}  since="2.0.0"  />