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

@vendure/docs 0.0.0-202601211609 → 0.0.0-202601220950

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 (371) hide show

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

@@ -26,27 +26,27 @@ class TaxCategoryService {
 ### 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/tax-category#taxcategory'>TaxCategory</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</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/tax-category#taxcategory'>TaxCategory</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>>>`}   />
 ### findOne
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, taxCategoryId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => `Promise<`<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, taxCategoryId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a> | undefined>`}   />
 ### create
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateTaxCategoryInput) => `Promise<`<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateTaxCategoryInput) => Promise<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>>`}   />
 ### update
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateTaxCategoryInput) => `Promise<`<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateTaxCategoryInput) => Promise<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>>`}   />
 ### delete
-<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>) => `Promise<DeletionResponse>``}   />
+<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>) => Promise<DeletionResponse>`}   />

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

@@ -27,32 +27,32 @@ class TaxRateService {
 ### 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/tax-rate#taxrate'>TaxRate</a>`>`, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</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/tax-rate#taxrate'>TaxRate</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>>`}   />
 ### findOne
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, taxRateId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>`>`) => `Promise<`<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, taxRateId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>) => Promise<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a> | undefined>`}   />
 ### create
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateTaxRateInput) => `Promise<`<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateTaxRateInput) => Promise<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>`}   />
 ### update
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateTaxRateInput) => `Promise<`<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateTaxRateInput) => Promise<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>`}   />
 ### delete
-<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>) => `Promise<DeletionResponse>``}   />
+<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>) => Promise<DeletionResponse>`}   />
 ### getApplicableTaxRate
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, zone: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | <a href='/reference/typescript-api/common/id#id'>ID</a>, taxCategory: <a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a> | <a href='/reference/typescript-api/common/id#id'>ID</a>) => `Promise<`<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, zone: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | <a href='/reference/typescript-api/common/id#id'>ID</a>, taxCategory: <a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a> | <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>`}   />
 Returns the applicable TaxRate based on the specified Zone and TaxCategory. Used when calculating Order
 prices.

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

@@ -41,29 +41,29 @@ class UserService {
 ### getUserById
-<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>) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</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>) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`}   />
 ### getUserByEmailAddress
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string, userType?: 'administrator' | 'customer') => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string, userType?: 'administrator' | 'customer') => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`}   />
 ### createCustomerUser
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string, password?: string) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>` | PasswordValidationError>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string, password?: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | PasswordValidationError>`}   />
 Creates a new User with the special `customer` Role and using the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink>.
 ### addNativeAuthenticationMethod
-<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>, identifier: string, password?: string) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>` | PasswordValidationError>``}   />
+<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>, identifier: string, password?: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | PasswordValidationError>`}   />
 Adds a new <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> to the User. If the <DocsLink href="/reference/typescript-api/auth/auth-options#authoptions">AuthOptions</DocsLink> `requireVerification`
 is set to `true` (as is the default), the User will be marked as unverified until the email verification
 flow is completed.
 ### createAdminUser
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string, password: string) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string, password: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`}   />
 Creates a new verified User using the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink>.
 ### softDelete
@@ -73,13 +73,13 @@ Creates a new verified User using the <DocsLink href="/reference/typescript-api/
 ### setVerificationToken
-<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>) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>`>``}   />
+<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>) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`}   />
 Sets the <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> `verificationToken` as part of the User email verification
 flow.
 ### verifyUserByToken
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, verificationToken: string, password?: string) => `Promise<`<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<VerifyCustomerAccountResult, `<a href='/reference/typescript-api/entities/user#user'>User</a>`>>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, verificationToken: string, password?: string) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><VerifyCustomerAccountResult, <a href='/reference/typescript-api/entities/user#user'>User</a>>>`}   />
 Verifies a verificationToken by looking for a User which has previously had it set using the
 `setVerificationToken()` method, and checks that the token is valid and has not expired.
