@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/typescript-api/request/request-context.mdx

@@ -2,20 +2,16 @@
 title: "RequestContext"
 generated: true
 ---
-
-
-## RequestContext
-
 <GenerationInfo sourceFile="packages/core/src/api/common/request-context.ts" sourceLine="179" packageName="@vendure/core" />
 
 The RequestContext holds information relevant to the current request, which may be
 required at various points of the stack.
 
-It is a good practice to inject the RequestContext (using the <a href='/reference/typescript-api/request/ctx-decorator#ctx'>Ctx</a> decorator) into
+It is a good practice to inject the RequestContext (using the <DocsLink href="/reference/typescript-api/request/ctx-decorator#ctx">Ctx</DocsLink> decorator) into
 _all_ resolvers & REST handler, and then pass it through to the service layer.
 
 This allows the service layer to access information about the current user, the active language,
-the active Channel, and so on. In addition, the <a href='/reference/typescript-api/data-access/transactional-connection#transactionalconnection'>TransactionalConnection</a> relies on the
+the active Channel, and so on. In addition, the <DocsLink href="/reference/typescript-api/data-access/transactional-connection#transactionalconnection">TransactionalConnection</DocsLink> relies on the
 presence of the RequestContext object in order to correctly handle per-request database transactions.
 
 The RequestContext also provides mechanisms for managing the database replication mode via the
