npm - @vendure/docs - Versions diffs - 0.0.0-202601211609 → 0.0.0-202601221206 - Mend

@vendure/docs 0.0.0-202601211609 → 0.0.0-202601221206

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (381) hide show

package/docs/reference/typescript-api/promotions/promotion-action.mdx CHANGED Viewed

@@ -28,7 +28,7 @@ on the same Order. See the <DocsLink href="/reference/typescript-api/entities/pr
 more information.
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionactionconfig'>PromotionActionConfig</a>`<T, U>`) => PromotionAction`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionactionconfig'>PromotionActionConfig</a><T, U>) => PromotionAction`}   />
@@ -65,7 +65,7 @@ class PromotionItemAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionitemactionconfig'>PromotionItemActionConfig</a>`<T, U>`) => PromotionItemAction`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionitemactionconfig'>PromotionItemActionConfig</a><T, U>) => PromotionItemAction`}   />
@@ -102,7 +102,7 @@ class PromotionOrderAction<T extends ConfigArgs = ConfigArgs, U extends Promotio
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionorderactionconfig'>PromotionOrderActionConfig</a>`<T, U>`) => PromotionOrderAction`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionorderactionconfig'>PromotionOrderActionConfig</a><T, U>) => PromotionOrderAction`}   />
@@ -125,7 +125,7 @@ class PromotionShippingAction<T extends ConfigArgs = ConfigArgs, U extends Promo
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionshippingactionconfig'>PromotionShippingActionConfig</a>`<T, U>`) => PromotionShippingAction`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionshippingactionconfig'>PromotionShippingActionConfig</a><T, U>) => PromotionShippingAction`}   />
@@ -227,7 +227,7 @@ on the same Order. See the <DocsLink href="/reference/typescript-api/entities/pr
 more information.
 ### conditions
-<MemberInfo kind="property" type={``U extends undefined ? undefined : ConditionTuple<Exclude<U, undefined>>``}   />
+<MemberInfo kind="property" type={`U extends undefined ? undefined : ConditionTuple<Exclude<U, undefined>>`}   />
 Allows PromotionActions to define one or more PromotionConditions as dependencies. Having a PromotionCondition
 as a dependency has the following consequences:
@@ -237,7 +237,7 @@ on which it depends.
 the return values of the PromotionConditions' `check()` function.
 ### onActivate
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a>`<T>``}  since="1.8.0" experimental="true" />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a><T>`}  since="1.8.0" experimental="true" />
 An optional side effect function which is invoked when the promotion
 becomes active. It can be used for things like adding a free gift to the order
@@ -247,7 +247,7 @@ If used, make sure to use the corresponding `onDeactivate` function to clean up
 or reverse any side effects as needed.
 ### onDeactivate
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a>`<T>``}  since="1.8.0" experimental="true" />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a><T>`}  since="1.8.0" experimental="true" />
 Used to reverse or clean up any side effects executed as part of the `onActivate` function.
@@ -270,7 +270,7 @@ interface PromotionItemActionConfig<T extends ConfigArgs, U extends PromotionCon
 ### execute
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionitemactionfn'>ExecutePromotionItemActionFn</a>`<T, U>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionitemactionfn'>ExecutePromotionItemActionFn</a><T, U>`}   />
 The function which contains the promotion calculation logic.
 Should resolve to a number which represents the amount by which to discount
@@ -295,7 +295,7 @@ interface PromotionLineActionConfig<T extends ConfigArgs, U extends PromotionCon
 ### execute
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionlineactionfn'>ExecutePromotionLineActionFn</a>`<T, U>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionlineactionfn'>ExecutePromotionLineActionFn</a><T, U>`}   />
 The function which contains the promotion calculation logic.
 Should resolve to a number which represents the amount by which to discount
