@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx

@@ -2,10 +2,6 @@
 title: "ProductVariantPriceSelectionStrategy"
 generated: true
 ---
-
-
-## ProductVariantPriceSelectionStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/catalog/product-variant-price-selection-strategy.ts" sourceLine="21" packageName="@vendure/core" since="2.0.0" />
 
 The strategy for selecting the price for a ProductVariant in a given Channel.
@@ -33,16 +29,12 @@ interface ProductVariantPriceSelectionStrategy extends InjectableStrategy {
 
 ### selectPrice
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> | undefined | Promise&#60;<a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> | undefined | Promise<<a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> | undefined>`}   />
 
 
 
 
 </div>
-
-
-## DefaultProductVariantPriceSelectionStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/catalog/default-product-variant-price-selection-strategy.ts" sourceLine="17" packageName="@vendure/core" since="2.0.0" />
 
 The default strategy for selecting the price for a ProductVariant in a given Channel. It

package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx

@@ -2,10 +2,6 @@
 title: "ProductVariantPriceUpdateStrategy"
 generated: true
 ---
-
-
-## ProductVariantPriceUpdateStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/catalog/product-variant-price-update-strategy.ts" sourceLine="58" packageName="@vendure/core" since="2.2.0" />
 
 This strategy determines how updates to a ProductVariantPrice is handled in regard to
@@ -58,7 +54,7 @@ interface ProductVariantPriceUpdateStrategy extends InjectableStrategy {
 
 ### onPriceCreated
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createdPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise&#60;UpdatedProductVariantPrice[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createdPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>`}   />
 
 This method is called when a ProductVariantPrice is created. It receives the created
 ProductVariantPrice and the array of all prices associated with the ProductVariant.
@@ -67,7 +63,7 @@ It should return an array of UpdatedProductVariantPrice objects which will be us
 the prices of the specific ProductVariantPrices.
 ### onPriceUpdated
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, updatedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise&#60;UpdatedProductVariantPrice[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, updatedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>`}   />
 
 This method is called when a ProductVariantPrice is updated. It receives the updated
 ProductVariantPrice and the array of all prices associated with the ProductVariant.
@@ -76,7 +72,7 @@ It should return an array of UpdatedProductVariantPrice objects which will be us
 the prices of the specific ProductVariantPrices.
 ### onPriceDeleted
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, deletedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise&#60;UpdatedProductVariantPrice[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, deletedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>`}   />
 
 This method is called when a ProductVariantPrice is deleted. It receives the deleted
 ProductVariantPrice and the array of all prices associated with the ProductVariant.
@@ -86,13 +82,9 @@ the prices of the specific ProductVariantPrices.
 
 
 </div>
-
-
-## DefaultProductVariantPriceUpdateStrategyOptions
-
 <GenerationInfo sourceFile="packages/core/src/config/catalog/default-product-variant-price-update-strategy.ts" sourceLine="14" packageName="@vendure/core" since="2.2.0" />
 
-The options available to the <a href='/reference/typescript-api/configuration/product-variant-price-update-strategy#defaultproductvariantpriceupdatestrategy'>DefaultProductVariantPriceUpdateStrategy</a>.
+The options available to the <DocsLink href="/reference/typescript-api/configuration/product-variant-price-update-strategy#defaultproductvariantpriceupdatestrategy">DefaultProductVariantPriceUpdateStrategy</DocsLink>.
 
 ```ts title="Signature"
 interface DefaultProductVariantPriceUpdateStrategyOptions {
@@ -113,13 +105,9 @@ case, a custom strategy should be implemented.
 
 
 </div>
-
-
-## DefaultProductVariantPriceUpdateStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/catalog/default-product-variant-price-update-strategy.ts" sourceLine="56" packageName="@vendure/core" since="2.2.0" />
 
-The default <a href='/reference/typescript-api/configuration/product-variant-price-update-strategy#productvariantpriceupdatestrategy'>ProductVariantPriceUpdateStrategy</a> which by default will not update any other
+The default <DocsLink href="/reference/typescript-api/configuration/product-variant-price-update-strategy#productvariantpriceupdatestrategy">ProductVariantPriceUpdateStrategy</DocsLink> which by default will not update any other
 prices when a price is created, updated or deleted.
 
 If the `syncPricesAcrossChannels` option is set to `true`, then when a price is updated in one Channel,

package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx

@@ -2,14 +2,10 @@
 title: "RuntimeVendureConfig"
 generated: true
 ---
-
-
-## RuntimeVendureConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="1319" packageName="@vendure/core" />
 
 This interface represents the VendureConfig object available at run-time, i.e. the user-supplied
-config values have been merged with the <a href='/reference/typescript-api/configuration/default-config#defaultconfig'>defaultConfig</a> values.
+config values have been merged with the <DocsLink href="/reference/typescript-api/configuration/default-config#defaultconfig">defaultConfig</DocsLink> values.
 
 ```ts title="Signature"
 interface RuntimeVendureConfig extends Required<VendureConfig> {
@@ -29,7 +25,7 @@ interface RuntimeVendureConfig extends Required<VendureConfig> {
     systemOptions: Required<SystemOptions>;
 }
 ```
-* Extends: <code>Required&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;</code>
+* Extends: <code>Required<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>></code>
 
 
 
@@ -37,72 +33,72 @@ interface RuntimeVendureConfig extends Required<VendureConfig> {
 
 ### apiOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/configuration/api-options#apioptions'>ApiOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/configuration/api-options#apioptions'>ApiOptions</a>>`}   />
 
 
 ### assetOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/assets/asset-options#assetoptions'>AssetOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/assets/asset-options#assetoptions'>AssetOptions</a>>`}   />
 
 
 ### authOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/auth/auth-options#authoptions'>AuthOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/auth/auth-options#authoptions'>AuthOptions</a>>`}   />
 
 
 ### catalogOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/products-stock/catalog-options#catalogoptions'>CatalogOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/products-stock/catalog-options#catalogoptions'>CatalogOptions</a>>`}   />
 
 
 ### customFields
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>>`}   />
 
 
 ### entityOptions
 
-<MemberInfo kind="property" type={`Required&#60;Omit&#60;<a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>, 'entityIdStrategy'&#62;&#62; &#38; <a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>`}   />
+<MemberInfo kind="property" type={`Required<Omit<<a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>, 'entityIdStrategy'>> &#38; <a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>`}   />
 
 
 ### importExportOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/import-export/import-export-options#importexportoptions'>ImportExportOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/import-export/import-export-options#importexportoptions'>ImportExportOptions</a>>`}   />
 
 
 ### jobQueueOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/job-queue/job-queue-options#jobqueueoptions'>JobQueueOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/job-queue/job-queue-options#jobqueueoptions'>JobQueueOptions</a>>`}   />
 
 
 ### schedulerOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/scheduled-tasks/scheduler-options#scheduleroptions'>SchedulerOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/scheduled-tasks/scheduler-options#scheduleroptions'>SchedulerOptions</a>>`}   />
 
 
 ### orderOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a>>`}   />
 
 
 ### promotionOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/promotions/promotion-options#promotionoptions'>PromotionOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/promotions/promotion-options#promotionoptions'>PromotionOptions</a>>`}   />
 
 
 ### shippingOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/shipping/shipping-options#shippingoptions'>ShippingOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/shipping/shipping-options#shippingoptions'>ShippingOptions</a>>`}   />
 
 
 ### taxOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/tax/tax-options#taxoptions'>TaxOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/tax/tax-options#taxoptions'>TaxOptions</a>>`}   />
 
 
 ### systemOptions
 
-<MemberInfo kind="property" type={`Required&#60;<a href='/reference/typescript-api/configuration/system-options#systemoptions'>SystemOptions</a>&#62;`}   />
+<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/configuration/system-options#systemoptions'>SystemOptions</a>>`}   />
 
 
 

package/docs/reference/typescript-api/configuration/settings-store-fields.mdx

@@ -2,13 +2,9 @@
 title: "SettingsStoreFields"
 generated: true
 ---
-
-
-## SettingsStoreFields
-
 <GenerationInfo sourceFile="packages/core/src/config/settings-store/settings-store-types.ts" sourceLine="141" packageName="@vendure/core" since="3.4.0" />
 
-This is how SettingsStoreFields are defined in the <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a> object.
+This is how SettingsStoreFields are defined in the <DocsLink href="/reference/typescript-api/configuration/vendure-config#vendureconfig">VendureConfig</DocsLink> object.
 
 ```ts title="Signature"
 type SettingsStoreFields = {

package/docs/reference/typescript-api/configuration/slug-strategy.mdx

@@ -2,10 +2,6 @@
 title: "SlugStrategy"
 generated: true
 ---
-
-
-## SlugStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/entity/slug-strategy.ts" sourceLine="44" packageName="@vendure/core" since="3.5.0" />
 
 Defines the strategy for generating slugs from input strings.
@@ -38,7 +34,7 @@ interface SlugStrategy extends InjectableStrategy {
 
 ### generate
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => string | Promise&#60;string&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => string | Promise<string>`}   />
 
 Generates a slug from the input string.
 

package/docs/reference/typescript-api/configuration/system-options.mdx

@@ -2,10 +2,6 @@
 title: "SystemOptions"
 generated: true
 ---
-
-
-## SystemOptions
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="1134" packageName="@vendure/core" since="1.6.0" />
 
 Options relating to system functions.
@@ -25,20 +21,20 @@ interface SystemOptions {
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a>[]`} default={`[<a href='/reference/typescript-api/health-check/type-ormhealth-check-strategy#typeormhealthcheckstrategy'>TypeORMHealthCheckStrategy</a>]`}  since="1.6.0"  />
 
-Defines an array of <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> instances which are used by the `/health` endpoint to verify
+Defines an array of <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> instances which are used by the `/health` endpoint to verify
 that any critical systems which the Vendure server depends on are also healthy.
 ### errorHandlers
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/errors/error-handler-strategy#errorhandlerstrategy'>ErrorHandlerStrategy</a>[]`} default={`[]`}  since="2.2.0"  />
 
-Defines an array of <a href='/reference/typescript-api/errors/error-handler-strategy#errorhandlerstrategy'>ErrorHandlerStrategy</a> instances which are used to define logic to be executed
+Defines an array of <DocsLink href="/reference/typescript-api/errors/error-handler-strategy#errorhandlerstrategy">ErrorHandlerStrategy</DocsLink> instances which are used to define logic to be executed
 when an error occurs, either on the server or the worker.
 ### cacheStrategy
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/cache/cache-strategy#cachestrategy'>CacheStrategy</a>`} default={`InMemoryCacheStrategy`}  since="3.1.0"  />
 
 Defines the underlying method used to store cache key-value pairs which powers the
-<a href='/reference/typescript-api/cache/cache-service#cacheservice'>CacheService</a>.
+<DocsLink href="/reference/typescript-api/cache/cache-service#cacheservice">CacheService</DocsLink>.
 ### instrumentationStrategy
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy'>InstrumentationStrategy</a>`}   />

package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx

@@ -2,10 +2,6 @@
 title: "TrustProxyOptions"
 generated: true
 ---
-
-
-## TrustProxyOptions
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="245" packageName="@vendure/core" since="3.4.0" />
 
 Configures Express trust proxy settings when running behind a reverse proxy (usually the case with most hosting services).

package/docs/reference/typescript-api/configuration/vendure-config.mdx

@@ -2,10 +2,6 @@
 title: "VendureConfig"
 generated: true
 ---
-
-
-## VendureConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="1172" packageName="@vendure/core" />
 
 All possible configuration options are defined by the
@@ -71,7 +67,7 @@ Defines custom fields which can be used to extend the built-in entities.
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/settings-store-fields#settingsstorefields'>SettingsStoreFields</a>`}  since="3.4.0"  />
 
 Defines key-value fields that can be set and read via the `getKeyValue`/`setKeyValue` GraphQL APIs
-and via the <a href='/reference/typescript-api/services/settings-store-service#settingsstoreservice'>SettingsStoreService</a>. These differ from custom fields in that they are not associated
+and via the <DocsLink href="/reference/typescript-api/services/settings-store-service#settingsstoreservice">SettingsStoreService</DocsLink>. These differ from custom fields in that they are not associated
 with a specific entity, but can be scoped globally or to a specific user etc, and defining them does not
 require any changes to the database schema.
 ### dbConnectionOptions
@@ -94,7 +90,7 @@ will be randomly generated.
 The default languageCode of the app.
 ### entityIdStrategy
 
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a>&#60;any&#62;`} default={`<a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a><any>`} default={`<a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>`}   />
 
 Defines the strategy used for both storing the primary keys of entities
 in the database, and the encoding & decoding of those ids when exposing
@@ -122,7 +118,7 @@ Configuration settings governing how orders are handled.
 Configures available payment processing methods.
 ### plugins
 
-<MemberInfo kind="property" type={`Array&#60;DynamicModule | Type&#60;any&#62;&#62;`} default={`[]`}   />
+<MemberInfo kind="property" type={`Array<DynamicModule | Type<any>>`} default={`[]`}   />
 
 An array of plugins.
 ### promotionOptions
@@ -139,7 +135,7 @@ Configures the available checkers and calculators for ShippingMethods.
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a>`} default={`<a href='/reference/typescript-api/logger/default-logger#defaultlogger'>DefaultLogger</a>`}   />
 
-Provide a logging service which implements the <a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a> interface.
+Provide a logging service which implements the <DocsLink href="/reference/typescript-api/logger/vendure-logger#vendurelogger">VendureLogger</DocsLink> interface.
 Note that the logging of SQL queries is controlled separately by the
 `dbConnectionOptions.logging` property.
 ### taxOptions

package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx

@@ -2,10 +2,6 @@
 title: "CustomFieldConfig"
 generated: true
 ---
-
-
-## CustomFieldConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="237" packageName="@vendure/core" />
 
 An object used to configure a custom field.

package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx

@@ -2,10 +2,6 @@
 title: "CustomFieldType"
 generated: true
 ---
-
-
-## CustomFieldType
-
 <GenerationInfo sourceFile="packages/common/src/shared-types.ts" sourceLine="104" packageName="@vendure/common" />
 
 A data type for a custom field. The CustomFieldType determines the data types used in the generated

package/docs/reference/typescript-api/custom-fields/index.mdx

@@ -2,13 +2,9 @@
 title: "CustomFields"
 generated: true
 ---
-
-
-## CustomFields
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="273" packageName="@vendure/core" />
 
-Most entities can have additional fields added to them by defining an array of <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>objects on against the corresponding key.
+Most entities can have additional fields added to them by defining an array of <DocsLink href="/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig">CustomFieldConfig</DocsLink>objects on against the corresponding key.
 
 *Example*
 

package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx

@@ -2,10 +2,6 @@
 title: "StructCustomFieldConfig"
 generated: true
 ---
-
-
-## StructCustomFieldConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="224" packageName="@vendure/core" since="3.1.0" />
 
 Configures a "struct" custom field.

package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx

@@ -2,10 +2,6 @@
 title: "StructFieldConfig"
 generated: true
 ---
-
-
-## StructFieldConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="209" packageName="@vendure/core" since="3.1.0" />
 
 Configures an individual field of a "struct" custom field. The individual fields share

package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx

@@ -2,13 +2,9 @@
 title: "TypedCustomSingleFieldConfig"
 generated: true
 ---
-
-
-## TypedCustomSingleFieldConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="84" packageName="@vendure/core" />
 
-Configures a custom field on an entity in the <a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a> config object.
+Configures a custom field on an entity in the <DocsLink href="/reference/typescript-api/custom-fields/#customfields">CustomFields</DocsLink> config object.
 
 ```ts title="Signature"
 type TypedCustomSingleFieldConfig<T extends CustomFieldType, C extends CustomField> = BaseTypedCustomFieldConfig<T, C> & {

package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx

@@ -2,10 +2,6 @@
 title: "CalculatedPropertySubscriber"
 generated: true
 ---
-
-
-## CalculatedPropertySubscriber
-
 <GenerationInfo sourceFile="packages/core/src/entity/subscribers.ts" sourceLine="14" packageName="@vendure/core" />
 
 
@@ -29,7 +25,7 @@ class CalculatedPropertySubscriber implements EntitySubscriberInterface {
 
 ### afterInsert
 
-<MemberInfo kind="method" type={`(event: InsertEvent&#60;any&#62;) => Promise&#60;any&#62; | void`}   />
+<MemberInfo kind="method" type={`(event: InsertEvent<any>) => Promise<any> | void`}   />
 
 
 

package/docs/reference/typescript-api/data-access/calculated.mdx

@@ -2,14 +2,10 @@
 title: "Calculated"
 generated: true
 ---
-
-
-## Calculated
-
 <GenerationInfo sourceFile="packages/core/src/common/calculated-decorator.ts" sourceLine="43" packageName="@vendure/core" />
 
 Used to define calculated entity getters. The decorator simply attaches an array of "calculated"
-property names to the entity's prototype. This array is then used by the <a href='/reference/typescript-api/data-access/calculated-property-subscriber#calculatedpropertysubscriber'>CalculatedPropertySubscriber</a>to transfer the getter function from the prototype to the entity instance.
+property names to the entity's prototype. This array is then used by the <DocsLink href="/reference/typescript-api/data-access/calculated-property-subscriber#calculatedpropertysubscriber">CalculatedPropertySubscriber</DocsLink>to transfer the getter function from the prototype to the entity instance.
 
 ```ts title="Signature"
 function Calculated(queryInstruction?: CalculatedColumnQueryInstruction): MethodDecorator
@@ -20,13 +16,9 @@ Parameters
 
 <MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/data-access/calculated#calculatedcolumnqueryinstruction'>CalculatedColumnQueryInstruction</a>`} />
 
-
-
-## CalculatedColumnQueryInstruction
-
 <GenerationInfo sourceFile="packages/core/src/common/calculated-decorator.ts" sourceLine="17" packageName="@vendure/core" />
 
-Optional metadata used to tell the <a href='/reference/typescript-api/data-access/list-query-builder#listquerybuilder'>ListQueryBuilder</a> & <a href='/reference/typescript-api/request/relations-decorator#relations'>Relations</a> decorator how to deal with
+Optional metadata used to tell the <DocsLink href="/reference/typescript-api/data-access/list-query-builder#listquerybuilder">ListQueryBuilder</DocsLink> & <DocsLink href="/reference/typescript-api/request/relations-decorator#relations">Relations</DocsLink> decorator how to deal with
 calculated columns when sorting, filtering and deriving required relations from GraphQL operations.
 
 ```ts title="Signature"
@@ -48,7 +40,7 @@ on the entity (e.g. an `Order` entity calculating the `totalQuantity` by adding
 up the quantities of each `OrderLine`), then those relations should be defined here.
 ### query
 
-<MemberInfo kind="property" type={`(qb: SelectQueryBuilder&#60;any&#62;) =&#62; void`}   />
+<MemberInfo kind="property" type={`(qb: SelectQueryBuilder<any>) => void`}   />
 
 
 ### expression

package/docs/reference/typescript-api/data-access/entity-hydrator.mdx

@@ -2,10 +2,6 @@
 title: "EntityHydrator"
 generated: true
 ---
-
-
-## EntityHydrator
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/entity-hydrator/entity-hydrator.service.ts" sourceLine="77" packageName="@vendure/core" since="1.3.0" />
 
 This is a helper class which is used to "hydrate" entity instances, which means to populate them
@@ -49,7 +45,7 @@ available, and those FacetValues will have their `facet` relations joined too.
 
 This `hydrate` method will _also_ automatically take care or translating any
 translatable entities (e.g. Product, Collection, Facet), and if the `applyProductVariantPrices`
-options is used (see <a href='/reference/typescript-api/data-access/hydrate-options#hydrateoptions'>HydrateOptions</a>), any related ProductVariant will have the correct
+options is used (see <DocsLink href="/reference/typescript-api/data-access/hydrate-options#hydrateoptions">HydrateOptions</DocsLink>), any related ProductVariant will have the correct
 Channel-specific prices applied to them.
 
 Custom field relations may also be hydrated:
@@ -80,7 +76,7 @@ class EntityHydrator {
 
 ### hydrate
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, target: Entity, options: <a href='/reference/typescript-api/data-access/hydrate-options#hydrateoptions'>HydrateOptions</a>&#60;Entity&#62;) => Promise&#60;Entity&#62;`}  since="1.3.0"  />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, target: Entity, options: <a href='/reference/typescript-api/data-access/hydrate-options#hydrateoptions'>HydrateOptions</a><Entity>) => Promise<Entity>`}  since="1.3.0"  />
 
 Hydrates (joins) the specified relations to the target entity instance. This method
 mutates the `target` entity.

package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx

@@ -2,13 +2,9 @@
 title: "GetEntityOrThrowOptions"
 generated: true
 ---
-
-
-## GetEntityOrThrowOptions
-
 <GenerationInfo sourceFile="packages/core/src/connection/types.ts" sourceLine="10" packageName="@vendure/core" />
 
-Options used by the <a href='/reference/typescript-api/data-access/transactional-connection#transactionalconnection'>TransactionalConnection</a> `getEntityOrThrow` method.
+Options used by the <DocsLink href="/reference/typescript-api/data-access/transactional-connection#transactionalconnection">TransactionalConnection</DocsLink> `getEntityOrThrow` method.
 
 ```ts title="Signature"
 interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {
@@ -18,7 +14,7 @@ interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {
     includeSoftDeleted?: boolean;
 }
 ```
-* Extends: <code>FindOneOptions&#60;T&#62;</code>
+* Extends: <code>FindOneOptions<T></code>
 
 
 
@@ -29,7 +25,7 @@ interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
 
 An optional channelId to limit results to entities assigned to the given Channel. Should
-only be used when getting entities that implement the <a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a> interface.
+only be used when getting entities that implement the <DocsLink href="/reference/typescript-api/entities/interfaces#channelaware">ChannelAware</DocsLink> interface.
 ### retries
 
 <MemberInfo kind="property" type={`number`} default={`0`}  since="1.1.0"  />

package/docs/reference/typescript-api/data-access/hydrate-options.mdx

@@ -2,14 +2,10 @@
 title: "HydrateOptions"
 generated: true
 ---
-
-
-## HydrateOptions
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/entity-hydrator/entity-hydrator-types.ts" sourceLine="12" packageName="@vendure/core" since="1.3.0" />
 
 Options used to control which relations of the entity get hydrated
-when using the <a href='/reference/typescript-api/data-access/entity-hydrator#entityhydrator'>EntityHydrator</a> helper.
+when using the <DocsLink href="/reference/typescript-api/data-access/entity-hydrator#entityhydrator">EntityHydrator</DocsLink> helper.
 
 ```ts title="Signature"
 interface HydrateOptions<Entity extends VendureEntity> {
@@ -22,7 +18,7 @@ interface HydrateOptions<Entity extends VendureEntity> {
 
 ### relations
 
-<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>&#60;Entity&#62;&#62;`}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><Entity>>`}   />
 
 Defines the relations to hydrate, using strings with dot notation to indicate
 nested joins. If the entity already has a particular relation available, that relation