@@ -75,7 +71,7 @@ class RequestContext {
 Creates an "empty" RequestContext object. This is only intended to be used
 when a service method must be called outside the normal request-response
 cycle, e.g. when programmatically populating data. Usually a better alternative
-is to use the <a href='/reference/typescript-api/request/request-context-service#requestcontextservice'>RequestContextService</a> `create()` method, which allows more control
+is to use the <DocsLink href="/reference/typescript-api/request/request-context-service#requestcontextservice">RequestContextService</DocsLink> `create()` method, which allows more control
 over the resulting RequestContext object.
 ### deserialize
 
@@ -121,7 +117,7 @@ ctx.userHasAllPermissions([Permission.ReadProduct, Permission.UpdateProduct]);
 
 Serializes the RequestContext object into a JSON-compatible simple object.
 This is useful when you need to send a RequestContext object to another
-process, e.g. to pass it to the Job Queue via the <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a>.
+process, e.g. to pass it to the Job Queue via the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink>.
 ### copy
 
 <MemberInfo kind="method" type={`() => <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`}   />
@@ -143,7 +139,7 @@ Signals which API this request was received by, e.g. `admin` or `shop`.
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`}   />
 
-The active <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> of this request.
+The active <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink> of this request.
 ### channelId
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />

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 {
@@ -52,22 +48,22 @@ class DefaultSchedulerStrategy implements SchedulerStrategy {
 
 ### getTasks
 
-<MemberInfo kind="method" type={`() => Promise&#60;<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>[]&#62;`}   />
+<MemberInfo kind="method" type={`() => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>[]>`}   />
 
 
 ### getTask
 
-<MemberInfo kind="method" type={`(id: string) => Promise&#60;<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a> | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(id: string) => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a> | undefined>`}   />
 
 
 ### updateTask
 
-<MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise&#60;<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>&#62;`}   />
+<MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>>`}   />
 
 
 ### triggerTask
 
-<MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => Promise<void>`}   />
 
 
 

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.
@@ -38,7 +34,7 @@ class ScheduledTask<C extends Record<string, any> = Record<string, any>> {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>&#60;C&#62;) => ScheduledTask`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a><C>) => ScheduledTask`}   />
 
 
 ### id
@@ -58,7 +54,7 @@ class ScheduledTask<C extends Record<string, any> = Record<string, any>> {
 
 ### configure
 
-<MemberInfo kind="method" type={`(additionalConfig: Partial&#60;Pick&#60;<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>&#60;C&#62;, 'schedule' | 'timeout' | 'params'&#62;&#62;) => `}   />
+<MemberInfo kind="method" type={`(additionalConfig: Partial<Pick<<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a><C>, 'schedule' | 'timeout' | 'params'>>) => `}   />
 
 This method allows you to further configure existing scheduled tasks. For example, you may
 wish to change the schedule or timeout of a task, without having to define a new task.
@@ -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.
@@ -157,7 +145,7 @@ The description for the scheduled task.
 Optional parameters that will be passed to the `execute` function.
 ### schedule
 
-<MemberInfo kind="property" type={`string | ((cronTime: typeof CronTime) =&#62; string)`}   />
+<MemberInfo kind="property" type={`string | ((cronTime: typeof CronTime) => string)`}   />
 
 The cron schedule for the scheduled task. This can be a standard cron expression or
 a function that returns a [cron-time-generator](https://www.npmjs.com/package/cron-time-generator)
@@ -187,7 +175,7 @@ will be considered to have failed with a timeout error.
 Whether the scheduled task should be prevented from running if it is already running.
 ### execute
 
-<MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskexecutionargs'>ScheduledTaskExecutionArgs</a>&#60;C&#62;) => Promise&#60;any&#62;`}   />
+<MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskexecutionargs'>ScheduledTaskExecutionArgs</a><C>) => Promise<any>`}   />
 
 The function that will be executed when the scheduled task is run.
 

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.
@@ -43,17 +39,17 @@ class SchedulerService implements OnApplicationBootstrap, OnApplicationShutdown
 
 ### getTaskList
 
-<MemberInfo kind="method" type={`() => Promise&#60;TaskInfo[]&#62;`}   />
+<MemberInfo kind="method" type={`() => Promise<TaskInfo[]>`}   />
 
 Returns a list of all the scheduled tasks and their current status.
 ### updateTask
 
-<MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise&#60;TaskInfo&#62;`}   />
+<MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise<TaskInfo>`}   />
 
 
 ### runTask
 
-<MemberInfo kind="method" type={`(taskId: string) => Promise&#60;Success&#62;`}   />
+<MemberInfo kind="method" type={`(taskId: string) => Promise<Success>`}   />
 
 
 

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"
@@ -44,13 +40,13 @@ tasks ahead of time. This can be useful for keeping an internal reference of
 all the tasks to aid in the specific strategy implemetation.
 ### executeTask
 
-<MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => (job?: Cron) =&#62; Promise&#60;any&#62; | any`}   />
+<MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => (job?: Cron) => Promise<any> | any`}   />
 
 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
@@ -61,17 +57,17 @@ The function returned is then called in order to execture the task. The
 the task has been manually triggered, in which case it will be undefined.
 ### getTasks
 
-<MemberInfo kind="method" type={`() => Promise&#60;<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>[]&#62;`}   />
+<MemberInfo kind="method" type={`() => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>[]>`}   />
 
 Get all scheduled tasks.
 ### getTask
 
-<MemberInfo kind="method" type={`(id: string) => Promise&#60;<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a> | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(id: string) => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a> | undefined>`}   />
 
 Get a single scheduled task by its id.
 ### triggerTask
 
-<MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => Promise<void>`}   />
 
 Manually trigger a given task. This method is not used to actually invoke the
 task function itself, since that would cause the task to run on the server
@@ -79,21 +75,17 @@ 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
 
-<MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise&#60;<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>&#62;`}   />
+<MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>>`}   />
 
 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&#60;DuplicateEntityResult&#62;`}   />
+<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,
@@ -32,7 +28,7 @@ class OrderCalculator {
 
 ### applyPriceAdjustments
 
-<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>, promotions: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>[], updatedOrderLines: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[] = [], options?: { recalculateShipping?: boolean }) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`}   />
+<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>, promotions: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>[], updatedOrderLines: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[] = [], options?: { recalculateShipping?: boolean }) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`}   />
 
 Applies taxes and promotions to an Order. Mutates the order object.
 Returns an array of any OrderItems which had new adjustments

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.
@@ -53,7 +49,7 @@ OrderLines into account when constraining the quantity. See https://github.com/v
 for more on this.
 ### getExistingOrderLine
 
