@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211028

package/docs/reference/typescript-api/request/transaction-decorator.mdx

@@ -2,15 +2,11 @@
 title: "Transaction Decorator"
 generated: true
 ---
-
-
-## Transaction
-
 <GenerationInfo sourceFile="packages/core/src/api/decorators/transaction.decorator.ts" sourceLine="81" packageName="@vendure/core" />
 
 Runs the decorated method in a TypeORM transaction. It works by creating a transactional
 QueryRunner which gets attached to the RequestContext object. When the RequestContext
-is the passed to the <a href='/reference/typescript-api/data-access/transactional-connection#transactionalconnection'>TransactionalConnection</a> `getRepository()` method, this
+is the passed to the <DocsLink href="/reference/typescript-api/data-access/transactional-connection#transactionalconnection">TransactionalConnection</DocsLink> `getRepository()` method, this
 QueryRunner is used to execute the queries within this transaction.
 
 Essentially, the entire resolver function is wrapped in a try-catch block which commits the
@@ -33,14 +29,10 @@ async myMutation(@Ctx() ctx: RequestContext) {
 }
 ```
 
-
-
-## TransactionMode
-
 <GenerationInfo sourceFile="packages/core/src/api/decorators/transaction.decorator.ts" sourceLine="32" packageName="@vendure/core" />
 
 The Transaction decorator can handle transactions automatically (which is the default) or be set to
-"manual" mode, where the <a href='/reference/typescript-api/data-access/transactional-connection#transactionalconnection'>TransactionalConnection</a> `.startTransaction()` and `.commitOpenTransaction()`
+"manual" mode, where the <DocsLink href="/reference/typescript-api/data-access/transactional-connection#transactionalconnection">TransactionalConnection</DocsLink> `.startTransaction()` and `.commitOpenTransaction()`
 methods must them be used.
 
 *Example*
@@ -63,10 +55,6 @@ the case that an uncaught error is thrown within the resolver.
 ```ts title="Signature"
 type TransactionMode = 'auto' | 'manual'
 ```
-
-
-## TransactionIsolationLevel
-
 <GenerationInfo sourceFile="packages/core/src/api/decorators/transaction.decorator.ts" sourceLine="45" packageName="@vendure/core" />
 
 Transactions can be run at different isolation levels. The default is undefined, which

package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx

@@ -2,13 +2,9 @@
 title: "CleanSessionsTask"
 generated: true
 ---
-
-
-## cleanSessionsTask
-
 <GenerationInfo sourceFile="packages/core/src/scheduler/tasks/clean-sessions-task.ts" sourceLine="37" packageName="@vendure/core" since="3.3.0" />
 
-A <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a> that cleans expired & inactive sessions from the database.
+A <DocsLink href="/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask">ScheduledTask</DocsLink> that cleans expired & inactive sessions from the database.
 
 *Example*
 

package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx

@@ -2,10 +2,6 @@
 title: "DefaultSchedulerPlugin"
 generated: true
 ---
-
-
-## DefaultSchedulerPlugin
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-scheduler-plugin/default-scheduler.plugin.ts" sourceLine="40" packageName="@vendure/core" since="3.3.0" />
 
 This plugin configures a default scheduling strategy that executes scheduled
@@ -53,13 +49,9 @@ class DefaultSchedulerPlugin {
 
 
 </div>
-
-
-## DefaultSchedulerPluginOptions
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-scheduler-plugin/types.ts" sourceLine="9" packageName="@vendure/core" since="3.3.0" />
 
-The options for the <a href='/reference/typescript-api/scheduled-tasks/default-scheduler-plugin#defaultschedulerplugin'>DefaultSchedulerPlugin</a>.
+The options for the <DocsLink href="/reference/typescript-api/scheduled-tasks/default-scheduler-plugin#defaultschedulerplugin">DefaultSchedulerPlugin</DocsLink>.
 
 ```ts title="Signature"
 interface DefaultSchedulerPluginOptions {

package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx

@@ -2,15 +2,11 @@
 title: "DefaultSchedulerStrategy"
 generated: true
 ---
-
-
-## DefaultSchedulerStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-scheduler-plugin/default-scheduler-strategy.ts" sourceLine="28" packageName="@vendure/core" since="3.3.0" />
 
-The default <a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#schedulerstrategy'>SchedulerStrategy</a> implementation that uses the database to
+The default <DocsLink href="/reference/typescript-api/scheduled-tasks/scheduler-strategy#schedulerstrategy">SchedulerStrategy</DocsLink> implementation that uses the database to
 execute scheduled tasks. This strategy is configured when you use the
-<a href='/reference/typescript-api/scheduled-tasks/default-scheduler-plugin#defaultschedulerplugin'>DefaultSchedulerPlugin</a>.
+<DocsLink href="/reference/typescript-api/scheduled-tasks/default-scheduler-plugin#defaultschedulerplugin">DefaultSchedulerPlugin</DocsLink>.
 
 ```ts title="Signature"
 class DefaultSchedulerStrategy implements SchedulerStrategy {

package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx

@@ -2,10 +2,6 @@
 title: "ScheduledTask"
 generated: true
 ---
-
-
-## ScheduledTask
-
 <GenerationInfo sourceFile="packages/core/src/scheduler/scheduled-task.ts" sourceLine="120" packageName="@vendure/core" since="3.3.0" />
 
 Use this class to define a scheduled task that will be executed at a given cron schedule.
@@ -82,10 +78,6 @@ task.configure({ schedule: cron => cron.every(5).minutes() });
 
 
 </div>
-
-
-## ScheduledTaskExecutionArgs
-
 <GenerationInfo sourceFile="packages/core/src/scheduler/scheduled-task.ts" sourceLine="16" packageName="@vendure/core" since="3.3.0" />
 
 The arguments passed to the execute method of a scheduled task.
@@ -118,10 +110,6 @@ The parameters for the scheduled task.
 
 
 </div>
-
-
-## ScheduledTaskConfig
-
 <GenerationInfo sourceFile="packages/core/src/scheduler/scheduled-task.ts" sourceLine="42" packageName="@vendure/core" since="3.3.0" />
 
 The configuration for a scheduled task.

package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx

@@ -2,10 +2,6 @@
 title: "SchedulerOptions"
 generated: true
 ---
-
-
-## SchedulerOptions
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="999" packageName="@vendure/core" since="3.3.0" />
 
 Options related to scheduled tasks..
@@ -25,8 +21,8 @@ interface SchedulerOptions {
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#schedulerstrategy'>SchedulerStrategy</a>`}   />
 
 The strategy used to execute scheduled tasks. If you are using the