@@ -320,7 +320,7 @@ interface PromotionOrderActionConfig<T extends ConfigArgs, U extends PromotionCo
 ### execute
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionorderactionfn'>ExecutePromotionOrderActionFn</a>`<T, U>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionorderactionfn'>ExecutePromotionOrderActionFn</a><T, U>`}   />
 The function which contains the promotion calculation logic.
 Should resolve to a number which represents the amount by which to discount
@@ -345,7 +345,7 @@ interface PromotionShippingActionConfig<T extends ConfigArgs, U extends Promotio
 ### execute
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionshippingactionfn'>ExecutePromotionShippingActionFn</a>`<T, U>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionshippingactionfn'>ExecutePromotionShippingActionFn</a><T, U>`}   />
 The function which contains the promotion calculation logic.
 Should resolve to a number which represents the amount by which to discount
@@ -385,7 +385,7 @@ class PromotionLineAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionlineactionconfig'>PromotionLineActionConfig</a>`<T, U>`) => PromotionLineAction`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionlineactionconfig'>PromotionLineActionConfig</a><T, U>) => PromotionLineAction`}   />

package/docs/reference/typescript-api/promotions/promotion-condition.mdx CHANGED Viewed

@@ -36,12 +36,12 @@ more information.
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-condition#promotionconditionconfig'>PromotionConditionConfig</a>`<T, C, R>`) => PromotionCondition`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-condition#promotionconditionconfig'>PromotionConditionConfig</a><T, C, R>) => PromotionCondition`}   />
 ### check
-<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>, args: ConfigArg[], promotion: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>) => `Promise<R>``}   />
+<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>, args: ConfigArg[], promotion: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>) => Promise<R>`}   />
 This is the function which contains the conditional logic to decide whether
 a Promotion should apply to an Order. See <DocsLink href="/reference/typescript-api/promotions/promotion-condition#checkpromotionconditionfn">CheckPromotionConditionFn</DocsLink>.
@@ -72,7 +72,7 @@ interface PromotionConditionConfig<T extends ConfigArgs, C extends string, R ext
 ### check
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-condition#checkpromotionconditionfn'>CheckPromotionConditionFn</a>`<T, R>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-condition#checkpromotionconditionfn'>CheckPromotionConditionFn</a><T, R>`}   />
 ### priorityValue

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

@@ -17,12 +17,12 @@ interface PromotionOptions {
 ### promotionConditions
-<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a>`<any>>``}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a><any>>`}   />
 An array of conditions which can be used to construct Promotions
 ### promotionActions
-<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a>`<any>>``}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a><any>>`}   />
 An array of actions which can be used to construct Promotions

package/docs/reference/typescript-api/request/request-context-service.mdx CHANGED Viewed

@@ -25,14 +25,14 @@ class RequestContextService {
 ### create
-<MemberInfo kind="method" type={`(config: {         req?: Request;         apiType: <a href='/reference/typescript-api/request/api-type#apitype'>ApiType</a>;         channelOrToken?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | string;         languageCode?: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         currencyCode?: <a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>;         user?: <a href='/reference/typescript-api/entities/user#user'>User</a>;         activeOrderId?: <a href='/reference/typescript-api/common/id#id'>ID</a>;     }) => `Promise<`<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`>``}  since="1.5.0"  />
+<MemberInfo kind="method" type={`(config: {         req?: Request;         apiType: <a href='/reference/typescript-api/request/api-type#apitype'>ApiType</a>;         channelOrToken?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | string;         languageCode?: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         currencyCode?: <a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>;         user?: <a href='/reference/typescript-api/entities/user#user'>User</a>;         activeOrderId?: <a href='/reference/typescript-api/common/id#id'>ID</a>;     }) => Promise<<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>>`}  since="1.5.0"  />
 Creates a RequestContext based on the config provided. This can be useful when interacting
 with services outside the request-response cycle, for example in stand-alone scripts or in
 worker jobs.
 ### fromRequest
-<MemberInfo kind="method" type={`(req: Request, info?: GraphQLResolveInfo, requiredPermissions?: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>[], session?: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => `Promise<`<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`>``}   />
+<MemberInfo kind="method" type={`(req: Request, info?: GraphQLResolveInfo, requiredPermissions?: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>[], session?: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => Promise<<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>>`}   />
 Creates a new RequestContext based on an Express request object. This is used internally
 in the API layer by the AuthGuard, and creates the RequestContext which is then passed

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

@@ -87,7 +87,7 @@ Returns `true` if there is an active Session & User associated with this request
 and that User has **at least one** of the specified permissions on the active Channel.
 This method uses OR logic - it checks if the user has ANY of the given permissions,
-not ALL of them. For AND logic, use {@link userHasAllPermissions}.
+not ALL of them. For AND logic, use `userHasAllPermissions`.
 *Example*
@@ -103,7 +103,7 @@ Returns `true` if there is an active Session & User associated with this request
 and that User has **all** of the specified permissions on the active Channel.
 This method uses AND logic - it checks if the user has EVERY one of the given permissions.
-For OR logic (any permission), use {@link userHasPermissions}.
+For OR logic (any permission), use `userHasPermissions`.
 *Example*

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

@@ -48,22 +48,22 @@ class DefaultSchedulerStrategy implements SchedulerStrategy {
 ### getTasks
-<MemberInfo kind="method" type={`() => `Promise<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>`[]>``}   />
+<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<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>` | undefined>``}   />
+<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<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>`>``}   />
+<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<void>``}   />
+<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 CHANGED Viewed

@@ -34,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>`<C>`) => ScheduledTask`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a><C>) => ScheduledTask`}   />
 ### id
@@ -54,7 +54,7 @@ class ScheduledTask<C extends Record<string, any> = Record<string, any>> {
 ### configure
-<MemberInfo kind="method" type={`(additionalConfig: `Partial<Pick<`<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>`<C>, 'schedule' | 'timeout' | 'params'>>`) => `}   />
+<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.
@@ -145,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) => 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)
@@ -175,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>`<C>`) => `Promise<any>``}   />
+<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-service.mdx CHANGED Viewed

