@vendure/core 2.1.0-next.3 → 2.1.0-next.5

package/dist/api/common/request-context.d.ts

@@ -27,7 +27,7 @@ export type SerializedRequestContext = {
  * presence of the RequestContext object in order to correctly handle per-request database transactions.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Query()
  * myQuery(\@Ctx() ctx: RequestContext) {
  *   return this.myService.getData(ctx);

package/dist/api/common/request-context.js

@@ -17,7 +17,7 @@ const channel_entity_1 = require("../../entity/channel/channel.entity");
  * presence of the RequestContext object in order to correctly handle per-request database transactions.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Query()
  * myQuery(\@Ctx() ctx: RequestContext) {
  *   return this.myService.getData(ctx);

package/dist/api/decorators/allow.decorator.d.ts

@@ -18,10 +18,10 @@ export declare const PERMISSIONS_METADATA_KEY = "__permissions__";
  * to give access to certain resources to potentially un-authenticated users. For this reason, any operation decorated with this permission
  * will always have an anonymous session created if no session is currently in progress.
  *
- * For more information see [Understanding Permission.Owner](/docs/typescript-api/common/permission/#understanding-permissionowner).
+ * For more information see [Understanding Permission.Owner](/reference/typescript-api/common/permission/#understanding-permissionowner).
  *
  * @example
- * ```TypeScript
+ * ```ts
  *  \@Allow(Permission.SuperAdmin)
  *  \@Query()
  *  getAdministrators() {

package/dist/api/decorators/allow.decorator.js

@@ -21,10 +21,10 @@ exports.PERMISSIONS_METADATA_KEY = '__permissions__';
  * to give access to certain resources to potentially un-authenticated users. For this reason, any operation decorated with this permission
  * will always have an anonymous session created if no session is currently in progress.
  *
- * For more information see [Understanding Permission.Owner](/docs/typescript-api/common/permission/#understanding-permissionowner).
+ * For more information see [Understanding Permission.Owner](/reference/typescript-api/common/permission/#understanding-permissionowner).
  *
  * @example
- * ```TypeScript
+ * ```ts
  *  \@Allow(Permission.SuperAdmin)
  *  \@Query()
  *  getAdministrators() {

package/dist/api/decorators/api.decorator.d.ts

@@ -7,7 +7,7 @@
  * Returns a string of type {@link ApiType}.
  *
  * @example
- * ```TypeScript
+ * ```ts
  *  \@Query()
  *  getAdministrators(\@Api() apiType: ApiType) {
  *    if (apiType === 'admin') {

package/dist/api/decorators/api.decorator.js

@@ -12,7 +12,7 @@ const get_api_type_1 = require("../common/get-api-type");
  * Returns a string of type {@link ApiType}.
  *
  * @example
- * ```TypeScript
+ * ```ts
  *  \@Query()
  *  getAdministrators(\@Api() apiType: ApiType) {
  *    if (apiType === 'admin') {

package/dist/api/decorators/relations.decorator.d.ts

@@ -23,7 +23,7 @@ export type FieldsDecoratorConfig<T extends VendureEntity> = Type<T> | {
  * not include many deep nested relations.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Query()
  * \@Allow(Permission.ReadOrder)
  * orders(
@@ -92,7 +92,7 @@ export type FieldsDecoratorConfig<T extends VendureEntity> = Type<T> | {
  * use the decorator like this:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Relations({ entity: Order, depth: 2 }) relations: RelationPaths<Order>,
  * ```
  *
@@ -105,7 +105,7 @@ export type FieldsDecoratorConfig<T extends VendureEntity> = Type<T> | {
  * PaginatedList query rather than a simple array.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Relations({ entity: Collection, omit: ['productVariant'] }) relations: RelationPaths<Collection>,
  * ```
  *

package/dist/api/decorators/relations.decorator.js

@@ -27,7 +27,7 @@ const cache = new index_1.TtlCache({ cacheSize: 500, ttl: 5 * 60 * 1000 });
  * not include many deep nested relations.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Query()
  * \@Allow(Permission.ReadOrder)
  * orders(
@@ -96,7 +96,7 @@ const cache = new index_1.TtlCache({ cacheSize: 500, ttl: 5 * 60 * 1000 });
  * use the decorator like this:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Relations({ entity: Order, depth: 2 }) relations: RelationPaths<Order>,
  * ```
  *
@@ -109,7 +109,7 @@ const cache = new index_1.TtlCache({ cacheSize: 500, ttl: 5 * 60 * 1000 });
  * PaginatedList query rather than a simple array.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Relations({ entity: Collection, omit: ['productVariant'] }) relations: RelationPaths<Collection>,
  * ```
  *

package/dist/api/decorators/request-context.decorator.d.ts

@@ -4,7 +4,7 @@
  * request object.
  *
  * @example
- * ```TypeScript
+ * ```ts
  *  \@Query()
  *  getAdministrators(\@Ctx() ctx: RequestContext) {
  *      // ...

package/dist/api/decorators/request-context.decorator.js

@@ -9,7 +9,7 @@ const constants_1 = require("../../common/constants");
  * request object.
  *
  * @example
- * ```TypeScript
+ * ```ts
  *  \@Query()
  *  getAdministrators(\@Ctx() ctx: RequestContext) {
  *      // ...

package/dist/api/decorators/transaction.decorator.d.ts

@@ -6,7 +6,7 @@ export declare const TRANSACTION_MODE_METADATA_KEY = "__transaction_mode__";
  * methods must them be used.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * // in a GraphQL resolver file
  *
  * \@Transaction('manual')
@@ -50,7 +50,7 @@ export type TransactionIsolationLevel = 'READ UNCOMMITTED' | 'READ COMMITTED' |
  * error is thrown.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * // in a GraphQL resolver file
  *
  * \@Transaction()

package/dist/api/decorators/transaction.decorator.js

@@ -17,7 +17,7 @@ exports.TRANSACTION_ISOLATION_LEVEL_METADATA_KEY = '__transaction_isolation_leve
  * error is thrown.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * // in a GraphQL resolver file
  *
  * \@Transaction()

package/dist/api/decorators/transaction.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.decorator.js","sourceRoot":"","sources":["../../../src/api/decorators/transaction.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA+E;AAE/E,mFAA+E;AAElE,QAAA,6BAA6B,GAAG,sBAAsB,CAAC;AA6BvD,QAAA,wCAAwC,GAAG,iCAAiC,CAAC;AAa1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,MAAM,WAAW,GAAG,CAAC,kBAAmC,MAAM,EAAE,yBAAqD,EAAE,EAAE;IAC5H,OAAO,IAAA,wBAAe,EAClB,IAAA,oBAAW,EAAC,qCAA6B,EAAE,eAAe,CAAC,EAC3D,IAAA,oBAAW,EAAC,gDAAwC,EAAE,yBAAyB,CAAC,EAChF,IAAA,wBAAe,EAAC,gDAAsB,CAAC,CAC1C,CAAC;AACN,CAAC,CAAC;AANW,QAAA,WAAW,eAMtB"}
+{"version":3,"file":"transaction.decorator.js","sourceRoot":"","sources":["../../../src/api/decorators/transaction.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA+E;AAE/E,mFAA+E;AAElE,QAAA,6BAA6B,GAAG,sBAAsB,CAAC;AA6BvD,QAAA,wCAAwC,GAAG,iCAAiC,CAAC;AAiB1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,MAAM,WAAW,GAAG,CACvB,kBAAmC,MAAM,EACzC,yBAAqD,EACvD,EAAE;IACA,OAAO,IAAA,wBAAe,EAClB,IAAA,oBAAW,EAAC,qCAA6B,EAAE,eAAe,CAAC,EAC3D,IAAA,oBAAW,EAAC,gDAAwC,EAAE,yBAAyB,CAAC,EAChF,IAAA,wBAAe,EAAC,gDAAsB,CAAC,CAC1C,CAAC;AACN,CAAC,CAAC;AATW,QAAA,WAAW,eAStB"}

package/dist/api/middleware/transaction-interceptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-interceptor.js","sourceRoot":"","sources":["../../../src/api/middleware/transaction-interceptor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4F;AAC5F,uCAAyC;AACzC,+BAAsC;AAGtC,sDAAsF;AACtF,8EAA0E;AAC1E,wFAAoF;AACpF,2DAAuD;AACvD,+EAA0K;AAE1K;;;;GAIG;AAEI,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAC/B,YACY,UAAmC,EACnC,kBAAsC,EACtC,SAAoB;QAFpB,eAAU,GAAV,UAAU,CAAyB;QACnC,uBAAkB,GAAlB,kBAAkB,CAAoB;QACtC,cAAS,GAAT,SAAS,CAAW;IAC5B,CAAC;IAEL,SAAS,CAAC,OAAyB,EAAE,IAAiB;QAClD,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,IAAA,4BAAY,EAAC,OAAO,CAAC,CAAC;QACjD,MAAM,GAAG,GAAgC,GAAW,CAAC,+BAAmB,CAAC,CAAC;QAE1E,IAAI,GAAG,EAAE;YACL,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CACtC,qDAA6B,EAC7B,OAAO,CAAC,UAAU,EAAE,CACvB,CAAC;YACF,MAAM,yBAAyB,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAChD,gEAAwC,EACxC,OAAO,CAAC,UAAU,EAAE,CACvB,CAAC;YAEF,OAAO,IAAA,SAAE,EACL,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,CACxC,GAAG,EACH,IAAI,CAAC,EAAE;gBACH,IAAI,CAAC,4BAA4B,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAC;gBAEnE,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;YACzB,CAAC,EACD,eAAe,EACf,yBAAyB,EACzB,IAAI,CAAC,UAAU,CAAC,aAAa,CAChC,CACJ,CAAC;SACL;aAAM;YACH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;SACxB;IACL,CAAC;IAED;;;;;;OAMG;IACH,wDAAwD;IACxD,4BAA4B,CAAC,GAAmB,EAAE,OAAiB,EAAE,GAAQ;QACzE,wDAAwD;QACxD,MAAM,GAAG,GAAkC,GAAG,CAAC,mCAAuB,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;QACrF,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAEtB,GAAG,CAAC,mCAAuB,CAAC,GAAG,GAAG,CAAC;IACvC,CAAC;CACJ,CAAA;AAtDY,sBAAsB;IADlC,IAAA,mBAAU,GAAE;qCAGe,kDAAuB;QACf,wCAAkB;QAC3B,gBAAS;GAJvB,sBAAsB,CAsDlC;AAtDY,wDAAsB"}
+{"version":3,"file":"transaction-interceptor.js","sourceRoot":"","sources":["../../../src/api/middleware/transaction-interceptor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4F;AAC5F,uCAAyC;AACzC,+BAAsC;AAGtC,sDAAsF;AACtF,8EAA0E;AAC1E,wFAAoF;AACpF,2DAAuD;AACvD,+EAK6C;AAE7C;;;;GAIG;AAEI,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAC/B,YACY,UAAmC,EACnC,kBAAsC,EACtC,SAAoB;QAFpB,eAAU,GAAV,UAAU,CAAyB;QACnC,uBAAkB,GAAlB,kBAAkB,CAAoB;QACtC,cAAS,GAAT,SAAS,CAAW;IAC7B,CAAC;IAEJ,SAAS,CAAC,OAAyB,EAAE,IAAiB;QAClD,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,IAAA,4BAAY,EAAC,OAAO,CAAC,CAAC;QACjD,MAAM,GAAG,GAAgC,GAAW,CAAC,+BAAmB,CAAC,CAAC;QAC1E,IAAI,GAAG,EAAE;YACL,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CACtC,qDAA6B,EAC7B,OAAO,CAAC,UAAU,EAAE,CACvB,CAAC;YACF,MAAM,yBAAyB,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAChD,gEAAwC,EACxC,OAAO,CAAC,UAAU,EAAE,CACvB,CAAC;YAEF,OAAO,IAAA,SAAE,EACL,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,CACxC,GAAG,EACH,IAAI,CAAC,EAAE;gBACH,IAAI,CAAC,4BAA4B,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAC;gBAEnE,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;YACzB,CAAC,EACD,eAAe,EACf,yBAAyB,EACzB,IAAI,CAAC,UAAU,CAAC,aAAa,CAChC,CACJ,CAAC;SACL;aAAM;YACH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;SACxB;IACL,CAAC;IAED;;;;;;OAMG;IACH,wDAAwD;IACxD,4BAA4B,CAAC,GAAmB,EAAE,OAAiB,EAAE,GAAQ;QACzE,wDAAwD;QACxD,MAAM,GAAG,GAAkC,GAAG,CAAC,mCAAuB,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;QACrF,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAEtB,GAAG,CAAC,mCAAuB,CAAC,GAAG,GAAG,CAAC;IACvC,CAAC;CACJ,CAAA;AArDY,sBAAsB;IADlC,IAAA,mBAAU,GAAE;qCAGe,kDAAuB;QACf,wCAAkB;QAC3B,gBAAS;GAJvB,sBAAsB,CAqDlC;AArDY,wDAAsB"}

package/dist/bootstrap.d.ts

@@ -8,7 +8,7 @@ export type VendureBootstrapFunction = (config: VendureConfig) => Promise<INestA
  * Bootstraps the Vendure server. This is the entry point to the application.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { bootstrap } from '\@vendure/core';
  * import { config } from './vendure-config';
  *
@@ -25,10 +25,10 @@ export declare function bootstrap(userConfig: Partial<VendureConfig>): Promise<I
  * NestJs [standalone application](https://docs.nestjs.com/standalone-applications) as well as convenience
  * methods for starting the job queue and health check server.
  *
- * Read more about the [Vendure Worker]({{< relref "vendure-worker" >}}).
+ * Read more about the [Vendure Worker](/guides/developer-guide/worker-job-queue/).
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { bootstrapWorker } from '\@vendure/core';
  * import { config } from './vendure-config';
  *

package/dist/bootstrap.js

@@ -26,7 +26,7 @@ const vendure_worker_1 = require("./worker/vendure-worker");
  * Bootstraps the Vendure server. This is the entry point to the application.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { bootstrap } from '\@vendure/core';
  * import { config } from './vendure-config';
  *
@@ -76,10 +76,10 @@ exports.bootstrap = bootstrap;
  * NestJs [standalone application](https://docs.nestjs.com/standalone-applications) as well as convenience
  * methods for starting the job queue and health check server.
  *
- * Read more about the [Vendure Worker]({{< relref "vendure-worker" >}}).
+ * Read more about the [Vendure Worker](/guides/developer-guide/worker-job-queue/).
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { bootstrapWorker } from '\@vendure/core';
  * import { config } from './vendure-config';
  *

package/dist/common/configurable-operation.d.ts

@@ -10,7 +10,7 @@ import { InjectableStrategy } from './types/injectable-strategy';
  * component.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * const title: LocalizedStringArray = [
  *   { languageCode: LanguageCode.en, value: 'English Title' },
  *   { languageCode: LanguageCode.de, value: 'German Title' },
@@ -52,7 +52,7 @@ export type ConfigArgDef<T extends ConfigArgType> = T extends 'string' ? ConfigA
  * Each argument has a data type, which must be one of {@link ConfigArgType}.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * {
  *   apiKey: { type: 'string' },
  *   maxRetries: { type: 'int' },
@@ -65,7 +65,7 @@ export type ConfigArgDef<T extends ConfigArgType> = T extends 'string' ? ConfigA
  * data type. For example, if you want to store an array of strings:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * {
  *   aliases: {
  *     type: 'string',
@@ -80,7 +80,7 @@ export type ConfigArgDef<T extends ConfigArgType> = T extends 'string' ? ConfigA
  * When not set, a default input component is used appropriate to the data type.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * {
  *   operator: {
  *     type: 'string',
@@ -211,7 +211,7 @@ export interface ConfigurableOperationDefOptions<T extends ConfigArgs> extends I
  * Here's an example of a ShippingCalculator that injects a service which has been defined in a plugin:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { Injector, ShippingCalculator } from '\@vendure/core';
  * import { ShippingRatesService } from './shipping-rates.service';
  *

package/dist/common/configurable-operation.js

@@ -44,7 +44,7 @@ const errors_1 = require("./error/errors");
  * Here's an example of a ShippingCalculator that injects a service which has been defined in a plugin:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { Injector, ShippingCalculator } from '\@vendure/core';
  * import { ShippingRatesService } from './shipping-rates.service';
  *

package/dist/common/error/error-result.d.ts

@@ -9,7 +9,7 @@ export type GraphQLErrorResult = {
  * plus one or more ErrorResult types) and returns a union of _just_ the ErrorResult types.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * type UpdateOrderItemsResult = Order | OrderModificationError | OrderLimitError | NegativeQuantityError;
  *
  * type T1 = JustErrorResults<UpdateOrderItemsResult>;
@@ -27,7 +27,7 @@ export type JustErrorResults<T extends GraphQLErrorResult | U, U = any> = Exclud
  * we use this type to substitute them.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * type UpdateOrderItemsResult = Order | OrderModificationError | OrderLimitError | NegativeQuantityError;
  * type T1 = ErrorResultUnion<UpdateOrderItemsResult, VendureEntityOrder>;
  * // T1 = VendureEntityOrder | OrderModificationError | OrderLimitError | NegativeQuantityError;

package/dist/common/error/error-result.js.map

@@ -1 +1 @@
-{"version":3,"file":"error-result.js","sourceRoot":"","sources":["../../../src/common/error/error-result.ts"],"names":[],"mappings":";;;AAmDA,SAAgB,oBAAoB,CAChC,KAA6B;IAE7B,OAAO,CACH,KAAK;QACL,CAAC,CAAC,CACI,KAAwC,CAAC,SAAS;YAClD,KAAwC,CAAC,OAAO,IAAI,IAAI,CAC7D;QACA,KAAa,CAAC,UAAU,CAC5B,CAAC;AACN,CAAC;AAXD,oDAWC"}
+{"version":3,"file":"error-result.js","sourceRoot":"","sources":["../../../src/common/error/error-result.ts"],"names":[],"mappings":";;;AAmDA,SAAgB,oBAAoB,CAChC,KAA6B;IAE7B,OAAO,CACH,KAAK;QACL,CAAC,CAAC,CACG,KAAuC,CAAC,SAAS;YACjD,KAAuC,CAAC,OAAO,IAAI,IAAI,CAC3D;QACA,KAAa,CAAC,UAAU,CAC5B,CAAC;AACN,CAAC;AAXD,oDAWC"}

package/dist/common/finite-state-machine/types.d.ts

@@ -5,7 +5,7 @@ import { Observable } from 'rxjs';
  * on {@link FSM}.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * type LightColor = 'Green' | 'Amber' | 'Red';
  *
  * const trafficLightTransitions: Transitions<LightColor> = {

package/dist/common/permission-definition.d.ts

@@ -50,14 +50,14 @@ export type PermissionMetadata = Required<PermissionDefinitionConfig>;
  * **Note:** To define CRUD permissions, use the {@link CrudPermissionDefinition}.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * export const sync = new PermissionDefinition({
  *   name: 'SyncInventory',
  *   description: 'Allows syncing stock levels via Admin API'
  * });
  * ```
  *
- * ```TypeScript
+ * ```ts
  * const config: VendureConfig = {
  *   authOptions: {
  *     customPermissions: [sync],
@@ -65,7 +65,7 @@ export type PermissionMetadata = Required<PermissionDefinitionConfig>;
  * }
  * ```
  *
- * ```TypeScript
+ * ```ts
  * \@Resolver()
  * export class ExternalSyncResolver {
  *
@@ -98,11 +98,11 @@ export declare class PermissionDefinition {
  * 4 Permissions: 'CreateWishlist', 'ReadWishlist', 'UpdateWishlist' & 'DeleteWishlist'.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * export const wishlist = new CrudPermissionDefinition('Wishlist');
  * ```
  *
- * ```TypeScript
+ * ```ts
  * const config: VendureConfig = {
  *   authOptions: {
  *     customPermissions: [wishlist],
@@ -110,7 +110,7 @@ export declare class PermissionDefinition {
  * }
  * ```
  *
- * ```TypeScript
+ * ```ts
  * \@Resolver()
  * export class WishlistResolver {
  *

package/dist/common/permission-definition.js

@@ -9,14 +9,14 @@ exports.CrudPermissionDefinition = exports.PermissionDefinition = void 0;
  * **Note:** To define CRUD permissions, use the {@link CrudPermissionDefinition}.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * export const sync = new PermissionDefinition({
  *   name: 'SyncInventory',
  *   description: 'Allows syncing stock levels via Admin API'
  * });
  * ```
  *
- * ```TypeScript
+ * ```ts
  * const config: VendureConfig = {
  *   authOptions: {
  *     customPermissions: [sync],
@@ -24,7 +24,7 @@ exports.CrudPermissionDefinition = exports.PermissionDefinition = void 0;
  * }
  * ```
  *
- * ```TypeScript
+ * ```ts
  * \@Resolver()
  * export class ExternalSyncResolver {
  *
@@ -71,11 +71,11 @@ exports.PermissionDefinition = PermissionDefinition;
  * 4 Permissions: 'CreateWishlist', 'ReadWishlist', 'UpdateWishlist' & 'DeleteWishlist'.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * export const wishlist = new CrudPermissionDefinition('Wishlist');
  * ```
  *
- * ```TypeScript
+ * ```ts
  * const config: VendureConfig = {
  *   authOptions: {
  *     customPermissions: [wishlist],
@@ -83,7 +83,7 @@ exports.PermissionDefinition = PermissionDefinition;
  * }
  * ```
  *
- * ```TypeScript
+ * ```ts
  * \@Resolver()
  * export class WishlistResolver {
  *

package/dist/common/types/common-types.d.ts

@@ -156,7 +156,7 @@ export type MiddlewareHandler = Type<any> | Function;
  * `PayloadTooLargeError`. To increase this limit, we can manually configure the body-parser middleware:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { VendureConfig } from '\@vendure/core';
  * import { json } from 'body-parser';
  *
@@ -170,6 +170,7 @@ export type MiddlewareHandler = Type<any> | Function;
  *     }],
  *   },
  * };
+ * ```
  *
  * @docsCategory Common
  */

package/dist/common/types/entity-relation-paths.d.ts

@@ -5,7 +5,7 @@ import { VendureEntity } from '../../entity/base/base.entity';
  * It works to 2 levels deep.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * type T1 = EntityRelationPaths<Product>;
  * ```
  * In the above example, the type `T1` will be a string union of all relations of the

package/dist/common/types/injectable-strategy.d.ts

@@ -15,7 +15,7 @@ export interface InjectableStrategy {
      * main server and the worker processes.
      *
      * @example
-     * ```TypeScript
+     * ```ts
      * async init(injector: Injector) {
      *   const myService = injector.get(MyService);
      *   await myService.doSomething();

package/dist/common/utils.d.ts

@@ -49,7 +49,7 @@ export declare function awaitPromiseOrObservable<T>(value: T | Promise<T> | Obse
  * an Observable but also want to work with async (Promise-returning) code.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Controller()
  * export class MyWorkerController {
  *

package/dist/common/utils.js

@@ -84,7 +84,7 @@ exports.awaitPromiseOrObservable = awaitPromiseOrObservable;
  * an Observable but also want to work with async (Promise-returning) code.
  *
  * @example
- * ```TypeScript
+ * ```ts
  * \@Controller()
  * export class MyWorkerController {
  *

package/dist/config/asset-import-strategy/asset-import-strategy.d.ts

@@ -11,6 +11,13 @@ import { InjectableStrategy } from '../../common/types/injectable-strategy';
  *
  * A custom strategy could be created which could e.g. get the asset file from an S3 bucket.
  *
+ * :::info
+ *
+ * This is configured via the `importExportOptions.assetImportStrategy` property of
+ * your VendureConfig.
+ *
+ * :::
+ *
  * @since 1.7.0
  * @docsCategory import-export
  */

package/dist/config/asset-naming-strategy/asset-naming-strategy.d.ts

@@ -5,6 +5,13 @@ import { InjectableStrategy } from '../../common/types/injectable-strategy';
  * The AssetNamingStrategy determines how file names are generated based on the uploaded source file name,
  * as well as how to handle naming conflicts.
  *
+ * :::info
+ *
+ * This is configured via the `assetOptions.assetNamingStrategy` property of
+ * your VendureConfig.
+ *
+ * :::
+ *
  * @docsCategory assets
  */
 export interface AssetNamingStrategy extends InjectableStrategy {

package/dist/config/asset-preview-strategy/asset-preview-strategy.d.ts

@@ -6,10 +6,18 @@ import { InjectableStrategy } from '../../common/types/injectable-strategy';
  * The AssetPreviewStrategy determines how preview images for assets are created. For image
  * assets, this would usually typically involve resizing to sensible dimensions. Other file types
  * could be previewed in a variety of ways, e.g.:
+ *
  * - waveform images generated for audio files
  * - preview images generated for pdf documents
  * - watermarks added to preview images
  *
+ * :::info
+ *
+ * This is configured via the `assetOptions.assetPreviewStrategy` property of
+ * your VendureConfig.
+ *
+ * :::
+ *
  * @docsCategory assets
  */
 export interface AssetPreviewStrategy extends InjectableStrategy {

package/dist/config/asset-storage-strategy/asset-storage-strategy.d.ts

@@ -8,6 +8,13 @@ import { InjectableStrategy } from '../../common/types/injectable-strategy';
  * The AssetPersistenceStrategy determines how Asset files are physically stored
  * and retrieved.
  *
+ * :::info
+ *
+ * This is configured via the `assetOptions.assetStorageStrategy` property of
+ * your VendureConfig.
+ *
+ * :::
+ *
  * @docsCategory assets
  */
 export interface AssetStorageStrategy extends InjectableStrategy {

package/dist/config/auth/authentication-strategy.d.ts

@@ -7,7 +7,14 @@ import { User } from '../../entity/user/user.entity';
  * An AuthenticationStrategy defines how a User (which can be a Customer in the Shop API or
  * and Administrator in the Admin API) may be authenticated.
  *
- * Real-world examples can be found in the [Authentication guide](/docs/developer-guide/authentication/).
+ * Real-world examples can be found in the [Authentication guide](/guides/core-concepts/auth/).
+ *
+ * :::info
+ *
+ * This is configured via the `authOptions.shopAuthenticationStrategy` and `authOptions.adminAuthenticationStrategy`
+ * properties of your VendureConfig.
+ *
+ * :::
  *
  * @docsCategory auth
  */
@@ -27,7 +34,7 @@ export interface AuthenticationStrategy<Data = unknown> extends InjectableStrate
      * @example
      * For example, given the following:
      *
-     * ```TypeScript
+     * ```ts
      * defineInputType() {
      *   return gql`
      *      input MyAuthInput {

package/dist/config/auth/password-hashing-strategy.d.ts

@@ -3,6 +3,13 @@ import { InjectableStrategy } from '../../common/types/injectable-strategy';
  * @description
  * Defines how user passwords get hashed when using the {@link NativeAuthenticationStrategy}.
  *
+ * :::info
+ *
+ * This is configured via the `authOptions.passwordHashingStrategy` property of
+ * your VendureConfig.
+ *
+ * :::
+ *
  * @docsCategory auth
  * @since 1.3.0
  */

package/dist/config/auth/password-validation-strategy.d.ts

@@ -5,6 +5,13 @@ import { InjectableStrategy } from '../../common/types/injectable-strategy';
  * Defines validation to apply to new password (when creating an account or updating an existing account's
  * password when using the {@link NativeAuthenticationStrategy}.
  *
+ * :::info
+ *
+ * This is configured via the `authOptions.passwordValidationStrategy` property of
+ * your VendureConfig.
+ *
+ * :::
+ *
  * @docsCategory auth
  * @since 1.5.0
  */

package/dist/config/catalog/collection-filter.d.ts

@@ -18,7 +18,7 @@ export interface CollectionFilterConfig<T extends ConfigArgs> extends Configurab
  * Here's a simple example of a custom CollectionFilter:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { CollectionFilter, LanguageCode } from '\@vendure/core';
  *
  * export const skuCollectionFilter = new CollectionFilter({

package/dist/config/catalog/collection-filter.js

@@ -15,7 +15,7 @@ const configurable_operation_1 = require("../../common/configurable-operation");
  * Here's a simple example of a custom CollectionFilter:
  *
  * @example
- * ```TypeScript
+ * ```ts
  * import { CollectionFilter, LanguageCode } from '\@vendure/core';
  *
  * export const skuCollectionFilter = new CollectionFilter({

package/dist/config/catalog/product-variant-price-calculation-strategy.d.ts

@@ -7,6 +7,13 @@ import { Zone } from '../../entity/zone/zone.entity';
  * @description
  * Defines how ProductVariant are calculated based on the input price, tax zone and current request context.
  *
+ * :::info
+ *
+ * This is configured via the `catalogOptions.productVariantPriceCalculationStrategy` property of
+ * your VendureConfig.
+ *
+ * :::
+ *
  * @docsCategory  products & stock
  * @docsPage ProductVariantPriceCalculationStrategy
  */

package/dist/config/catalog/product-variant-price-selection-strategy.d.ts

@@ -5,6 +5,13 @@ import { ProductVariantPrice } from '../../entity/product-variant/product-varian
  * @description
  * The strategy for selecting the price for a ProductVariant in a given Channel.
  *
+ * :::info
+ *
+ * This is configured via the `catalogOptions.productVariantPriceSelectionStrategy` property of
+ * your VendureConfig.
+ *
+ * :::
+ *
  * @docsCategory configuration
  * @docsPage ProductVariantPriceSelectionStrategy
  * @docsWeight 0