-<a href='/reference/typescript-api/scheduled-tasks/default-scheduler-plugin#defaultschedulerplugin'>DefaultSchedulerPlugin</a> (which is recommended) then this will be set to the
-<a href='/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy'>DefaultSchedulerStrategy</a>.
+<DocsLink href="/reference/typescript-api/scheduled-tasks/default-scheduler-plugin#defaultschedulerplugin">DefaultSchedulerPlugin</DocsLink> (which is recommended) then this will be set to the
+<DocsLink href="/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy">DefaultSchedulerStrategy</DocsLink>.
 ### tasks
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>[]`}   />

package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx

@@ -2,10 +2,6 @@
 title: "SchedulerService"
 generated: true
 ---
-
-
-## SchedulerService
-
 <GenerationInfo sourceFile="packages/core/src/scheduler/scheduler.service.ts" sourceLine="34" packageName="@vendure/core" since="3.3.0" />
 
 The service that is responsible for setting up and querying the scheduled tasks.

package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx

@@ -2,10 +2,6 @@
 title: "SchedulerStrategy"
 generated: true
 ---
-
-
-## SchedulerStrategy
-
 <GenerationInfo sourceFile="packages/core/src/scheduler/scheduler-strategy.ts" sourceLine="42" packageName="@vendure/core" since="3.3.0" />
 
 This strategy is used to define the mechanism by which scheduled tasks are executed
@@ -16,7 +12,7 @@ are multiple instances of the worker running.
 To do this, the strategy must use some form of shared storage and a method of
 locking so that only a single worker is allowed to execute the task.
 
-By default, the <a href='/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy'>DefaultSchedulerStrategy</a> will use the database to enable
+By default, the <DocsLink href="/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy">DefaultSchedulerStrategy</DocsLink> will use the database to enable
 this functionality.
 
 ```ts title="Signature"