@@ -39,17 +39,17 @@ class SchedulerService implements OnApplicationBootstrap, OnApplicationShutdown
 ### getTaskList
-<MemberInfo kind="method" type={`() => `Promise<TaskInfo[]>``}   />
+<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<TaskInfo>``}   />
+<MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise<TaskInfo>`}   />
 ### runTask
-<MemberInfo kind="method" type={`(taskId: string) => `Promise<Success>``}   />
+<MemberInfo kind="method" type={`(taskId: string) => Promise<Success>`}   />

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

@@ -40,7 +40,7 @@ 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) => Promise<any> | 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,
@@ -57,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<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>`[]>``}   />
+<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<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>` | undefined>``}   />
+<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<void>``}   />
+<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
@@ -80,7 +80,7 @@ a flag in the database table which is checked periodically and causes those task
 to get immediately invoked.
 ### updateTask
-<MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => `Promise<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>`>``}   />
+<MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>>`}   />
 Update a scheduled task.

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

@@ -29,7 +29,7 @@ class EntityDuplicatorService {
 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>``}   />
+<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 <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 CHANGED Viewed

@@ -28,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<`<a href='/reference/typescript-api/entities/order#order'>Order</a>`>``}   />
+<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 CHANGED Viewed

@@ -49,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<`<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>` | undefined>``}   />
+<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,7 +61,7 @@ Returns the OrderLine containing the given <DocsLink href="/reference/typescript
 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<`<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>`>``}   />
+<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
@@ -73,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<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>` }>``}   />
+<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 CHANGED Viewed

@@ -45,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<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>``}   />
+<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 CHANGED Viewed

@@ -23,7 +23,7 @@ class SlugValidator {
 ### validateSlugs
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: T, translationEntity: `Type<E>`) => `Promise<T>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: T, translationEntity: Type<E>) => Promise<T>`}   />
@@ -53,7 +53,7 @@ type InputWithSlug = {
 ### translations
-<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``}   />
+<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`}   />

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

@@ -46,13 +46,13 @@ class TranslatableSaver {
 ### create
-<MemberInfo kind="method" type={`(options: `CreateTranslatableOptions<T>`) => `Promise<T>``}   />
+<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<T>`) => `Promise<T>``}   />
+<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 CHANGED Viewed

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

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

