@vendure/core 2.0.0-next.2 → 2.0.0-next.21

package/dist/config/shipping-method/shipping-calculator.d.ts

@@ -1,7 +1,7 @@
 import { ConfigArg } from '@vendure/common/lib/generated-types';
 import { RequestContext } from '../../api/common/request-context';
 import { ConfigArgs, ConfigArgValues, ConfigurableOperationDef, ConfigurableOperationDefOptions } from '../../common/configurable-operation';
-import { Order } from '../../entity/order/order.entity';
+import { ShippingMethod, Order } from '../../entity';
 export interface ShippingCalculatorConfig<T extends ConfigArgs> extends ConfigurableOperationDefOptions<T> {
     calculate: CalculateShippingFn<T>;
 }
@@ -46,7 +46,7 @@ export declare class ShippingCalculator<T extends ConfigArgs = ConfigArgs> exten
      *
      * @internal
      */
-    calculate(ctx: RequestContext, order: Order, args: ConfigArg[]): CalculateShippingFnResult;
+    calculate(ctx: RequestContext, order: Order, args: ConfigArg[], method: ShippingMethod): CalculateShippingFnResult;
 }
 /**
  * @description
@@ -90,4 +90,4 @@ export declare type CalculateShippingFnResult = ShippingCalculationResult | Prom
  * @docsCategory shipping
  * @docsPage ShippingCalculator
  */
-export declare type CalculateShippingFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>) => CalculateShippingFnResult;
+export declare type CalculateShippingFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>, method: ShippingMethod) => CalculateShippingFnResult;

package/dist/config/shipping-method/shipping-calculator.js

@@ -45,8 +45,8 @@ class ShippingCalculator extends configurable_operation_1.ConfigurableOperationD
      *
      * @internal
      */
-    calculate(ctx, order, args) {
-        return this.calculateFn(ctx, order, this.argsArrayToHash(args));
+    calculate(ctx, order, args, method) {
+        return this.calculateFn(ctx, order, this.argsArrayToHash(args), method);
     }
 }
 exports.ShippingCalculator = ShippingCalculator;

package/dist/config/shipping-method/shipping-calculator.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-calculator.js","sourceRoot":"","sources":["../../../src/config/shipping-method/shipping-calculator.ts"],"names":[],"mappings":";;;AAGA,gFAK6C;AAO7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,kBAAsD,SAAQ,iDAA2B;IAGlG,YAAY,MAAmC;QAC3C,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,GAAmB,EAAE,KAAY,EAAE,IAAiB;QAC1D,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;CACJ;AAjBD,gDAiBC"}
+{"version":3,"file":"shipping-calculator.js","sourceRoot":"","sources":["../../../src/config/shipping-method/shipping-calculator.ts"],"names":[],"mappings":";;;AAGA,gFAK6C;AAO7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,kBAAsD,SAAQ,iDAA2B;IAGlG,YAAY,MAAmC;QAC3C,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,GAAmB,EAAE,KAAY,EAAE,IAAiB,EAAE,MAAsB;QAClF,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;CACJ;AAjBD,gDAiBC"}

package/dist/config/shipping-method/shipping-eligibility-checker.d.ts

@@ -2,7 +2,7 @@ import { ConfigArg } from '@vendure/common/lib/generated-types';
 import { Json } from '@vendure/common/lib/shared-types';
 import { RequestContext } from '../../api/common/request-context';
 import { ConfigArgs, ConfigArgValues, ConfigurableOperationDef, ConfigurableOperationDefOptions } from '../../common/configurable-operation';
-import { Order } from '../../entity/order/order.entity';
+import { ShippingMethod, Order } from '../../entity';
 /**
  * @description
  * Configuration passed into the constructor of a {@link ShippingEligibilityChecker} to
@@ -47,7 +47,7 @@ export declare class ShippingEligibilityChecker<T extends ConfigArgs = ConfigArg
      *
      * @internal
      */
-    check(ctx: RequestContext, order: Order, args: ConfigArg[]): Promise<boolean>;
+    check(ctx: RequestContext, order: Order, args: ConfigArg[], method: ShippingMethod): Promise<boolean>;
     /**
      * Determines whether the check function needs to be run, based on the presence and
      * result of any defined `shouldRunCheckFn`.
@@ -66,7 +66,7 @@ export declare class ShippingEligibilityChecker<T extends ConfigArgs = ConfigArg
  *
  * @docsCategory shipping
  */
-export declare type CheckShippingEligibilityCheckerFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>) => boolean | Promise<boolean>;
+export declare type CheckShippingEligibilityCheckerFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>, method: ShippingMethod) => boolean | Promise<boolean>;
 /**
  * @description
  * An optional method which is used to decide whether to run the `check()` function.
@@ -95,4 +95,4 @@ export declare type CheckShippingEligibilityCheckerFn<T extends ConfigArgs> = (c
  *
  * @docsCategory shipping
  */
-export declare type ShouldRunCheckFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>) => Json | Promise<Json>;
+export declare type ShouldRunCheckFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>, method: ShippingMethod) => Json | Promise<Json>;

package/dist/config/shipping-method/shipping-eligibility-checker.js

@@ -39,20 +39,20 @@ class ShippingEligibilityChecker extends configurable_operation_1.ConfigurableOp
      *
      * @internal
      */