@@ -50,7 +46,7 @@ Execute a scheduled task. This method must also take care of
 ensuring that the task is executed exactly once at the scheduled time,
 even if there are multiple instances of the worker running.
 
-For instance, in the <a href='/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy'>DefaultSchedulerStrategy</a> we make use of a
+For instance, in the <DocsLink href="/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy">DefaultSchedulerStrategy</DocsLink> we make use of a
 dedicated database table and a locking mechansim. If you implement a custom
 SchedulerStrategy, you must use some other form of shared locking mechanism
 that could make use of something like Redis etc. to ensure that the task
@@ -79,7 +75,7 @@ instance which we typically do not want. Instead, it should be used
 to signal to the strategy that this specific task needs to be invoked
 at the soonest opportunity.
 
-For instance, in the <a href='/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy'>DefaultSchedulerStrategy</a> this is done by setting
+For instance, in the <DocsLink href="/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy">DefaultSchedulerStrategy</DocsLink> this is done by setting
 a flag in the database table which is checked periodically and causes those tasks
 to get immediately invoked.
 ### updateTask
@@ -90,10 +86,6 @@ Update a scheduled task.
 
 
 </div>
-
-
-## TaskReport
-
 <GenerationInfo sourceFile="packages/core/src/scheduler/scheduler-strategy.ts" sourceLine="16" packageName="@vendure/core" since="3.3.0" />
 
 A report on the status of a scheduled task.

package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx

@@ -2,14 +2,10 @@
 title: "EntityDuplicatorService"
 generated: true
 ---
-
-
-## EntityDuplicatorService
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/entity-duplicator/entity-duplicator.service.ts" sourceLine="23" packageName="@vendure/core" since="2.2.0" />
 
 This service is used to duplicate entities using one of the configured
-<a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicator'>EntityDuplicator</a> functions.
+<DocsLink href="/reference/typescript-api/configuration/entity-duplicator#entityduplicator">EntityDuplicator</DocsLink> functions.
 
 ```ts title="Signature"
 class EntityDuplicatorService {
@@ -30,12 +26,12 @@ class EntityDuplicatorService {
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => EntityDuplicatorDefinition[]`}   />
 
-Returns all configured <a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicator'>EntityDuplicator</a> definitions.
+Returns all configured <DocsLink href="/reference/typescript-api/configuration/entity-duplicator#entityduplicator">EntityDuplicator</DocsLink> definitions.
 ### duplicateEntity
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: DuplicateEntityInput) => Promise<DuplicateEntityResult>`}   />
 
-Duplicates an entity using the specified <a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicator'>EntityDuplicator</a>. The duplication is performed
+Duplicates an entity using the specified <DocsLink href="/reference/typescript-api/configuration/entity-duplicator#entityduplicator">EntityDuplicator</DocsLink>. The duplication is performed
 within a transaction, so if an error occurs, the transaction will be rolled back.
 
 

package/docs/reference/typescript-api/service-helpers/order-calculator.mdx

@@ -2,10 +2,6 @@
 title: "OrderCalculator"
 generated: true
 ---
-
-
-## OrderCalculator
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/order-calculator/order-calculator.ts" sourceLine="35" packageName="@vendure/core" />
 
 This helper is used when making changes to an Order, to apply all applicable price adjustments to that Order,

package/docs/reference/typescript-api/service-helpers/order-modifier.mdx

@@ -2,10 +2,6 @@
 title: "OrderModifier"
 generated: true
 ---
-
-
-## OrderModifier
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/order-modifier/order-modifier.ts" sourceLine="84" packageName="@vendure/core" />
 
 This helper is responsible for modifying the contents of an Order.
@@ -61,7 +57,7 @@ matches, or `undefined` if no match is found.
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, customFields?: { [key: string]: any }) => `}   />
 
-Returns the OrderLine containing the given <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, taking into account any custom field values. If no existing
+Returns the OrderLine containing the given <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>, taking into account any custom field values. If no existing
 OrderLine is found, a new OrderLine will be created.
 ### updateOrderLineQuantity
 