@@ -28,32 +28,32 @@ class AdministratorService {
 ### findAll
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: `ListQueryOptions<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>`, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>>`}   />
 Get a paginated list of Administrators.
 ### findOne
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, administratorId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>`) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, administratorId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a> | undefined>`}   />
 Get an Administrator by id.
 ### findOneByUserId
-<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>, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>`) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>` | undefined>``}   />
+<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>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a> | undefined>`}   />
 Get an Administrator based on the User id.
 ### create
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateAdministratorInput) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateAdministratorInput) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>`}   />
 Create a new Administrator.
 ### update
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAdministratorInput) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAdministratorInput) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>`}   />
 Update an existing Administrator.
 ### assignRole
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, administratorId: <a href='/reference/typescript-api/common/id#id'>ID</a>, roleId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, administratorId: <a href='/reference/typescript-api/common/id#id'>ID</a>, roleId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>`}   />
 Assigns a Role to the Administrator's User entity.
 ### softDelete

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

@@ -34,38 +34,38 @@ class AssetService {
 ### findOne
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`>`) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a> | undefined>`}   />
 ### findAll
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: AssetListOptions, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`>>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: AssetListOptions, relations?: RelationPaths<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>>`}   />
 ### getFeaturedAsset
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a> | undefined>`}   />
 ### getEntityAssets
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`[] | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[] | undefined>`}   />
 Returns the Assets of an entity which has a well-ordered list of Assets, such as Product,
 ProductVariant or Collection.
 ### updateFeaturedAsset
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, input: <a href='/reference/typescript-api/services/asset-service#entityassetinput'>EntityAssetInput</a>) => `Promise<T>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, input: <a href='/reference/typescript-api/services/asset-service#entityassetinput'>EntityAssetInput</a>) => Promise<T>`}   />
 ### updateEntityAssets
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, input: <a href='/reference/typescript-api/services/asset-service#entityassetinput'>EntityAssetInput</a>) => `Promise<T>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, input: <a href='/reference/typescript-api/services/asset-service#entityassetinput'>EntityAssetInput</a>) => Promise<T>`}   />
 Updates the assets / featuredAsset of an entity, ensuring that only valid assetIds are used.
 ### create
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateAssetInput) => `Promise<CreateAssetResult>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateAssetInput) => Promise<CreateAssetResult>`}   />
 Create an Asset based on a file uploaded via the GraphQL API. The file should be uploaded
 using the [GraphQL multipart request specification](https://github.com/jaydenseric/graphql-multipart-request-spec),
@@ -74,33 +74,33 @@ e.g. using the [apollo-upload-client](https://github.com/jaydenseric/apollo-uplo
 See the [Uploading Files docs](/guides/developer-guide/uploading-files) for an example of usage.
 ### update
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAssetInput) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAssetInput) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>`}   />
 Updates the name, focalPoint, tags & custom fields of an Asset.
 ### delete
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], force: boolean = false, deleteFromAllChannels: boolean = false) => `Promise<DeletionResponse>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], force: boolean = false, deleteFromAllChannels: boolean = false) => Promise<DeletionResponse>`}   />
 Deletes an Asset after performing checks to ensure that the Asset is not currently in use
 by a Product, ProductVariant or Collection.
 ### assignToChannel
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignAssetsToChannelInput) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`[]>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignAssetsToChannelInput) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]>`}   />
 ### createFromFileStream
-<MemberInfo kind="method" type={`(stream: ReadStream, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<CreateAssetResult>``}   />
+<MemberInfo kind="method" type={`(stream: ReadStream, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<CreateAssetResult>`}   />
 Create an Asset from a file stream, for example to create an Asset during data import.
 ### createFromFileStream
-<MemberInfo kind="method" type={`(stream: Readable, filePath: string, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<CreateAssetResult>``}   />
+<MemberInfo kind="method" type={`(stream: Readable, filePath: string, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<CreateAssetResult>`}   />
 ### createFromFileStream
-<MemberInfo kind="method" type={`(stream: ReadStream | Readable, maybeFilePathOrCtx?: string | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, maybeCtx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<CreateAssetResult>``}   />
+<MemberInfo kind="method" type={`(stream: ReadStream | Readable, maybeFilePathOrCtx?: string | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, maybeCtx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<CreateAssetResult>`}   />