-    async check(ctx, order, args) {
-        const shouldRunCheck = await this.shouldRunCheck(ctx, order, args);
-        return shouldRunCheck ? this.checkFn(ctx, order, this.argsArrayToHash(args)) : true;
+    async check(ctx, order, args, method) {
+        const shouldRunCheck = await this.shouldRunCheck(ctx, order, args, method);
+        return shouldRunCheck ? this.checkFn(ctx, order, this.argsArrayToHash(args), method) : true;
     }
     /**
      * Determines whether the check function needs to be run, based on the presence and
      * result of any defined `shouldRunCheckFn`.
      */
-    async shouldRunCheck(ctx, order, args) {
+    async shouldRunCheck(ctx, order, args, method) {
         var _a;
         if (typeof this.shouldRunCheckFn === 'function') {
             const cacheKey = (_a = ctx.session) === null || _a === void 0 ? void 0 : _a.id;
             if (cacheKey) {
-                const checkResult = await this.shouldRunCheckFn(ctx, order, this.argsArrayToHash(args));
+                const checkResult = await this.shouldRunCheckFn(ctx, order, this.argsArrayToHash(args), method);
                 const checkResultHash = (0, crypto_1.createHash)('sha1')
                     .update(JSON.stringify(checkResult))
                     .digest('base64');

package/dist/config/shipping-method/shipping-eligibility-checker.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-eligibility-checker.js","sourceRoot":"","sources":["../../../src/config/shipping-method/shipping-eligibility-checker.ts"],"names":[],"mappings":";;;AAEA,mCAAoC;AAGpC,gFAK6C;AAC7C,sDAAkD;AAelD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,0BAA8D,SAAQ,iDAElF;IAKG,YAAY,MAA2C;QACnD,KAAK,CAAC,MAAM,CAAC,CAAC;QAHV,wBAAmB,GAAG,IAAI,oBAAQ,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QAIrF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;QAC5B,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,cAAc,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,GAAmB,EAAE,KAAY,EAAE,IAAiB;QAC5D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QACnE,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxF,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,cAAc,CAAC,GAAmB,EAAE,KAAY,EAAE,IAAiB;;QAC7E,IAAI,OAAO,IAAI,CAAC,gBAAgB,KAAK,UAAU,EAAE;YAC7C,MAAM,QAAQ,GAAG,MAAA,GAAG,CAAC,OAAO,0CAAE,EAAE,CAAC;YACjC,IAAI,QAAQ,EAAE;gBACV,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;gBACxF,MAAM,eAAe,GAAG,IAAA,mBAAU,EAAC,MAAM,CAAC;qBACrC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;qBACnC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACtB,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC9D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;gBACxD,IAAI,eAAe,KAAK,cAAc,EAAE;oBACpC,OAAO,KAAK,CAAC;iBAChB;aACJ;SACJ;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA7CD,gEA6CC"}
+{"version":3,"file":"shipping-eligibility-checker.js","sourceRoot":"","sources":["../../../src/config/shipping-method/shipping-eligibility-checker.ts"],"names":[],"mappings":";;;AAEA,mCAAoC;AAGpC,gFAK6C;AAC7C,sDAAkD;AAelD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,0BAA8D,SAAQ,iDAElF;IAKG,YAAY,MAA2C;QACnD,KAAK,CAAC,MAAM,CAAC,CAAC;QAHV,wBAAmB,GAAG,IAAI,oBAAQ,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QAIrF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;QAC5B,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,cAAc,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,GAAmB,EAAE,KAAY,EAAE,IAAiB,EAAE,MAAsB;QACpF,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3E,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChG,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,cAAc,CAAC,GAAmB,EAAE,KAAY,EAAE,IAAiB,EAAE,MAAsB;;QACrG,IAAI,OAAO,IAAI,CAAC,gBAAgB,KAAK,UAAU,EAAE;YAC7C,MAAM,QAAQ,GAAG,MAAA,GAAG,CAAC,OAAO,0CAAE,EAAE,CAAC;YACjC,IAAI,QAAQ,EAAE;gBACV,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;gBAChG,MAAM,eAAe,GAAG,IAAA,mBAAU,EAAC,MAAM,CAAC;qBACrC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;qBACnC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACtB,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC9D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;gBACxD,IAAI,eAAe,KAAK,cAAc,EAAE;oBACpC,OAAO,KAAK,CAAC;iBAChB;aACJ;SACJ;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA7CD,gEA6CC"}

package/dist/config/system/health-check-strategy.d.ts

@@ -0,0 +1,47 @@
+import { HealthIndicatorFunction } from '@nestjs/terminus';
+import { InjectableStrategy } from '../../common/types/injectable-strategy';
+/**
+ * @description
+ * This strategy defines health checks which are included as part of the
+ * `/health` endpoint. They should only be used to monitor _critical_ systems
+ * on which proper functioning of the Vendure server depends.
+ *
+ * For more information on the underlying mechanism, see the
+ * [NestJS Terminus module docs](https://docs.nestjs.com/recipes/terminus).
+ *
+ * Custom strategies should be added to the `systemOptions.healthChecks` array.
+ * By default, Vendure includes the `TypeORMHealthCheckStrategy`, so if you set the value of the `healthChecks`
+ * array, be sure to include it manually.
+ *
+ * Vendure also ships with the {@link HttpHealthCheckStrategy}, which is convenient
+ * for adding a health check dependent on an HTTP ping.
+ *
+ *
+ *
+ * @example
+ * ```TypeScript
+ * import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '\@vendure/core';
+ * import { MyCustomHealthCheckStrategy } from './config/custom-health-check-strategy';
+ *
+ * export const config = {
+ *   // ...
+ *   systemOptions: {
+ *     healthChecks: [
+ *       new TypeORMHealthCheckStrategy(),
+ *       new HttpHealthCheckStrategy({ key: 'my-service', url: 'https://my-service.com' }),
+ *       new MyCustomHealthCheckStrategy(),
+ *     ],
+ *   },
+ * };
+ * ```
+ *
+ * @docsCategory health-check
+ */
+export interface HealthCheckStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * Should return a `HealthIndicatorFunction`, as defined by the
+     * [NestJS Terminus module](https://docs.nestjs.com/recipes/terminus).
+     */
+    getHealthIndicator(): HealthIndicatorFunction;
+}

package/{cli/common/types/common-types.js → dist/config/system/health-check-strategy.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=common-types.js.map
+//# sourceMappingURL=health-check-strategy.js.map

package/dist/config/system/health-check-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health-check-strategy.js","sourceRoot":"","sources":["../../../src/config/system/health-check-strategy.ts"],"names":[],"mappings":""}

package/dist/config/vendure-config.d.ts

@@ -7,6 +7,7 @@ import { ConnectionOptions } from 'typeorm';
 import { Middleware } from '../common';
 import { PermissionDefinition } from '../common/permission-definition';
 import { JobBufferStorageStrategy } from '../job-queue/job-buffer/job-buffer-storage-strategy';
+import { AssetImportStrategy } from './asset-import-strategy/asset-import-strategy';
 import { AssetNamingStrategy } from './asset-naming-strategy/asset-naming-strategy';
 import { AssetPreviewStrategy } from './asset-preview-strategy/asset-preview-strategy';
 import { AssetStorageStrategy } from './asset-storage-strategy/asset-storage-strategy';
@@ -18,6 +19,7 @@ import { ProductVariantPriceCalculationStrategy } from './catalog/product-varian
 import { StockDisplayStrategy } from './catalog/stock-display-strategy';
 import { CustomFields } from './custom-field/custom-field-types';
 import { EntityIdStrategy } from './entity-id-strategy/entity-id-strategy';
+import { EntityMetadataModifier } from './entity-metadata/entity-metadata-modifier';
 import { CustomFulfillmentProcess } from './fulfillment/custom-fulfillment-process';
 import { FulfillmentHandler } from './fulfillment/fulfillment-handler';
 import { JobQueueStrategy } from './job-queue/job-queue-strategy';
@@ -38,6 +40,7 @@ import { PromotionCondition } from './promotion/promotion-condition';
 import { SessionCacheStrategy } from './session-cache/session-cache-strategy';
 import { ShippingCalculator } from './shipping-method/shipping-calculator';
 import { ShippingEligibilityChecker } from './shipping-method/shipping-eligibility-checker';
+import { HealthCheckStrategy } from './system/health-check-strategy';
 import { TaxLineCalculationStrategy } from './tax/tax-line-calculation-strategy';
 import { TaxZoneStrategy } from './tax/tax-zone-strategy';
 /**
@@ -745,6 +748,14 @@ export interface ImportExportOptions {
      * @default __dirname
      */
     importAssetsDir?: string;
+    /**
+     * @description
+     * This strategy determines how asset files get imported based on the path given in the
+     * import CSV or via the {@link AssetImporter} `getAssets()` method.
+     *
+     * @since 1.7.0
+     */
+    assetImportStrategy?: AssetImportStrategy;
 }
 /**
  * @description
@@ -803,6 +814,8 @@ export interface JobQueueOptions {
  *
  * @since 1.3.0
  * @docsCategory configuration
+ * @docsPage EntityOptions
+ * @docsWeight 0
  */
 export interface EntityOptions {
     /**
@@ -812,6 +825,13 @@ export interface EntityOptions {
      * entities via the API. The default uses a simple auto-increment integer
      * strategy.
      *
+     * {{% alert "warning" %}}
+     * Note: changing from an integer-based strategy to a uuid-based strategy
+     * on an existing Vendure database will lead to problems with broken foreign-key
+     * references. To change primary key types like this, you'll need to start with
+     * a fresh database.
+     * {{% /alert %}}
+     *
      * @since 1.3.0
      * @default AutoIncrementIdStrategy
      */
@@ -838,6 +858,35 @@ export interface EntityOptions {
      * @default 30000
      */
     zoneCacheTtl?: number;
+    /**
+     * @description
+     * Allows the metadata of the built-in TypeORM entities to be manipulated. This allows you
+     * to do things like altering data types, adding indices etc. This is an advanced feature
+     * which should be used with some caution as it will result in DB schema changes. For examples
+     * see {@link EntityMetadataModifier}.
+     *
+     * @since 1.6.0
+     * @default []
+     */
+    metadataModifiers?: EntityMetadataModifier[];
+}
+/**
+ * @description
+ * Options relating to system functions.
+ *
+ * @since 1.6.0
+ * @docsCategory configuration
+ */
+export interface SystemOptions {
+    /**
+     * @description
+     * Defines an array of {@link HealthCheckStrategy} instances which are used by the `/health` endpoint to verify
+     * that any critical systems which the Vendure server depends on are also healthy.
+     *
+     * @default [TypeORMHealthCheckStrategy]
+     * @since 1.6.0
+     */
+    healthChecks?: HealthCheckStrategy[];
 }
 /**
  * @description
@@ -960,6 +1009,13 @@ export interface VendureConfig {
      * Configures how the job queue is persisted and processed.
      */
     jobQueueOptions?: JobQueueOptions;
+    /**
+     * @description
+     * Configures system options
+     *
+     * @since 1.6.0
+     */
+    systemOptions?: SystemOptions;
 }
 /**
  * @description
@@ -981,6 +1037,7 @@ export interface RuntimeVendureConfig extends Required<VendureConfig> {
     promotionOptions: Required<PromotionOptions>;
     shippingOptions: Required<ShippingOptions>;
     taxOptions: Required<TaxOptions>;
+    systemOptions: Required<SystemOptions>;
 }
 declare type DeepPartialSimple<T> = {
     [P in keyof T]?: null | (T[P] extends Array<infer U> ? Array<DeepPartialSimple<U>> : T[P] extends ReadonlyArray<infer X> ? ReadonlyArray<DeepPartialSimple<X>> : T[P] extends Type<any> ? T[P] : DeepPartialSimple<T[P]>);

package/dist/connection/connection.module.d.ts

@@ -3,5 +3,5 @@ import { ConnectionOptions } from 'typeorm';
 export declare class ConnectionModule {
     static forRoot(): DynamicModule;
     static forPlugin(): DynamicModule;
-    static getTypeOrmLogger(dbConnectionOptions: ConnectionOptions): import("typeorm").Logger | "debug" | "advanced-console" | "simple-console" | "file";
+    static getTypeOrmLogger(dbConnectionOptions: ConnectionOptions): "debug" | import("typeorm").Logger | "advanced-console" | "simple-console" | "file";
 }

package/dist/connection/remove-custom-fields-with-eager-relations.d.ts

@@ -0,0 +1,34 @@
+import { SelectQueryBuilder } from 'typeorm';
+/**
+ * This is a work-around for this issue: https://github.com/vendure-ecommerce/vendure/issues/1664
+ *
+ * Explanation:
+ * When calling `FindOptionsUtils.joinEagerRelations()`, there appears to be a bug in TypeORM whereby
+ * it will throw the following error *if* the `options.relations` array contains any customField relations
+ * where the related entity itself has eagerly-loaded relations.
+ *
+ * For example, let's say we define a custom field on the Product entity like this:
+ * ```
+ * Product: [{
+ *   name: 'featuredFacet',
+ *   type: 'relation',
+ *   entity: Facet,
+ * }],
+ * ```
+ * and then we pass into `TransactionalConnection.findOneInChannel()` an options array of:
+ *
+ * ```
+ * { relations: ['customFields.featuredFacet'] }
+ * ```
+ * it will throw an error because the `Facet` entity itself has eager relations (namely the `translations` property).
+ * This will cause TypeORM to throw the error:
+ * ```
+ * TypeORMError: "entity__customFields" alias was not found. Maybe you forgot to join it?
+ * ```
+ *
+ * So this method introspects the QueryBuilder metadata and checks for any custom field relations which
+ * themselves have eager relations. If found, it removes those items from the `options.relations` array.
+ *
+ * TODO: Ideally create a minimal reproduction case and report in the TypeORM repo for an upstream fix.
+ */
+export declare function removeCustomFieldsWithEagerRelations(qb: SelectQueryBuilder<any>, relations?: string[]): string[];

package/dist/connection/remove-custom-fields-with-eager-relations.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeCustomFieldsWithEagerRelations = void 0;
+const index_1 = require("../config/index");
+/**
+ * This is a work-around for this issue: https://github.com/vendure-ecommerce/vendure/issues/1664
+ *
+ * Explanation:
+ * When calling `FindOptionsUtils.joinEagerRelations()`, there appears to be a bug in TypeORM whereby
+ * it will throw the following error *if* the `options.relations` array contains any customField relations
+ * where the related entity itself has eagerly-loaded relations.
+ *
+ * For example, let's say we define a custom field on the Product entity like this:
+ * ```
+ * Product: [{
+ *   name: 'featuredFacet',
+ *   type: 'relation',
+ *   entity: Facet,
+ * }],
+ * ```
+ * and then we pass into `TransactionalConnection.findOneInChannel()` an options array of:
+ *
+ * ```
+ * { relations: ['customFields.featuredFacet'] }
+ * ```
+ * it will throw an error because the `Facet` entity itself has eager relations (namely the `translations` property).
+ * This will cause TypeORM to throw the error:
+ * ```
+ * TypeORMError: "entity__customFields" alias was not found. Maybe you forgot to join it?
+ * ```
+ *
+ * So this method introspects the QueryBuilder metadata and checks for any custom field relations which
+ * themselves have eager relations. If found, it removes those items from the `options.relations` array.
+ *
+ * TODO: Ideally create a minimal reproduction case and report in the TypeORM repo for an upstream fix.
+ */
+function removeCustomFieldsWithEagerRelations(qb, relations = []) {
+    let resultingRelations = relations;
+    const mainAlias = qb.expressionMap.mainAlias;
+    const customFieldsMetadata = mainAlias === null || mainAlias === void 0 ? void 0 : mainAlias.metadata.embeddeds.find(metadata => metadata.propertyName === 'customFields');
+    if (customFieldsMetadata) {
+        const customFieldRelationsWithEagerRelations = customFieldsMetadata.relations.filter(relation => {
+            return (!!relation.inverseEntityMetadata.ownRelations.find(or => or.isEager === true) ||
+                relation.inverseEntityMetadata.embeddeds.find(em => em.propertyName === 'customFields' && em.relations.find(emr => emr.isEager)));
+        });
+        for (const relation of customFieldRelationsWithEagerRelations) {
+            const propertyName = relation.propertyName;
+            const relationsToRemove = relations.filter(r => r.startsWith(`customFields.${propertyName}`));
+            if (relationsToRemove.length) {
+                index_1.Logger.debug(`TransactionalConnection.findOneInChannel cannot automatically join relation [${mainAlias === null || mainAlias === void 0 ? void 0 : mainAlias.metadata.name}.customFields.${propertyName}]`);
+                resultingRelations = relations.filter(r => !r.startsWith(`customFields.${propertyName}`));
+            }
+        }
+    }
+    return resultingRelations;
+}
+exports.removeCustomFieldsWithEagerRelations = removeCustomFieldsWithEagerRelations;
+//# sourceMappingURL=remove-custom-fields-with-eager-relations.js.map

package/dist/connection/remove-custom-fields-with-eager-relations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-custom-fields-with-eager-relations.js","sourceRoot":"","sources":["../../src/connection/remove-custom-fields-with-eager-relations.ts"],"names":[],"mappings":";;;AAEA,2CAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,SAAgB,oCAAoC,CAChD,EAA2B,EAC3B,YAAsB,EAAE;IAExB,IAAI,kBAAkB,GAAG,SAAS,CAAC;IACnC,MAAM,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC;IAC7C,MAAM,oBAAoB,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAC,SAAS,CAAC,IAAI,CAC3D,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,YAAY,KAAK,cAAc,CACvD,CAAC;IACF,IAAI,oBAAoB,EAAE;QACtB,MAAM,sCAAsC,GAAG,oBAAoB,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YAC5F,OAAO,CACH,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,KAAK,IAAI,CAAC;gBAC7E,QAAQ,CAAC,qBAAqB,CAAC,SAAS,CAAC,IAAI,CACzC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,KAAK,cAAc,IAAI,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CACpF,CACJ,CAAC;QACN,CAAC,CAAC,CAAC;QACH,KAAK,MAAM,QAAQ,IAAI,sCAAsC,EAAE;YAC3D,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC;YAC3C,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,YAAY,EAAE,CAAC,CAAC,CAAC;YAC9F,IAAI,iBAAiB,CAAC,MAAM,EAAE;gBAC1B,cAAM,CAAC,KAAK,CACR,gFAAgF,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAC,IAAI,iBAAiB,YAAY,GAAG,CAC3I,CAAC;gBACF,kBAAkB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,YAAY,EAAE,CAAC,CAAC,CAAC;aAC7F;SACJ;KACJ;IACD,OAAO,kBAAkB,CAAC;AAC9B,CAAC;AA9BD,oFA8BC"}

package/dist/connection/transaction-subscriber.d.ts

@@ -3,7 +3,19 @@ import { EntityManager } from 'typeorm/entity-manager/EntityManager';
 import { QueryRunner } from 'typeorm/query-runner/QueryRunner';
 import { TransactionCommitEvent } from 'typeorm/subscriber/event/TransactionCommitEvent';
 import { TransactionRollbackEvent } from 'typeorm/subscriber/event/TransactionRollbackEvent';
+/**
+ * This error should be thrown by an event subscription if types do not match
+ *
+ * @internal
+ */
+export declare class TransactionSubscriberError extends Error {
+}
+export declare type TransactionSubscriberEventType = 'commit' | 'rollback';
 export interface TransactionSubscriberEvent {
+    /**
+     * Event type. Either commit or rollback.
+     */
+    type: TransactionSubscriberEventType;
     /**
      * Connection used in the event.
      */
@@ -28,10 +40,12 @@ export interface TransactionSubscriberEvent {
  */
 export declare class TransactionSubscriber implements EntitySubscriberInterface {
     private connection;
-    private commit$;
-    private rollback$;
+    private subject$;
     constructor(connection: Connection);
     afterTransactionCommit(event: TransactionCommitEvent): void;
     afterTransactionRollback(event: TransactionRollbackEvent): void;
+    awaitCommit(queryRunner: QueryRunner): Promise<QueryRunner>;
+    awaitRollback(queryRunner: QueryRunner): Promise<QueryRunner>;
     awaitRelease(queryRunner: QueryRunner): Promise<QueryRunner>;
+    private awaitTransactionEvent;
 }

package/dist/connection/transaction-subscriber.js

@@ -13,12 +13,20 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 };
 var TransactionSubscriber_1;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionSubscriber = void 0;
+exports.TransactionSubscriber = exports.TransactionSubscriberError = void 0;
 const common_1 = require("@nestjs/common");
 const typeorm_1 = require("@nestjs/typeorm");
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const typeorm_2 = require("typeorm");
+/**
+ * This error should be thrown by an event subscription if types do not match
+ *
+ * @internal
+ */
+class TransactionSubscriberError extends Error {
+}
+exports.TransactionSubscriberError = TransactionSubscriberError;
 /**
  * This subscriber listens to all transaction commit/rollback events emitted by TypeORM
  * so that we can be notified as soon as a particular queryRunner's transactions ends.
@@ -29,21 +37,34 @@ const typeorm_2 = require("typeorm");
 let TransactionSubscriber = TransactionSubscriber_1 = class TransactionSubscriber {
     constructor(connection) {
         this.connection = connection;
-        this.commit$ = new rxjs_1.Subject();
-        this.rollback$ = new rxjs_1.Subject();
+        this.subject$ = new rxjs_1.Subject();
         if (!connection.subscribers.find(subscriber => subscriber.constructor === TransactionSubscriber_1)) {
             connection.subscribers.push(this);
         }
     }
     afterTransactionCommit(event) {
-        this.commit$.next(event);
+        this.subject$.next(Object.assign({ type: 'commit' }, event));
     }
     afterTransactionRollback(event) {
-        this.rollback$.next(event);
+        this.subject$.next(Object.assign({ type: 'rollback' }, event));
+    }
+    awaitCommit(queryRunner) {
+        return this.awaitTransactionEvent(queryRunner, 'commit');
+    }
+    awaitRollback(queryRunner) {
+        return this.awaitTransactionEvent(queryRunner, 'rollback');
     }
     awaitRelease(queryRunner) {
+        return this.awaitTransactionEvent(queryRunner);
+    }
+    awaitTransactionEvent(queryRunner, type) {
         if (queryRunner.isTransactionActive) {
-            return (0, rxjs_1.lastValueFrom)((0, rxjs_1.merge)(this.commit$, this.rollback$).pipe((0, operators_1.filter)(event => event.queryRunner === queryRunner), (0, operators_1.take)(1), (0, operators_1.map)(event => event.queryRunner), 
+            return (0, rxjs_1.lastValueFrom)(this.subject$
+                .pipe((0, operators_1.filter)(event => !event.queryRunner.isTransactionActive && event.queryRunner === queryRunner), (0, operators_1.take)(1), (0, operators_1.tap)(event => {
+                if (type && event.type !== type) {
+                    throw new TransactionSubscriberError(`Unexpected event type: ${event.type}. Expected ${type}.`);
+                }
+            }), (0, operators_1.map)(event => event.queryRunner), 
             // This `delay(0)` call appears to be necessary with the upgrade to TypeORM
             // v0.2.41, otherwise an active queryRunner can still get picked up in an event
             // subscriber function. This is manifested by the e2e test

package/dist/connection/transaction-subscriber.js.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-subscriber.js","sourceRoot":"","sources":["../../src/connection/transaction-subscriber.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,6CAAmD;AACnD,+BAAqD;AACrD,8CAA0D;AAC1D,qCAAgE;AAuBhE;;;;;;GAMG;AAEH,IAAa,qBAAqB,6BAAlC,MAAa,qBAAqB;IAI9B,YAAwC,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;QAHtD,YAAO,GAAG,IAAI,cAAO,EAA8B,CAAC;QACpD,cAAS,GAAG,IAAI,cAAO,EAA8B,CAAC;QAG1D,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,KAAK,uBAAqB,CAAC,EAAE;YAC9F,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACrC;IACL,CAAC;IAED,sBAAsB,CAAC,KAA6B;QAChD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,wBAAwB,CAAC,KAA+B;QACpD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,YAAY,CAAC,WAAwB;QACjC,IAAI,WAAW,CAAC,mBAAmB,EAAE;YACjC,OAAO,IAAA,oBAAa,EAChB,IAAA,YAAK,EAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CACpC,IAAA,kBAAM,EAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,KAAK,WAAW,CAAC,EAClD,IAAA,gBAAI,EAAC,CAAC,CAAC,EACP,IAAA,eAAG,EAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC;YAC/B,2EAA2E;YAC3E,+EAA+E;YAC/E,0DAA0D;YAC1D,0EAA0E;YAC1E,wEAAwE;YACxE,mEAAmE;YACnE,IAAA,iBAAK,EAAC,CAAC,CAAC,CACX,CACJ,CAAC;SACL;aAAM;YACH,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SACvC;IACL,CAAC;CACJ,CAAA;AAtCY,qBAAqB;IADjC,IAAA,mBAAU,GAAE;IAKI,WAAA,IAAA,0BAAgB,GAAE,CAAA;qCAAqB,oBAAU;GAJrD,qBAAqB,CAsCjC;AAtCY,sDAAqB"}
+{"version":3,"file":"transaction-subscriber.js","sourceRoot":"","sources":["../../src/connection/transaction-subscriber.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,6CAAmD;AACnD,+BAAsE;AACtE,8CAA+D;AAC/D,qCAAgE;AAMhE;;;;GAIG;AACH,MAAa,0BAA2B,SAAQ,KAAK;CAAG;AAAxD,gEAAwD;AA0BxD;;;;;;GAMG;AAEH,IAAa,qBAAqB,6BAAlC,MAAa,qBAAqB;IAG9B,YAAwC,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;QAFtD,aAAQ,GAAG,IAAI,cAAO,EAA8B,CAAC;QAGzD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,KAAK,uBAAqB,CAAC,EAAE;YAC9F,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACrC;IACL,CAAC;IAED,sBAAsB,CAAC,KAA6B;QAChD,IAAI,CAAC,QAAQ,CAAC,IAAI,iBACd,IAAI,EAAE,QAAQ,IACX,KAAK,EACV,CAAC;IACP,CAAC;IAED,wBAAwB,CAAC,KAA+B;QACpD,IAAI,CAAC,QAAQ,CAAC,IAAI,iBACd,IAAI,EAAE,UAAU,IACb,KAAK,EACV,CAAC;IACP,CAAC;IAED,WAAW,CAAC,WAAwB;QAChC,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,aAAa,CAAC,WAAwB;QAClC,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IAC/D,CAAC;IAED,YAAY,CAAC,WAAwB;QACjC,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAEO,qBAAqB,CACzB,WAAwB,EACxB,IAAqC;QAErC,IAAI,WAAW,CAAC,mBAAmB,EAAE;YACjC,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,QAAQ;iBAC7B,IAAI,CACD,IAAA,kBAAM,EACF,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,mBAAmB,IAAI,KAAK,CAAC,WAAW,KAAK,WAAW,CACvF,EACD,IAAA,gBAAI,EAAC,CAAC,CAAC,EACP,IAAA,eAAG,EAAC,KAAK,CAAC,EAAE;gBACR,IAAI,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE;oBAC7B,MAAM,IAAI,0BAA0B,CAAC,0BAA0B,KAAK,CAAC,IAAI,cAAc,IAAI,GAAG,CAAC,CAAC;iBACnG;YACL,CAAC,CAAC,EACF,IAAA,eAAG,EAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC;YAC/B,2EAA2E;YAC3E,+EAA+E;YAC/E,0DAA0D;YAC1D,0EAA0E;YAC1E,wEAAwE;YACxE,mEAAmE;YACnE,IAAA,iBAAK,EAAC,CAAC,CAAC,CACX,CACJ,CAAC;SACL;aAAM;YACH,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SACvC;IACL,CAAC;CACJ,CAAA;AAjEY,qBAAqB;IADjC,IAAA,mBAAU,GAAE;IAII,WAAA,IAAA,0BAAgB,GAAE,CAAA;qCAAqB,oBAAU;GAHrD,qBAAqB,CAiEjC;AAjEY,sDAAqB"}

package/dist/connection/transaction-wrapper.d.ts

@@ -13,8 +13,12 @@ export declare class TransactionWrapper {
      * Executes the `work` function within the context of a transaction. If the `work` function
      * resolves / completes, then all the DB operations it contains will be committed. If it
      * throws an error or rejects, then all DB operations will be rolled back.
+     *
+     * @note
+     * This function does not mutate your context. Instead, this function makes a copy and passes
+     * context to work function.
      */
-    executeInTransaction<T>(ctx: RequestContext, work: () => Observable<T> | Promise<T>, mode: TransactionMode, connection: Connection): Promise<T>;
+    executeInTransaction<T>(originalCtx: RequestContext, work: (ctx: RequestContext) => Observable<T> | Promise<T>, mode: TransactionMode, connection: Connection): Promise<T>;
     /**
      * Attempts to start a DB transaction, with retry logic in the case that a transaction
      * is already started for the connection (which is mainly a problem with SQLite/Sql.js)

package/dist/connection/transaction-wrapper.js

@@ -16,23 +16,23 @@ class TransactionWrapper {
      * Executes the `work` function within the context of a transaction. If the `work` function
      * resolves / completes, then all the DB operations it contains will be committed. If it
      * throws an error or rejects, then all DB operations will be rolled back.
+     *
+     * @note
+     * This function does not mutate your context. Instead, this function makes a copy and passes
+     * context to work function.
      */
-    async executeInTransaction(ctx, work, mode, connection) {
-        const queryRunnerExists = !!ctx[constants_1.TRANSACTION_MANAGER_KEY];
-        if (queryRunnerExists) {
-            // If a QueryRunner already exists on the RequestContext, there must be an existing
-            // outer transaction in progress. In that case, we just execute the work function
-            // as usual without needing to further wrap in a transaction.
-            return (0, rxjs_1.lastValueFrom)((0, rxjs_1.from)(work()));
-        }
-        const queryRunner = connection.createQueryRunner();
+    async executeInTransaction(originalCtx, work, mode, connection) {
+        // Copy to make sure original context will remain valid after transaction completes
+        const ctx = originalCtx.copy();
+        const entityManager = ctx[constants_1.TRANSACTION_MANAGER_KEY];
+        const queryRunner = (entityManager === null || entityManager === void 0 ? void 0 : entityManager.queryRunner) || connection.createQueryRunner();
         if (mode === 'auto') {
             await this.startTransaction(queryRunner);
         }
         ctx[constants_1.TRANSACTION_MANAGER_KEY] = queryRunner.manager;
         try {
             const maxRetries = 5;
-            const result = await (0, rxjs_1.lastValueFrom)((0, rxjs_1.from)(work()).pipe((0, operators_1.retryWhen)(errors => errors.pipe((0, operators_1.tap)(err => {
+            const result = await (0, rxjs_1.lastValueFrom)((0, rxjs_1.from)(work(ctx)).pipe((0, operators_1.retryWhen)(errors => errors.pipe((0, operators_1.tap)(err => {
                 if (!this.isRetriableError(err)) {
                     throw err;
                 }
@@ -49,7 +49,10 @@ class TransactionWrapper {
             throw error;
         }
         finally {
-            if ((queryRunner === null || queryRunner === void 0 ? void 0 : queryRunner.isReleased) === false) {
+            if (!queryRunner.isTransactionActive
+                && queryRunner.isReleased === false) {
+                // There is a check for an active transaction
+                // because this could be a nested transaction (savepoint).
                 await queryRunner.release();
             }
         }

package/dist/connection/transaction-wrapper.js.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-wrapper.js","sourceRoot":"","sources":["../../src/connection/transaction-wrapper.ts"],"names":[],"mappings":";;;AAAA,+BAA2D;AAC3D,8CAAsD;AAEtD,iGAA8F;AAI9F,mDAA8D;AAE9D;;;;GAIG;AACH,MAAa,kBAAkB;IAC3B;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACtB,GAAmB,EACnB,IAAsC,EACtC,IAAqB,EACrB,UAAsB;QAEtB,MAAM,iBAAiB,GAAG,CAAC,CAAE,GAAW,CAAC,mCAAuB,CAAC,CAAC;QAClE,IAAI,iBAAiB,EAAE;YACnB,mFAAmF;YACnF,iFAAiF;YACjF,6DAA6D;YAC7D,OAAO,IAAA,oBAAa,EAAC,IAAA,WAAI,EAAC,IAAI,EAAE,CAAC,CAAC,CAAC;SACtC;QACD,MAAM,WAAW,GAAG,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACnD,IAAI,IAAI,KAAK,MAAM,EAAE;YACjB,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;SAC5C;QACA,GAAW,CAAC,mCAAuB,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC;QAE5D,IAAI;YACA,MAAM,UAAU,GAAG,CAAC,CAAC;YACrB,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAa,EAC9B,IAAA,WAAI,EAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CACb,IAAA,qBAAS,EAAC,MAAM,CAAC,EAAE,CACf,MAAM,CAAC,IAAI,CACP,IAAA,eAAG,EAAC,GAAG,CAAC,EAAE;gBACN,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;oBAC7B,MAAM,GAAG,CAAC;iBACb;YACL,CAAC,CAAC,EACF,IAAA,gBAAI,EAAC,UAAU,CAAC,CACnB,CACJ,CACJ,CACJ,CAAC;YACF,IAAI,WAAW,CAAC,mBAAmB,EAAE;gBACjC,MAAM,WAAW,CAAC,iBAAiB,EAAE,CAAC;aACzC;YACD,OAAO,MAAM,CAAC;SACjB;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,WAAW,CAAC,mBAAmB,EAAE;gBACjC,MAAM,WAAW,CAAC,mBAAmB,EAAE,CAAC;aAC3C;YACD,MAAM,KAAK,CAAC;SACf;gBAAS;YACN,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,MAAK,KAAK,EAAE;gBACnC,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;aAC/B;SACJ;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,gBAAgB,CAAC,WAAwB;QACnD,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,SAAc,CAAC;QAEnB,wDAAwD;QACxD,KAAK,UAAU,uBAAuB;YAClC,IAAI;gBACA,MAAM,WAAW,CAAC,gBAAgB,EAAE,CAAC;gBACrC,OAAO,IAAI,CAAC;aACf;YAAC,OAAO,GAAQ,EAAE;gBACf,SAAS,GAAG,GAAG,CAAC;gBAChB,IAAI,GAAG,YAAY,+DAA8B,EAAE;oBAC/C,OAAO,KAAK,CAAC;iBAChB;gBACD,MAAM,GAAG,CAAC;aACb;QACL,CAAC;QAED,OAAO,QAAQ,GAAG,UAAU,EAAE;YAC1B,MAAM,MAAM,GAAG,MAAM,uBAAuB,EAAE,CAAC;YAC/C,IAAI,MAAM,EAAE;gBACR,OAAO;aACV;YACD,QAAQ,EAAE,CAAC;YACX,6CAA6C;YAC7C,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,EAAE,CAAC,CAAC,CAAC;SACpE;QACD,MAAM,SAAS,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAC,GAAQ;QAC7B,MAAM,aAAa,GAAG,GAAG,CAAC,IAAI,KAAK,kBAAkB,CAAC;QACtD,MAAM,gBAAgB,GAAG,GAAG,CAAC,IAAI,KAAK,mBAAmB,CAAC;QAC1D,OAAO,aAAa,IAAI,gBAAgB,CAAC;IAC7C,CAAC;CACJ;AAvGD,gDAuGC"}
+{"version":3,"file":"transaction-wrapper.js","sourceRoot":"","sources":["../../src/connection/transaction-wrapper.ts"],"names":[],"mappings":";;;AAAA,+BAA2D;AAC3D,8CAAsD;AAEtD,iGAA8F;AAI9F,mDAA8D;AAE9D;;;;GAIG;AACH,MAAa,kBAAkB;IAC3B;;;;;;;;;OASG;IACH,KAAK,CAAC,oBAAoB,CACtB,WAA2B,EAC3B,IAAyD,EACzD,IAAqB,EACrB,UAAsB;QAEtB,mFAAmF;QACnF,MAAM,GAAG,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QAE/B,MAAM,aAAa,GAA+B,GAAW,CAAC,mCAAuB,CAAC,CAAC;QACvF,MAAM,WAAW,GAAG,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,WAAW,KAAI,UAAU,CAAC,iBAAiB,EAAE,CAAC;QAEjF,IAAI,IAAI,KAAK,MAAM,EAAE;YACjB,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;SAC5C;QACA,GAAW,CAAC,mCAAuB,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC;QAE5D,IAAI;YACA,MAAM,UAAU,GAAG,CAAC,CAAC;YACrB,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAa,EAC9B,IAAA,WAAI,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAChB,IAAA,qBAAS,EAAC,MAAM,CAAC,EAAE,CACf,MAAM,CAAC,IAAI,CACP,IAAA,eAAG,EAAC,GAAG,CAAC,EAAE;gBACN,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;oBAC7B,MAAM,GAAG,CAAC;iBACb;YACL,CAAC,CAAC,EACF,IAAA,gBAAI,EAAC,UAAU,CAAC,CACnB,CACJ,CACJ,CACJ,CAAC;YACF,IAAI,WAAW,CAAC,mBAAmB,EAAE;gBACjC,MAAM,WAAW,CAAC,iBAAiB,EAAE,CAAC;aACzC;YACD,OAAO,MAAM,CAAC;SACjB;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,WAAW,CAAC,mBAAmB,EAAE;gBACjC,MAAM,WAAW,CAAC,mBAAmB,EAAE,CAAC;aAC3C;YACD,MAAM,KAAK,CAAC;SACf;gBAAS;YACN,IAAI,CAAC,WAAW,CAAC,mBAAmB;mBAC7B,WAAW,CAAC,UAAU,KAAK,KAAK,EAAE;gBACrC,6CAA6C;gBAC7C,0DAA0D;gBAE1D,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;aAC/B;SACJ;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,gBAAgB,CAAC,WAAwB;QACnD,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,SAAc,CAAC;QAEnB,wDAAwD;QACxD,KAAK,UAAU,uBAAuB;YAClC,IAAI;gBACA,MAAM,WAAW,CAAC,gBAAgB,EAAE,CAAC;gBACrC,OAAO,IAAI,CAAC;aACf;YAAC,OAAO,GAAQ,EAAE;gBACf,SAAS,GAAG,GAAG,CAAC;gBAChB,IAAI,GAAG,YAAY,+DAA8B,EAAE;oBAC/C,OAAO,KAAK,CAAC;iBAChB;gBACD,MAAM,GAAG,CAAC;aACb;QACL,CAAC;QAED,OAAO,QAAQ,GAAG,UAAU,EAAE;YAC1B,MAAM,MAAM,GAAG,MAAM,uBAAuB,EAAE,CAAC;YAC/C,IAAI,MAAM,EAAE;gBACR,OAAO;aACV;YACD,QAAQ,EAAE,CAAC;YACX,6CAA6C;YAC7C,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,EAAE,CAAC,CAAC,CAAC;SACpE;QACD,MAAM,SAAS,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAC,GAAQ;QAC7B,MAAM,aAAa,GAAG,GAAG,CAAC,IAAI,KAAK,kBAAkB,CAAC;QACtD,MAAM,gBAAgB,GAAG,GAAG,CAAC,IAAI,KAAK,mBAAmB,CAAC;QAC1D,OAAO,aAAa,IAAI,gBAAgB,CAAC;IAC7C,CAAC;CACJ;AA7GD,gDA6GC"}

package/dist/connection/transactional-connection.d.ts

@@ -33,6 +33,8 @@ export declare class TransactionalConnection {
      * Returns a TypeORM repository. Note that when no RequestContext is supplied, the repository will not
      * be aware of any existing transaction. Therefore calling this method without supplying a RequestContext
      * is discouraged without a deliberate reason.
+     *
+     * @deprecated since 1.7.0: Use {@link TransactionalConnection.rawConnection rawConnection.getRepository()} function instead.
      */
     getRepository<Entity>(target: ObjectType<Entity> | EntitySchema<Entity> | string): Repository<Entity>;
     /**
@@ -58,16 +60,20 @@ export declare class TransactionalConnection {
      * of Vendure internal services.
      *
      * If there is already a {@link RequestContext} object available, you should pass it in as the first
-     * argument in order to add a new transaction to it. If not, omit the first argument and an empty
+     * argument in order to create transactional context as the copy. If not, omit the first argument and an empty
      * RequestContext object will be created, which is then used to propagate the transaction to
      * all inner method calls.
      *
      * @example
      * ```TypeScript
-     * private async transferCredit(fromId: ID, toId: ID, amount: number) {
-     *   await this.connection.withTransaction(ctx => {
+     * private async transferCredit(outerCtx: RequestContext, fromId: ID, toId: ID, amount: number) {
+     *   await this.connection.withTransaction(outerCtx, ctx => {
      *     await this.giftCardService.updateCustomerCredit(fromId, -amount);
      *
+     *     // Note you must not use outerCtx here, instead use ctx. Otherwise this query
+     *     // will be executed outside of transaction
+     *     await this.connection.getRepository(ctx, GiftCard).update(fromId, { transferred: true })
+     *
      *     // If some intermediate logic here throws an Error,
      *     // then all DB transactions will be rolled back and neither Customer's
      *     // credit balance will have changed.