@@ -87,13 +87,13 @@ Verifies a verificationToken by looking for a User which has previously had it s
 If valid, the User will be set to `verified: true`.
 ### setPasswordResetToken
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`}   />
 Sets the <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> `passwordResetToken` as part of the User password reset
 flow.
 ### resetPasswordByToken
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, passwordResetToken: string, password: string) => `Promise<         `<a href='/reference/typescript-api/entities/user#user'>User</a>` | PasswordResetTokenExpiredError | PasswordResetTokenInvalidError | PasswordValidationError     >``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, passwordResetToken: string, password: string) => Promise<         <a href='/reference/typescript-api/entities/user#user'>User</a> | PasswordResetTokenExpiredError | PasswordResetTokenInvalidError | PasswordValidationError     >`}   />
 Verifies a passwordResetToken by looking for a User which has previously had it set using the
 `setPasswordResetToken()` method, and checks that the token is valid and has not expired.
@@ -107,19 +107,19 @@ Changes the User identifier without an email verification step, so this should b
 an Administrator is setting a new email address.
 ### setIdentifierChangeToken
-<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>) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>`>``}   />
+<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>) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`}   />
 Sets the <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> `identifierChangeToken` as part of the User email address change
 flow.
 ### changeIdentifierByToken
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => `Promise<         | { user: `<a href='/reference/typescript-api/entities/user#user'>User</a>`; oldIdentifier: string }         | IdentifierChangeTokenInvalidError         | IdentifierChangeTokenExpiredError     >``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise<         | { user: <a href='/reference/typescript-api/entities/user#user'>User</a>; oldIdentifier: string }         | IdentifierChangeTokenInvalidError         | IdentifierChangeTokenExpiredError     >`}   />
 Changes the User identifier as part of the storefront flow used by Customers to set a
 new email address, with the token previously set using the `setIdentifierChangeToken()` method.
 ### updatePassword
-<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>, currentPassword: string, newPassword: string) => `Promise<boolean | InvalidCredentialsError | PasswordValidationError>``}   />
+<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>, currentPassword: string, newPassword: string) => Promise<boolean | InvalidCredentialsError | PasswordValidationError>`}   />
 Updates the password for a User with the <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink>.

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

@@ -29,42 +29,42 @@ class ZoneService {
 ### 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/zone#zone'>Zone</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</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/zone#zone'>Zone</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>>`}   />
 ### findOne
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, zoneId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => `Promise<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, zoneId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined>`}   />
 ### getAllWithMembers
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`[]>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>[]>`}   />
 ### create
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateZoneInput) => `Promise<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateZoneInput) => Promise<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>`}   />
 ### update
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateZoneInput) => `Promise<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateZoneInput) => Promise<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>`}   />
 ### delete
-<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>) => `Promise<DeletionResponse>``}   />
+<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>) => Promise<DeletionResponse>`}   />
 ### addMembersToZone
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { memberIds, zoneId }: MutationAddMembersToZoneArgs) => `Promise<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { memberIds, zoneId }: MutationAddMembersToZoneArgs) => Promise<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>`}   />
 ### removeMembersFromZone
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { memberIds, zoneId }: MutationRemoveMembersFromZoneArgs) => `Promise<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { memberIds, zoneId }: MutationRemoveMembersFromZoneArgs) => Promise<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>`}   />

package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx CHANGED Viewed

@@ -50,7 +50,7 @@ Whether this field is readonly via the GraphQL API.
 Readonly fields can still be modified programmatically via a service.
 ### requiresPermission