package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx

@@ -2,14 +2,10 @@
 title: "ProductPriceApplicator"
 generated: true
 ---
-
-
-## ProductPriceApplicator
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/product-price-applicator/product-price-applicator.ts" sourceLine="41" packageName="@vendure/core" />
 
 This helper is used to apply the correct price to a ProductVariant based on the current context
-including active Channel, any current Order, etc. If you use the <a href='/reference/typescript-api/data-access/transactional-connection#transactionalconnection'>TransactionalConnection</a> to
+including active Channel, any current Order, etc. If you use the <DocsLink href="/reference/typescript-api/data-access/transactional-connection#transactionalconnection">TransactionalConnection</DocsLink> to
 directly query ProductVariants, you will find that the `price` and `priceWithTax` properties will
 always be `0` until you use the `applyChannelPriceAndTax()` method:
 

package/docs/reference/typescript-api/service-helpers/slug-validator.mdx

@@ -2,14 +2,10 @@
 title: "SlugValidator"
 generated: true
 ---
-
-
-## SlugValidator
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/slug-validator/slug-validator.ts" sourceLine="44" packageName="@vendure/core" />
 
 Used to validate slugs to ensure they are URL-safe and unique. Designed to be used with translatable
-entities such as <a href='/reference/typescript-api/entities/product#product'>Product</a> and <a href='/reference/typescript-api/entities/collection#collection'>Collection</a>.
+entities such as <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> and <DocsLink href="/reference/typescript-api/entities/collection#collection">Collection</DocsLink>.
 
 ```ts title="Signature"
 class SlugValidator {
@@ -33,10 +29,6 @@ class SlugValidator {
 
 
 </div>
-
-
-## InputWithSlug
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/slug-validator/slug-validator.ts" sourceLine="16" packageName="@vendure/core" />
 
 
@@ -67,10 +59,6 @@ type InputWithSlug = {
 
 
 </div>
-
-
-## TranslationEntity
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/slug-validator/slug-validator.ts" sourceLine="29" packageName="@vendure/core" />
 
 

package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx

@@ -2,13 +2,9 @@
 title: "TranslatableSaver"
 generated: true
 ---
-
-
-## TranslatableSaver
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/translatable-saver/translatable-saver.ts" sourceLine="55" packageName="@vendure/core" />
 
-A helper which contains methods for creating and updating entities which implement the <a href='/reference/typescript-api/entities/interfaces#translatable'>Translatable</a> interface.
+A helper which contains methods for creating and updating entities which implement the <DocsLink href="/reference/typescript-api/entities/interfaces#translatable">Translatable</DocsLink> interface.
 
 *Example*
 

package/docs/reference/typescript-api/service-helpers/translator-service.mdx

@@ -2,10 +2,6 @@
 title: "TranslatorService"
 generated: true
 ---
-
-
-## TranslatorService
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/translator/translator.service.ts" sourceLine="42" packageName="@vendure/core" />
 
 The TranslatorService is used to translate entities into the current language.

package/docs/reference/typescript-api/services/administrator-service.mdx

@@ -2,13 +2,9 @@
 title: "AdministratorService"
 generated: true
 ---
-
-
-## AdministratorService
-
 <GenerationInfo sourceFile="packages/core/src/service/services/administrator.service.ts" sourceLine="41" packageName="@vendure/core" />
 
-Contains methods relating to <a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a> entities.
+Contains methods relating to <DocsLink href="/reference/typescript-api/entities/administrator#administrator">Administrator</DocsLink> entities.
 
 ```ts title="Signature"
 class AdministratorService {

package/docs/reference/typescript-api/services/asset-service.mdx

@@ -2,13 +2,9 @@
 title: "AssetService"
 generated: true
 ---
-
-
-## AssetService
-
 <GenerationInfo sourceFile="packages/core/src/service/services/asset.service.ts" sourceLine="91" packageName="@vendure/core" />
 
-Contains methods relating to <a href='/reference/typescript-api/entities/asset#asset'>Asset</a> entities.
+Contains methods relating to <DocsLink href="/reference/typescript-api/entities/asset#asset">Asset</DocsLink> entities.
 
 ```ts title="Signature"
 class AssetService {
@@ -110,10 +106,6 @@ Create an Asset from a file stream, for example to create an Asset during data i
 
 
 </div>
-
-
-## EntityWithAssets
-
 <GenerationInfo sourceFile="packages/core/src/service/services/asset.service.ts" sourceLine="67" packageName="@vendure/core" />
 
 Certain entities (Product, ProductVariant, Collection) use this interface
@@ -144,13 +136,9 @@ interface EntityWithAssets extends VendureEntity {
 
 
 </div>
-
-
-## EntityAssetInput
-
 <GenerationInfo sourceFile="packages/core/src/service/services/asset.service.ts" sourceLine="79" packageName="@vendure/core" />
 
-Used when updating entities which implement <a href='/reference/typescript-api/services/asset-service#entitywithassets'>EntityWithAssets</a>.
+Used when updating entities which implement <DocsLink href="/reference/typescript-api/services/asset-service#entitywithassets">EntityWithAssets</DocsLink>.
 
 ```ts title="Signature"
 interface EntityAssetInput {

package/docs/reference/typescript-api/services/auth-service.mdx

@@ -2,13 +2,9 @@
 title: "AuthService"
 generated: true
 ---
-
-
-## AuthService
-
 <GenerationInfo sourceFile="packages/core/src/service/services/auth.service.ts" sourceLine="37" packageName="@vendure/core" />
 
-Contains methods relating to <a href='/reference/typescript-api/entities/session#session'>Session</a>, <a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a> & <a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a> entities.
+Contains methods relating to <DocsLink href="/reference/typescript-api/entities/session#session">Session</DocsLink>, <DocsLink href="/reference/typescript-api/entities/authenticated-session#authenticatedsession">AuthenticatedSession</DocsLink> & <DocsLink href="/reference/typescript-api/entities/anonymous-session#anonymoussession">AnonymousSession</DocsLink> entities.
 
 ```ts title="Signature"
 class AuthService {
@@ -31,7 +27,7 @@ class AuthService {
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, apiType: <a href='/reference/typescript-api/request/api-type#apitype'>ApiType</a>, authenticationMethod: string, authenticationData: any) => Promise<<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a> | InvalidCredentialsError | NotVerifiedError>`}   />
 
-Authenticates a user's credentials and if okay, creates a new <a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>.
+Authenticates a user's credentials and if okay, creates a new <DocsLink href="/reference/typescript-api/entities/authenticated-session#authenticatedsession">AuthenticatedSession</DocsLink>.
 ### createAuthenticatedSessionForUser
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>, authenticationStrategyName: string) => Promise<<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a> | NotVerifiedError>`}   />
@@ -42,7 +38,7 @@ Authenticates a user's credentials and if okay, creates a new <a href='/referenc
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, password: string) => Promise<boolean | InvalidCredentialsError | ShopInvalidCredentialsError>`}   />
 
 Verify the provided password against the one we have for the given user. Requires
