@vendure/docs 0.0.0-202601280949 → 0.0.0-202601281114

package/docs/reference/typescript-api/shipping/shipping-options.mdx

@@ -33,7 +33,7 @@ An array of available ShippingCalculators for use in configuring ShippingMethods
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy'>ShippingLineAssignmentStrategy</a>`}  since="2.0.0"  />
 
-This strategy is used to assign a given <DocsLink href="/reference/typescript-api/entities/shipping-line#shippingline">ShippingLine</DocsLink> to one or more <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>s of the Order.
+This strategy is used to assign a given [ShippingLine](/reference/typescript-api/entities/shipping-line#shippingline) to one or more [OrderLine](/reference/typescript-api/entities/order-line#orderline)s of the Order.
 This allows you to set multiple shipping methods for a single order, each assigned a different subset of
 OrderLines.
 ### customFulfillmentProcess
@@ -41,13 +41,13 @@ OrderLines.
 <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a><any>>`}   />
 
 Allows the definition of custom states and transition logic for the fulfillment process state machine.
-Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
+Takes an array of objects implementing the [FulfillmentProcess](/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess) interface.
 ### process
 
 <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a><any>>`} default={`<a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a>`}  since="2.0.0"  />
 
 Allows the definition of custom states and transition logic for the fulfillment process state machine.
-Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
+Takes an array of objects implementing the [FulfillmentProcess](/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess) interface.
 ### fulfillmentHandlers
 
 <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a><any>>`}   />

package/docs/reference/typescript-api/state-machine/state-machine-config.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/common/finite-state-machine/types.ts" sourceLine="89" packageName="@vendure/core" />
 
-The config object used to instantiate a new <DocsLink href="/reference/typescript-api/state-machine/fsm#fsm">FSM</DocsLink> instance.
+The config object used to instantiate a new [FSM](/reference/typescript-api/state-machine/fsm#fsm) instance.
 
 ```ts title="Signature"
 interface StateMachineConfig<T extends string, Data = undefined> {

package/docs/reference/typescript-api/state-machine/transitions.mdx

@@ -5,7 +5,7 @@ generated: true
 <GenerationInfo sourceFile="packages/core/src/common/finite-state-machine/types.ts" sourceLine="30" packageName="@vendure/core" />
 
 A type which is used to define valid states and transitions for a state machine based
-on <DocsLink href="/reference/typescript-api/state-machine/fsm#fsm">FSM</DocsLink>.
+on [FSM](/reference/typescript-api/state-machine/fsm#fsm).
 
 *Example*
 
@@ -26,7 +26,7 @@ const trafficLightTransitions: Transitions<LightColor> = {
 ```
 
 The `mergeStrategy` property defines how to handle the merging of states when one set of
-transitions is being merged with another (as in the case of defining a <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink>)
+transitions is being merged with another (as in the case of defining a [OrderProcess](/reference/typescript-api/orders/order-process#orderprocess))
 
 ```ts title="Signature"
 type Transitions<State extends string, Target extends string = State> = {

package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx

@@ -4,11 +4,11 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/config/tax/address-based-tax-zone-strategy.ts" sourceLine="40" packageName="@vendure/core" since="3.1.0" />
 
-Address based <DocsLink href="/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy">TaxZoneStrategy</DocsLink> which tries to find the applicable <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink> based on the
+Address based [TaxZoneStrategy](/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy) which tries to find the applicable [Zone](/reference/typescript-api/entities/zone#zone) based on the
 country of the shipping address of the Order.
 This is useful for shops that do cross-border B2C orders and use the One-Stop-Shop (OSS) VAT scheme.
 
-Returns the default <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink>'s default tax zone if no applicable zone is found.
+Returns the default [Channel](/reference/typescript-api/entities/channel#channel)'s default tax zone if no applicable zone is found.
 
 :::info
 
@@ -36,7 +36,7 @@ class AddressBasedTaxZoneStrategy implements TaxZoneStrategy {
     determineTaxZone(ctx: RequestContext, zones: Zone[], channel: Channel, order?: Order) => Zone;
 }
 ```
-* Implements: <DocsLink href="/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy">`TaxZoneStrategy`</DocsLink>
+* Implements: [`TaxZoneStrategy`](/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy)
 
 
 

package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx

@@ -4,15 +4,15 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/config/tax/default-tax-line-calculation-strategy.ts" sourceLine="12" packageName="@vendure/core" />
 
-The default <DocsLink href="/reference/typescript-api/tax/tax-line-calculation-strategy#taxlinecalculationstrategy">TaxLineCalculationStrategy</DocsLink> which applies a single TaxLine to the OrderLine
-based on the applicable <DocsLink href="/reference/typescript-api/entities/tax-rate#taxrate">TaxRate</DocsLink>.
+The default [TaxLineCalculationStrategy](/reference/typescript-api/tax/tax-line-calculation-strategy#taxlinecalculationstrategy) which applies a single TaxLine to the OrderLine
+based on the applicable [TaxRate](/reference/typescript-api/entities/tax-rate#taxrate).
 
 ```ts title="Signature"
 class DefaultTaxLineCalculationStrategy implements TaxLineCalculationStrategy {
     calculate(args: CalculateTaxLinesArgs) => TaxLine[];
 }
 ```
-* Implements: <DocsLink href="/reference/typescript-api/tax/tax-line-calculation-strategy#taxlinecalculationstrategy">`TaxLineCalculationStrategy`</DocsLink>
+* Implements: [`TaxLineCalculationStrategy`](/reference/typescript-api/tax/tax-line-calculation-strategy#taxlinecalculationstrategy)
 
 
 

package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx

@@ -7,14 +7,14 @@ generated: true
 A default method of determining Zone for tax calculations. The strategy simply returns the default
 tax zone of the Channel. In many cases you actually want to base the tax zone
 on the shipping or billing address of the Order, in which case you would use the
-<DocsLink href="/reference/typescript-api/tax/address-based-tax-zone-strategy#addressbasedtaxzonestrategy">AddressBasedTaxZoneStrategy</DocsLink>.
+[AddressBasedTaxZoneStrategy](/reference/typescript-api/tax/address-based-tax-zone-strategy#addressbasedtaxzonestrategy).
 
 ```ts title="Signature"
 class DefaultTaxZoneStrategy implements TaxZoneStrategy {
     determineTaxZone(ctx: RequestContext, zones: Zone[], channel: Channel, order?: Order) => Zone;
 }
 ```
-* Implements: <DocsLink href="/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy">`TaxZoneStrategy`</DocsLink>
+* Implements: [`TaxZoneStrategy`](/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy)
 
 
 

package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx

@@ -5,8 +5,8 @@ generated: true
 <GenerationInfo sourceFile="packages/core/src/config/tax/tax-line-calculation-strategy.ts" sourceLine="29" packageName="@vendure/core" />
 
 This strategy defines how the TaxLines on OrderItems are calculated. By default,
-the <DocsLink href="/reference/typescript-api/tax/default-tax-line-calculation-strategy#defaulttaxlinecalculationstrategy">DefaultTaxLineCalculationStrategy</DocsLink> is used, which directly applies
-a single TaxLine based on the applicable <DocsLink href="/reference/typescript-api/entities/tax-rate#taxrate">TaxRate</DocsLink>.
+the [DefaultTaxLineCalculationStrategy](/reference/typescript-api/tax/default-tax-line-calculation-strategy#defaulttaxlinecalculationstrategy) is used, which directly applies
+a single TaxLine based on the applicable [TaxRate](/reference/typescript-api/entities/tax-rate#taxrate).
 
 However, custom strategies may use any suitable method for calculating TaxLines.
 For example, a third-party tax API or a lookup of a custom tax table may be used.
@@ -23,7 +23,7 @@ interface TaxLineCalculationStrategy extends InjectableStrategy {
     calculate(args: CalculateTaxLinesArgs): TaxLine[] | Promise<TaxLine[]>;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
+* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
 
 
 

package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/config/tax/tax-zone-strategy.ts" sourceLine="28" packageName="@vendure/core" />
 
-Defines how the active <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink> is determined for the purposes of calculating taxes.
+Defines how the active [Zone](/reference/typescript-api/entities/zone#zone) is determined for the purposes of calculating taxes.
 
 This strategy is used in 2 scenarios:
 
@@ -33,7 +33,7 @@ interface TaxZoneStrategy extends InjectableStrategy {
     ): Zone | Promise<Zone> | undefined;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
+* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
 
 
 

package/docs/reference/typescript-api/telemetry/instrument.mdx

@@ -5,7 +5,7 @@ generated: true
 <GenerationInfo sourceFile="packages/core/src/common/instrument-decorator.ts" sourceLine="47" packageName="@vendure/core" since="3.3.0" />
 
 This decorator is used to apply instrumentation to a class. It is intended to be used in conjunction
-with an <DocsLink href="/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy">InstrumentationStrategy</DocsLink> which defines how the instrumentation should be applied.
+with an [InstrumentationStrategy](/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy) which defines how the instrumentation should be applied.
 
 In order for the instrumentation to be applied, the `VENDURE_ENABLE_INSTRUMENTATION` environment
 variable (exported from the `@vendure/core` package as `ENABLE_INSTRUMENTATION_ENV_VAR`) must be set to `true`.

package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx

@@ -5,14 +5,14 @@ generated: true
 <GenerationInfo sourceFile="packages/core/src/config/system/instrumentation-strategy.ts" sourceLine="51" packageName="@vendure/core" since="3.3.0" />
 
 This interface is used to define a strategy for instrumenting methods of
-classes which are decorated with the <DocsLink href="/reference/typescript-api/telemetry/instrument#instrument">Instrument</DocsLink> decorator.
+classes which are decorated with the [Instrument](/reference/typescript-api/telemetry/instrument#instrument) decorator.
 
 ```ts title="Signature"
 interface InstrumentationStrategy extends InjectableStrategy {
     wrapMethod(args: WrappedMethodArgs): any;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
+* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
 
 
 

package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx

@@ -5,7 +5,7 @@ generated: true
 <GenerationInfo sourceFile="packages/core/src/config/system/instrumentation-strategy.ts" sourceLine="13" packageName="@vendure/core" since="3.3.0" />
 
 The arguments that are passed to the `wrapMethod` method of the
-<DocsLink href="/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy">InstrumentationStrategy</DocsLink> interface.
+[InstrumentationStrategy](/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy) interface.
 
 ```ts title="Signature"
 interface WrappedMethodArgs {

package/docs/reference/typescript-api/testing/create-error-result-guard.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/testing/src/error-result-guard.ts" sourceLine="18" packageName="@vendure/testing" />
 
-Convenience method for creating an <DocsLink href="/reference/typescript-api/testing/error-result-guard#errorresultguard">ErrorResultGuard</DocsLink>. Takes a predicate function which
+Convenience method for creating an [ErrorResultGuard](/reference/typescript-api/testing/error-result-guard#errorresultguard). Takes a predicate function which
 tests whether the input is considered successful (true) or an error result (false).
 
 Note that the resulting variable must _still_ be type annotated in order for the TypeScript

package/docs/reference/typescript-api/testing/create-test-environment.mdx

@@ -4,8 +4,8 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/testing/src/create-test-environment.ts" sourceLine="60" packageName="@vendure/testing" />
 
-Configures a <DocsLink href="/reference/typescript-api/testing/test-server#testserver">TestServer</DocsLink> and a <DocsLink href="/reference/typescript-api/testing/simple-graph-qlclient#simplegraphqlclient">SimpleGraphQLClient</DocsLink> for each of the GraphQL APIs
-for use in end-to-end tests. Returns a <DocsLink href="/reference/typescript-api/testing/test-environment#testenvironment">TestEnvironment</DocsLink> object.
+Configures a [TestServer](/reference/typescript-api/testing/test-server#testserver) and a [SimpleGraphQLClient](/reference/typescript-api/testing/simple-graph-qlclient#simplegraphqlclient) for each of the GraphQL APIs
+for use in end-to-end tests. Returns a [TestEnvironment](/reference/typescript-api/testing/test-environment#testenvironment) object.
 
 *Example*
 

package/docs/reference/typescript-api/testing/get-superadmin-context.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/testing/src/utils/get-superadmin-context.ts" sourceLine="11" packageName="@vendure/testing" />
 
-Creates a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> configured for the default Channel with the activeUser set
+Creates a [RequestContext](/reference/typescript-api/request/request-context#requestcontext) configured for the default Channel with the activeUser set
 as the superadmin user. Useful for populating data.
 
 ```ts title="Signature"

package/docs/reference/typescript-api/testing/register-initializer.mdx

@@ -4,8 +4,8 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/testing/src/initializers/initializers.ts" sourceLine="16" packageName="@vendure/testing" />
 
-Registers a <DocsLink href="/reference/typescript-api/testing/test-db-initializer#testdbinitializer">TestDbInitializer</DocsLink> for the given database type. Should be called before invoking
-<DocsLink href="/reference/typescript-api/testing/create-test-environment#createtestenvironment">createTestEnvironment</DocsLink>.
+Registers a [TestDbInitializer](/reference/typescript-api/testing/test-db-initializer#testdbinitializer) for the given database type. Should be called before invoking
+[createTestEnvironment](/reference/typescript-api/testing/create-test-environment#createtestenvironment).
 
 ```ts title="Signature"
 function registerInitializer(type: DataSourceOptions['type'], initializer: TestDbInitializer<any>): void

package/docs/reference/typescript-api/testing/test-config.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/testing/src/config/test-config.ts" sourceLine="42" packageName="@vendure/testing" />
 
-A <DocsLink href="/reference/typescript-api/configuration/vendure-config#vendureconfig">VendureConfig</DocsLink> object used for e2e tests. This configuration uses sqljs as the database
+A [VendureConfig](/reference/typescript-api/configuration/vendure-config#vendureconfig) object used for e2e tests. This configuration uses sqljs as the database
 and configures some special settings which are optimized for e2e tests:
 
 * `entityIdStrategy: new TestingEntityIdStrategy()` This ID strategy uses auto-increment IDs but encodes all IDs

package/docs/reference/typescript-api/testing/test-db-initializer.mdx

@@ -8,7 +8,7 @@ Defines how the e2e TestService sets up a particular DB to run a single test sui
 The `@vendure/testing` package ships with initializers for sql.js, MySQL & Postgres.
 
 Custom initializers can be created by implementing this interface and registering
-it with the <DocsLink href="/reference/typescript-api/testing/register-initializer#registerinitializer">registerInitializer</DocsLink> function:
+it with the [registerInitializer](/reference/typescript-api/testing/register-initializer#registerinitializer) function:
 
 *Example*
 

package/docs/reference/typescript-api/testing/test-environment.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/testing/src/create-test-environment.ts" sourceLine="13" packageName="@vendure/testing" />
 
-The return value of <DocsLink href="/reference/typescript-api/testing/create-test-environment#createtestenvironment">createTestEnvironment</DocsLink>, containing the test server
+The return value of [createTestEnvironment](/reference/typescript-api/testing/create-test-environment#createtestenvironment), containing the test server
 and clients for the Shop API and Admin API.
 
 ```ts title="Signature"

package/docs/reference/typescript-api/testing/test-server-options.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/testing/src/types.ts" sourceLine="14" packageName="@vendure/testing" />
 
-Configuration options used to initialize an instance of the <DocsLink href="/reference/typescript-api/testing/test-server#testserver">TestServer</DocsLink>.
+Configuration options used to initialize an instance of the [TestServer](/reference/typescript-api/testing/test-server#testserver).
 
 ```ts title="Signature"
 interface TestServerOptions {

package/docs/reference/typescript-api/testing/testing-logger.mdx

@@ -69,7 +69,7 @@ class TestingLogger<Spy extends (...args: any[]) => any> implements VendureLogge
     warn(message: string, context?: string) => void;
 }
 ```
-* Implements: <DocsLink href="/reference/typescript-api/logger/vendure-logger#vendurelogger">`VendureLogger`</DocsLink>
+* Implements: [`VendureLogger`](/reference/typescript-api/logger/vendure-logger#vendurelogger)
 
 
 

package/docs/reference/typescript-api/worker/bootstrap-worker.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/bootstrap.ts" sourceLine="225" packageName="@vendure/core" />
 
-Bootstraps a Vendure worker. Resolves to a <DocsLink href="/reference/typescript-api/worker/vendure-worker#vendureworker">VendureWorker</DocsLink> object containing a reference to the underlying
+Bootstraps a Vendure worker. Resolves to a [VendureWorker](/reference/typescript-api/worker/vendure-worker#vendureworker) object containing a reference to the underlying
 NestJs [standalone application](https://docs.nestjs.com/standalone-applications) as well as convenience
 methods for starting the job queue and health check server.
 
@@ -61,7 +61,7 @@ These options get passed directly to the `NestFactory.createApplicationContext`
 
 <MemberInfo kind="property" type={`Array<DynamicModule | Type<any>>`} default={`[]`}  since="3.1.0"  />
 
-See the `ignoreCompatibilityErrorsForPlugins` option in <DocsLink href="/reference/typescript-api/common/bootstrap#bootstrapoptions">BootstrapOptions</DocsLink>.
+See the `ignoreCompatibilityErrorsForPlugins` option in [BootstrapOptions](/reference/typescript-api/common/bootstrap#bootstrapoptions).
 
 
 </div>

package/docs/reference/typescript-api/worker/vendure-worker.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/worker/vendure-worker.ts" sourceLine="13" packageName="@vendure/core" />
 
-This object is created by calling the <DocsLink href="/reference/typescript-api/worker/bootstrap-worker#bootstrapworker">bootstrapWorker</DocsLink> function.
+This object is created by calling the [bootstrapWorker](/reference/typescript-api/worker/bootstrap-worker#bootstrapworker) function.
 
 ```ts title="Signature"
 class VendureWorker {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vendure/docs",
-    "version": "0.0.0-202601280949",
+    "version": "0.0.0-202601281114",
     "type": "module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",