-<MemberInfo kind="property" type={``| Array<`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>` | string>         | `<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`         | string         | {               read?: Array<`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>` | string> | `<a href='/reference/typescript-api/common/permission#permission'>Permission</a>` | string;               write?: Array<`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>` | string> | `<a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string;           }`}  since="3.5.0 - Added support for object with read/write properties"  />
+<MemberInfo kind="property" type={`| Array<<a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string>         | <a href='/reference/typescript-api/common/permission#permission'>Permission</a>         | string         | {               read?: Array<<a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string> | <a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string;               write?: Array<<a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string> | <a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string;           }`}  since="3.5.0 - Added support for object with read/write properties"  />
 Permissions required to access this field. If not specified,
 basic authentication is required for admin API access.
@@ -79,7 +79,7 @@ requiresPermission: {
 ```
 ### validate
-<MemberInfo kind="property" type={`(         value: any,         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`,     ) => string | LocalizedString[] | void | Promise<string | LocalizedString[] | void>``}   />
+<MemberInfo kind="property" type={`(         value: any,         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,     ) => string | LocalizedString[] | void | Promise<string | LocalizedString[] | void>`}   />
 Custom validation function for field values.

package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx CHANGED Viewed

@@ -20,7 +20,7 @@ class DefaultShippingLineAssignmentStrategy implements ShippingLineAssignmentStr
 ### assignShippingLineToOrderLines
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, shippingLine: <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</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>, shippingLine: <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[] | Promise<<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[]>`}   />

package/docs/reference/typescript-api/shipping/shipping-calculator.mdx CHANGED Viewed

@@ -45,7 +45,7 @@ class ShippingCalculator<T extends ConfigArgs = ConfigArgs> extends Configurable
 ### constructor
-<MemberInfo kind="method" type={`(config: `ShippingCalculatorConfig<T>`) => ShippingCalculator`}   />
+<MemberInfo kind="method" type={`(config: ShippingCalculatorConfig<T>) => ShippingCalculator`}   />
@@ -83,7 +83,7 @@ Whether or not the given price already includes taxes.
 The tax rate applied to the shipping price.
 ### metadata
-<MemberInfo kind="property" type={``Record<string, any>``}   />
+<MemberInfo kind="property" type={`Record<string, any>`}   />
 Arbitrary metadata may be returned from the calculation function. This can be used
 e.g. to return data on estimated delivery times or any other data which may be

package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx CHANGED Viewed

@@ -21,12 +21,12 @@ interface ShippingEligibilityCheckerConfig<T extends ConfigArgs> extends Configu
 ### check
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn#checkshippingeligibilitycheckerfn'>CheckShippingEligibilityCheckerFn</a>`<T>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn#checkshippingeligibilitycheckerfn'>CheckShippingEligibilityCheckerFn</a><T>`}   />
 ### shouldRunCheck
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/should-run-check-fn#shouldruncheckfn'>ShouldRunCheckFn</a>`<T>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/should-run-check-fn#shouldruncheckfn'>ShouldRunCheckFn</a><T>`}   />

package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx CHANGED Viewed

@@ -37,7 +37,7 @@ class ShippingEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends Conf
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/shipping/shipping-eligibility-checker-config#shippingeligibilitycheckerconfig'>ShippingEligibilityCheckerConfig</a>`<T>`) => ShippingEligibilityChecker`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/shipping/shipping-eligibility-checker-config#shippingeligibilitycheckerconfig'>ShippingEligibilityCheckerConfig</a><T>) => ShippingEligibilityChecker`}   />
 ### init

package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx CHANGED Viewed

@@ -62,7 +62,7 @@ interface ShippingLineAssignmentStrategy extends InjectableStrategy {
 ### assignShippingLineToOrderLines
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, shippingLine: <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</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>, shippingLine: <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[] | Promise<<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[]>`}   />

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

@@ -21,12 +21,12 @@ interface ShippingOptions {
 ### shippingEligibilityCheckers
-<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a>`<any>>``}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a><any>>`}   />
 An array of available ShippingEligibilityCheckers for use in configuring ShippingMethods
 ### shippingCalculators
-<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a>`<any>>``}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a><any>>`}   />
 An array of available ShippingCalculators for use in configuring ShippingMethods
 ### shippingLineAssignmentStrategy
@@ -38,19 +38,19 @@ This allows you to set multiple shipping methods for a single order, each assign
 OrderLines.
 ### customFulfillmentProcess
-<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>`<any>>``}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a><any>>`}   />
 Allows the definition of custom states and transition logic for the fulfillment process state machine.
 Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
 ### process
-<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>`<any>>``} default={`<a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a>`}  since="2.0.0"  />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a><any>>`} default={`<a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a>`}  since="2.0.0"  />
 Allows the definition of custom states and transition logic for the fulfillment process state machine.
 Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
 ### fulfillmentHandlers
-<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a>`<any>>``}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a><any>>`}   />
 An array of available FulfillmentHandlers.

package/docs/reference/typescript-api/state-machine/fsm.mdx CHANGED Viewed

@@ -23,7 +23,7 @@ class FSM<T extends string, Data = any> {
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a>`<T, Data>`, initialState: T) => FSM`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a><T, Data>, initialState: T) => FSM`}   />
 ### initialState
@@ -38,7 +38,7 @@ class FSM<T extends string, Data = any> {
 ### transitionTo
-<MemberInfo kind="method" type={`(state: T, data: Data) => `Promise<{ finalize: () => Promise<any> }>``}   />
+<MemberInfo kind="method" type={`(state: T, data: Data) => Promise<{ finalize: () => Promise<any> }>`}   />
 ### jumpTo

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

@@ -19,13 +19,13 @@ interface StateMachineConfig<T extends string, Data = undefined> {
 ### transitions
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<T>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><T>`}   />
 Defines the available states of the state machine as well as the permitted
 transitions from one state to another.
 ### onTransitionStart
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<T, Data>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><T, Data>`}   />
 Called before a transition takes place. If the function resolves to `false` or a string, then the transition
 will be cancelled. In the case of a string, the string (error message) will be forwarded to the onError handler.
@@ -34,12 +34,12 @@ If this function returns a value resolving to `true` or `void` (no return value)
 will be permitted.
 ### onTransitionEnd
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<T, Data>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><T, Data>`}   />
 Called after a transition has taken place.
 ### onError
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<T>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><T>`}   />
 Called when a transition is prevented and the `onTransitionStart` handler has returned an
 error message.

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

@@ -31,7 +31,7 @@ interface TaxLineCalculationStrategy extends InjectableStrategy {
 ### calculate
-<MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/tax/tax-line-calculation-strategy#calculatetaxlinesargs'>CalculateTaxLinesArgs</a>) => `TaxLine[] | Promise<TaxLine[]>``}   />
+<MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/tax/tax-line-calculation-strategy#calculatetaxlinesargs'>CalculateTaxLinesArgs</a>) => TaxLine[] | Promise<TaxLine[]>`}   />
 This method is called when calculating the Order prices. Since it will be called
 whenever an Order is modified in some way (adding/removing items, applying promotions,

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

@@ -41,7 +41,7 @@ interface TaxZoneStrategy extends InjectableStrategy {
 ### determineTaxZone
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, zones: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>[], channel: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>, order?: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>` | Promise<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`> | undefined``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, zones: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>[], channel: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>, order?: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | Promise<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>> | undefined`}   />

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

@@ -26,7 +26,7 @@ interface WrappedMethodArgs {
 The instance of the class which is being instrumented.
 ### target
-<MemberInfo kind="property" type={``Type<any>``}   />
+<MemberInfo kind="property" type={`Type<any>`}   />
 The class which is being instrumented.
 ### methodName
@@ -41,7 +41,7 @@ The name of the method which is being instrumented.
 The arguments which are passed to the method.
 ### applyOriginalFunction
-<MemberInfo kind="property" type={``() => any | Promise<any>``}   />
+<MemberInfo kind="property" type={`() => any | Promise<any>`}   />
 A function which applies the original method and returns the result.
 This is used to call the original method after the instrumentation has

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

@@ -24,5 +24,5 @@ Parameters
 ### testFn
-<MemberInfo kind="parameter" type={``(input: T) => boolean``} />
+<MemberInfo kind="parameter" type={`(input: T) => boolean`} />

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

@@ -38,5 +38,5 @@ Parameters
 ### config
-<MemberInfo kind="parameter" type={``Required<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>``} />
+<MemberInfo kind="parameter" type={`Required<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />

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

@@ -43,7 +43,7 @@ class ErrorResultGuard<T> {
 ### constructor
-<MemberInfo kind="method" type={`(testFn: `(input: T) => boolean`) => ErrorResultGuard`}   />
+<MemberInfo kind="method" type={`(testFn: (input: T) => boolean) => ErrorResultGuard`}   />
 ### isSuccess

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

@@ -18,5 +18,5 @@ Parameters
 ### initializer
-<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/testing/test-db-initializer#testdbinitializer'>TestDbInitializer</a>`<any>``} />
+<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/testing/test-db-initializer#testdbinitializer'>TestDbInitializer</a><any>`} />

package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx CHANGED Viewed

@@ -30,7 +30,7 @@ class SimpleGraphQLClient {
 ### constructor
-<MemberInfo kind="method" type={`(vendureConfig: `Required<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>`, apiUrl: string = '') => SimpleGraphQLClient`}   />
+<MemberInfo kind="method" type={`(vendureConfig: Required<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>, apiUrl: string = '') => SimpleGraphQLClient`}   />
 ### setAuthToken
@@ -50,19 +50,19 @@ Sets the authToken to be used in each GraphQL request.
 Returns the authToken currently being used.
 ### query
-<MemberInfo kind="method" type={`(query: `DocumentNode | TypedDocumentNode<T, V>`, variables?: V, queryParams?: QueryParams) => `Promise<T>``}   />
+<MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, queryParams?: QueryParams) => Promise<T>`}   />
 Performs both query and mutation operations.
 ### fetch
-<MemberInfo kind="method" type={`(url: string, options: RequestInit = {}) => `Promise<Response>``}   />
+<MemberInfo kind="method" type={`(url: string, options: RequestInit = {}) => Promise<Response>`}   />
 Performs a raw HTTP request to the given URL, but also includes the authToken & channelToken
 headers if they have been set. Useful for testing non-GraphQL endpoints, e.g. for plugins
 which make use of REST controllers.
 ### queryStatus
-<MemberInfo kind="method" type={`(query: DocumentNode, variables?: V) => `Promise<number>``}   />
+<MemberInfo kind="method" type={`(query: DocumentNode, variables?: V) => Promise<number>`}   />
 Performs a query or mutation and returns the resulting status code.
 ### asUserWithCredentials
@@ -82,7 +82,7 @@ Logs in as the SuperAdmin user.
 Logs out so that the client is then treated as an anonymous user.
 ### fileUploadMutation
-<MemberInfo kind="method" type={`(options: `{         mutation: DocumentNode;         filePaths: string[];         mapVariables: (filePaths: string[]) => any;     }`) => `Promise<any>``}   />
+<MemberInfo kind="method" type={`(options: {         mutation: DocumentNode;         filePaths: string[];         mapVariables: (filePaths: string[]) => any;     }) => Promise<any>`}   />
 Perform a file upload mutation.

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

@@ -32,7 +32,7 @@ interface TestDbInitializer<T extends BaseConnectionOptions> {
 ### init
-<MemberInfo kind="method" type={`(testFileName: string, connectionOptions: T) => `Promise<T>``}   />
+<MemberInfo kind="method" type={`(testFileName: string, connectionOptions: T) => Promise<T>`}   />
 Responsible for creating a database for the current test suite.
 Typically, this method will:
@@ -42,12 +42,12 @@ Typically, this method will:
 * mutate the `connetionOptions` object to point to that new database
 ### populate
-<MemberInfo kind="method" type={`(populateFn: `() => Promise<void>`) => `Promise<void>``}   />
+<MemberInfo kind="method" type={`(populateFn: () => Promise<void>) => Promise<void>`}   />
 Execute the populateFn to populate your database.
 ### destroy
-<MemberInfo kind="method" type={`() => `void | Promise<void>``}   />
+<MemberInfo kind="method" type={`() => void | Promise<void>`}   />
 Clean up any resources used during the init() phase (i.e. close open DB connections)

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

@@ -25,12 +25,12 @@ class TestServer {
 ### constructor
-<MemberInfo kind="method" type={`(vendureConfig: `Required<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>`) => TestServer`}   />
+<MemberInfo kind="method" type={`(vendureConfig: Required<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>) => TestServer`}   />
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/testing/test-server-options#testserveroptions'>TestServerOptions</a>) => `Promise<void>``}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/testing/test-server-options#testserveroptions'>TestServerOptions</a>) => Promise<void>`}   />
 Bootstraps an instance of Vendure server and populates the database according to the options
 passed in. Should be called in the `beforeAll` function.