-the <a href='/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy'>NativeAuthenticationStrategy</a> to be configured.
+the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink> to be configured.
 ### destroyAuthenticatedSession
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sessionToken: string) => Promise<void>`}   />

package/docs/reference/typescript-api/services/channel-service.mdx

@@ -2,13 +2,9 @@
 title: "ChannelService"
 generated: true
 ---
-
-
-## ChannelService
-
 <GenerationInfo sourceFile="packages/core/src/service/services/channel.service.ts" sourceLine="54" packageName="@vendure/core" />
 
-Contains methods relating to <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> entities.
+Contains methods relating to <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink> entities.
 
 ```ts title="Signature"
 class ChannelService {
@@ -58,7 +54,7 @@ Removes the entity from the given Channels and saves.
 <MemberInfo kind="method" type={`(token: string) => Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>>`}   />
 
 Given a channel token, returns the corresponding Channel if it exists, else will throw
-a <a href='/reference/typescript-api/errors/error-types#channelnotfounderror'>ChannelNotFoundError</a>.
+a <DocsLink href="/reference/typescript-api/errors/error-types#channelnotfounderror">ChannelNotFoundError</DocsLink>.
 ### getChannelFromToken
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>>`}   />
@@ -104,7 +100,7 @@ Returns the default Channel.
 <MemberInfo kind="method" type={`(entity: <a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>) => entity is <a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a> &#38; <a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a>`}   />
 
 Type guard method which returns true if the given entity is an
-instance of a class which implements the <a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a> interface.
+instance of a class which implements the <DocsLink href="/reference/typescript-api/entities/interfaces#channelaware">ChannelAware</DocsLink> interface.
 
 
 </div>

package/docs/reference/typescript-api/services/collection-service.mdx

@@ -2,13 +2,9 @@
 title: "CollectionService"
 generated: true
 ---
-
-
-## CollectionService
-
 <GenerationInfo sourceFile="packages/core/src/service/services/collection.service.ts" sourceLine="77" packageName="@vendure/core" />
 
-Contains methods relating to <a href='/reference/typescript-api/entities/collection#collection'>Collection</a> entities.
+Contains methods relating to <DocsLink href="/reference/typescript-api/entities/collection#collection">Collection</DocsLink> entities.
 
 ```ts title="Signature"
 class CollectionService implements OnModuleInit {
@@ -73,7 +69,7 @@ class CollectionService implements OnModuleInit {
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => ConfigurableOperationDefinition[]`}   />
 