-<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 }) => Promise&#60;<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a> | undefined&#62;`}   />
+<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 }) => Promise<<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a> | undefined>`}   />
 
 Given a ProductVariant ID and optional custom fields, this method will return an existing OrderLine that
 matches, or `undefined` if no match is found.
@@ -61,11 +57,11 @@ 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
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>>`}   />
 
 Updates the quantity of an OrderLine, taking into account the available saleable stock level.
 Returns the actual quantity that the OrderLine was updated to (which may be less than the
@@ -77,7 +73,7 @@ Returns the actual quantity that the OrderLine was updated to (which may be less
 
 ### modifyOrder
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: ModifyOrderInput, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;JustErrorResults&#60;ModifyOrderResult&#62; | { order: <a href='/reference/typescript-api/entities/order#order'>Order</a>; modification: <a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a> }&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: ModifyOrderInput, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<JustErrorResults<ModifyOrderResult> | { order: <a href='/reference/typescript-api/entities/order#order'>Order</a>; modification: <a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a> }>`}   />
 
 
 ### setShippingMethods

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:
 
@@ -49,7 +45,7 @@ class ProductPriceApplicator {
 
 ### applyChannelPriceAndTax
 
-<MemberInfo kind="method" type={`(variant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order?: <a href='/reference/typescript-api/entities/order#order'>Order</a>, throwIfNoPriceFound:  = false) => Promise&#60;<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>&#62;`}   />
+<MemberInfo kind="method" type={`(variant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order?: <a href='/reference/typescript-api/entities/order#order'>Order</a>, throwIfNoPriceFound:  = false) => Promise<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>`}   />
 
 Populates the `price` field with the price for the specified channel. Make sure that
 the ProductVariant being passed in has its `taxCategory` relation joined.

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 {
@@ -27,16 +23,12 @@ class SlugValidator {
 
 ### validateSlugs
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: T, translationEntity: Type&#60;E&#62;) => Promise&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: T, translationEntity: Type<E>) => Promise<T>`}   />
 
 
 
 
 </div>
-
-
-## InputWithSlug
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/slug-validator/slug-validator.ts" sourceLine="16" packageName="@vendure/core" />
 
 
@@ -61,16 +53,12 @@ type InputWithSlug = {
 
 ### translations
 
-<MemberInfo kind="property" type={`Array&#60;{         id?: <a href='/reference/typescript-api/common/id#id'>ID</a> | null;         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         slug?: string | null;     }&#62; | null`}   />
+<MemberInfo kind="property" type={`Array<{         id?: <a href='/reference/typescript-api/common/id#id'>ID</a> | null;         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         slug?: string | null;     }> | null`}   />
 
 
 
 
 </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*
 
@@ -50,13 +46,13 @@ class TranslatableSaver {
 
 ### create
 
-<MemberInfo kind="method" type={`(options: CreateTranslatableOptions&#60;T&#62;) => Promise&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(options: CreateTranslatableOptions<T>) => Promise<T>`}   />
 
 Create a translatable entity, including creating any translation entities according
 to the `translations` array.
 ### update
 
-<MemberInfo kind="method" type={`(options: UpdateTranslatableOptions&#60;T&#62;) => Promise&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(options: UpdateTranslatableOptions<T>) => Promise<T>`}   />
 
 Update a translatable entity. Performs a diff of the `translations` array in order to
 perform the correct operation on the translations.

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.
@@ -54,7 +50,7 @@ class TranslatorService {
 
 ### translate
 
-<MemberInfo kind="method" type={`(translatable: T, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, translatableRelations: DeepTranslatableRelations&#60;T&#62; = []) => `}   />
+<MemberInfo kind="method" type={`(translatable: T, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, translatableRelations: DeepTranslatableRelations<T> = []) => `}   />