-Returns all configured CollectionFilters, as specified by the <a href='/reference/typescript-api/products-stock/catalog-options#catalogoptions'>CatalogOptions</a>.
+Returns all configured CollectionFilters, as specified by the <DocsLink href="/reference/typescript-api/products-stock/catalog-options#catalogoptions">CatalogOptions</DocsLink>.
 ### getParent
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/collection#collection'>Collection</a> | undefined>`}   />
@@ -148,7 +144,7 @@ its siblings.
 <MemberInfo kind="method" type={`(applyAllFiltersOnProductUpdates: boolean) => `}  since="3.1.3"  />
 
 By default, whenever product data is updated (as determined by subscribing to the
-<a href='/reference/typescript-api/events/event-types#productevent'>ProductEvent</a> and <a href='/reference/typescript-api/events/event-types#productvariantevent'>ProductVariantEvent</a> events), the CollectionFilters are re-applied
+<DocsLink href="/reference/typescript-api/events/event-types#productevent">ProductEvent</DocsLink> and <DocsLink href="/reference/typescript-api/events/event-types#productvariantevent">ProductVariantEvent</DocsLink> events), the CollectionFilters are re-applied
 to all Collections.
 
 In certain scenarios, such as when a large number of products are updated at once due to

package/docs/reference/typescript-api/services/country-service.mdx

@@ -2,13 +2,9 @@
 title: "CountryService"
 generated: true
 ---
-
-
-## CountryService
-
 <GenerationInfo sourceFile="packages/core/src/service/services/country.service.ts" sourceLine="33" packageName="@vendure/core" />
 
-Contains methods relating to <a href='/reference/typescript-api/entities/country#country'>Country</a> entities.
+Contains methods relating to <DocsLink href="/reference/typescript-api/entities/country#country">Country</DocsLink> entities.
 
 ```ts title="Signature"
 class CountryService {

package/docs/reference/typescript-api/services/customer-group-service.mdx

@@ -2,13 +2,9 @@
 title: "CustomerGroupService"
 generated: true
 ---
-
-
-## CustomerGroupService
-
 <GenerationInfo sourceFile="packages/core/src/service/services/customer-group.service.ts" sourceLine="38" packageName="@vendure/core" />
 
-Contains methods relating to <a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a> entities.
+Contains methods relating to <DocsLink href="/reference/typescript-api/entities/customer-group#customergroup">CustomerGroup</DocsLink> entities.
 
 ```ts title="Signature"
 class CustomerGroupService {
@@ -45,7 +41,7 @@ class CustomerGroupService {
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, customerGroupId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: CustomerListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`}   />
 
-Returns a <a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a> of all the Customers in the group.
+Returns a <DocsLink href="/reference/typescript-api/common/paginated-list#paginatedlist">PaginatedList</DocsLink> of all the Customers in the group.
 ### create
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateCustomerGroupInput) => Promise<<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>>`}   />