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

package/dist/config/default-config.js

@@ -3,8 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultConfig = void 0;
 const generated_types_1 = require("@vendure/common/lib/generated-types");
 const shared_constants_1 = require("@vendure/common/lib/shared-constants");
+const typeorm_health_check_strategy_1 = require("../health-check/typeorm-health-check-strategy");
 const in_memory_job_queue_strategy_1 = require("../job-queue/in-memory-job-queue-strategy");
 const in_memory_job_buffer_storage_strategy_1 = require("../job-queue/job-buffer/in-memory-job-buffer-storage-strategy");
+const default_asset_import_strategy_1 = require("./asset-import-strategy/default-asset-import-strategy");
 const default_asset_naming_strategy_1 = require("./asset-naming-strategy/default-asset-naming-strategy");
 const no_asset_preview_strategy_1 = require("./asset-preview-strategy/no-asset-preview-strategy");
 const no_asset_storage_strategy_1 = require("./asset-storage-strategy/no-asset-storage-strategy");
@@ -106,6 +108,7 @@ exports.defaultConfig = {
     entityOptions: {
         channelCacheTtl: 30000,
         zoneCacheTtl: 30000,
+        metadataModifiers: [],
     },
     promotionOptions: {
         promotionConditions: promotion_1.defaultPromotionConditions,
@@ -141,6 +144,7 @@ exports.defaultConfig = {
     },
     importExportOptions: {
         importAssetsDir: __dirname,
+        assetImportStrategy: new default_asset_import_strategy_1.DefaultAssetImportStrategy(),
     },
     jobQueueOptions: {
         jobQueueStrategy: new in_memory_job_queue_strategy_1.InMemoryJobQueueStrategy(),
@@ -177,5 +181,8 @@ exports.defaultConfig = {
         Zone: [],
     },
     plugins: [],
+    systemOptions: {
+        healthChecks: [new typeorm_health_check_strategy_1.TypeORMHealthCheckStrategy()],
+    },
 };
 //# sourceMappingURL=default-config.js.map

package/dist/config/default-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"default-config.js","sourceRoot":"","sources":["../../src/config/default-config.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AACnE,2EAI8C;AAE9C,4FAAqF;AACrF,yHAAiH;AAEjH,yGAAmG;AACnG,kGAA4F;AAC5F,kGAA4F;AAC5F,8FAAwF;AACxF,sGAAgG;AAChG,0FAAqF;AACrF,qFAAgF;AAChF,qIAA6H;AAC7H,6FAAuF;AACvF,gGAA0F;AAC1F,yFAAoF;AACpF,4DAAwD;AACxD,6GAAsG;AACtG,yHAAiH;AACjH,yFAAmF;AACnF,iGAA2F;AAC3F,yEAAoE;AACpE,yFAAyF;AACzF,qEAAuE;AACvE,mEAA8D;AAC9D,2CAAkF;AAClF,uGAAgG;AAChG,+FAA0F;AAC1F,iHAA2G;AAC3G,uGAAgG;AAChG,+EAAyE;AAGzE;;;;;GAKG;AACU,QAAA,aAAa,GAAyB;IAC/C,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,8BAAY,CAAC,EAAE;IACpC,MAAM,EAAE,IAAI,8BAAa,EAAE;IAC3B,UAAU,EAAE;QACR,QAAQ,EAAE,EAAE;QACZ,IAAI,EAAE,IAAI;QACV,YAAY,EAAE,WAAW;QACzB,kBAAkB,EAAE,KAAK;QACzB,aAAa,EAAE,KAAK;QACpB,mBAAmB,EAAE,IAAI;QACzB,uBAAuB,EAAE,EAAE;QAC3B,WAAW,EAAE,UAAU;QACvB,iBAAiB,EAAE,KAAK;QACxB,YAAY,EAAE,KAAK;QACnB,kBAAkB,EAAE,GAAG;QACvB,sBAAsB,EAAE,EAAE;QAC1B,eAAe,EAAE,eAAe;QAChC,IAAI,EAAE;YACF,MAAM,EAAE,IAAI;YACZ,WAAW,EAAE,IAAI;SACpB;QACD,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAI;QACnB,mBAAmB,EAAE,EAAE;KAC1B;IACD,WAAW,EAAE;QACT,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,QAAQ;QACrB,aAAa,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAC5C,QAAQ,EAAE,IAAI;SACjB;QACD,kBAAkB,EAAE,gDAA6B;QACjD,eAAe,EAAE,IAAI;QACrB,oBAAoB,EAAE,IAAI,+DAA4B,EAAE;QACxD,eAAe,EAAE,GAAG;QACpB,mBAAmB,EAAE,IAAI;QACzB,yBAAyB,EAAE,IAAI;QAC/B,qBAAqB,EAAE;YACnB,UAAU,EAAE,8CAA2B;YACvC,QAAQ,EAAE,4CAAyB;SACtC;QACD,0BAA0B,EAAE,CAAC,IAAI,6DAA4B,EAAE,CAAC;QAChE,2BAA2B,EAAE,CAAC,IAAI,6DAA4B,EAAE,CAAC;QACjE,iBAAiB,EAAE,EAAE;QACrB,uBAAuB,EAAE,IAAI,gEAA6B,EAAE;QAC5D,0BAA0B,EAAE,IAAI,wEAAiC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;KACtF;IACD,cAAc,EAAE;QACZ,iBAAiB,EAAE,qDAAwB;QAC3C,sCAAsC,EAAE,IAAI,kGAA6C,EAAE;QAC3F,oBAAoB,EAAE,IAAI,4DAA2B,EAAE;KAC1D;IACD,gBAAgB,EAAE,IAAI,oDAAuB,EAAE;IAC/C,YAAY,EAAE;QACV,mBAAmB,EAAE,IAAI,0DAA0B,EAAE;QACrD,oBAAoB,EAAE,IAAI,kDAAsB,EAAE;QAClD,oBAAoB,EAAE,IAAI,kDAAsB,EAAE;QAClD,kBAAkB,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC;QAC7D,iBAAiB,EAAE,QAAQ;KAC9B;IACD,mBAAmB,EAAE;QACjB,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,OAAO;KAChB;IACD,aAAa,EAAE;QACX,eAAe,EAAE,KAAK;QACtB,YAAY,EAAE,KAAK;KACtB;IACD,gBAAgB,EAAE;QACd,mBAAmB,EAAE,sCAA0B;QAC/C,gBAAgB,EAAE,mCAAuB;KAC5C;IACD,eAAe,EAAE;QACb,2BAA2B,EAAE,CAAC,wEAAiC,CAAC;QAChE,mBAAmB,EAAE,CAAC,uDAAyB,CAAC;QAChD,wBAAwB,EAAE,EAAE;QAC5B,mBAAmB,EAAE,CAAC,qDAAwB,CAAC;KAClD;IACD,YAAY,EAAE;QACV,eAAe,EAAE,GAAG;QACpB,mBAAmB,EAAE,GAAG;QACxB,iCAAiC,EAAE,IAAI,wFAAwC,EAAE;QACjF,aAAa,EAAE,IAAI,2CAAmB,EAAE;QACxC,qBAAqB,EAAE,IAAI,qCAAgB,EAAE;QAC7C,OAAO,EAAE,EAAE;QACX,uBAAuB,EAAE,IAAI,kEAA8B,EAAE;QAC7D,iBAAiB,EAAE,IAAI,8CAAwB,EAAE;QACjD,yBAAyB,EAAE,IAAI,gEAAgC,CAAC,IAAI,CAAC;QACrE,4BAA4B,EAAE,IAAI,6EAAmC,EAAE;QACvE,mBAAmB,EAAE,IAAI,0DAA0B,EAAE;KACxD;IACD,cAAc,EAAE;QACZ,gCAAgC,EAAE,EAAE;QACpC,qBAAqB,EAAE,EAAE;QACzB,oBAAoB,EAAE,EAAE;KAC3B;IACD,UAAU,EAAE;QACR,eAAe,EAAE,IAAI,kDAAsB,EAAE;QAC7C,0BAA0B,EAAE,IAAI,yEAAiC,EAAE;KACtE;IACD,mBAAmB,EAAE;QACjB,eAAe,EAAE,SAAS;KAC7B;IACD,eAAe,EAAE;QACb,gBAAgB,EAAE,IAAI,uDAAwB,EAAE;QAChD,wBAAwB,EAAE,IAAI,wEAAgC,EAAE;QAChE,YAAY,EAAE,EAAE;QAChB,uBAAuB,EAAE,KAAK;QAC9B,MAAM,EAAE,EAAE;KACb;IACD,YAAY,EAAE;QACV,OAAO,EAAE,EAAE;QACX,aAAa,EAAE,EAAE;QACjB,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;QACX,UAAU,EAAE,EAAE;QACd,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAE;QACZ,aAAa,EAAE,EAAE;QACjB,KAAK,EAAE,EAAE;QACT,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,EAAE;QACf,cAAc,EAAE,EAAE;QAClB,KAAK,EAAE,EAAE;QACT,SAAS,EAAE,EAAE;QACb,aAAa,EAAE,EAAE;QACjB,OAAO,EAAE,EAAE;QACX,aAAa,EAAE,EAAE;QACjB,kBAAkB,EAAE,EAAE;QACtB,cAAc,EAAE,EAAE;QAClB,SAAS,EAAE,EAAE;QACb,cAAc,EAAE,EAAE;QAClB,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;KACX;IACD,OAAO,EAAE,EAAE;CACd,CAAC"}
+{"version":3,"file":"default-config.js","sourceRoot":"","sources":["../../src/config/default-config.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AACnE,2EAI8C;AAE9C,iGAA2F;AAC3F,4FAAqF;AACrF,yHAAiH;AAEjH,yGAAmG;AACnG,yGAAmG;AACnG,kGAA4F;AAC5F,kGAA4F;AAC5F,8FAAwF;AACxF,sGAAgG;AAChG,0FAAqF;AACrF,qFAAgF;AAChF,qIAA6H;AAC7H,6FAAuF;AACvF,gGAA0F;AAC1F,yFAAoF;AACpF,4DAAwD;AACxD,6GAAsG;AACtG,yHAAiH;AACjH,yFAAmF;AACnF,iGAA2F;AAC3F,yEAAoE;AACpE,yFAAyF;AACzF,qEAAuE;AACvE,mEAA8D;AAC9D,2CAAkF;AAClF,uGAAgG;AAChG,+FAA0F;AAC1F,iHAA2G;AAC3G,uGAAgG;AAChG,+EAAyE;AAGzE;;;;;GAKG;AACU,QAAA,aAAa,GAAyB;IAC/C,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,8BAAY,CAAC,EAAE;IACpC,MAAM,EAAE,IAAI,8BAAa,EAAE;IAC3B,UAAU,EAAE;QACR,QAAQ,EAAE,EAAE;QACZ,IAAI,EAAE,IAAI;QACV,YAAY,EAAE,WAAW;QACzB,kBAAkB,EAAE,KAAK;QACzB,aAAa,EAAE,KAAK;QACpB,mBAAmB,EAAE,IAAI;QACzB,uBAAuB,EAAE,EAAE;QAC3B,WAAW,EAAE,UAAU;QACvB,iBAAiB,EAAE,KAAK;QACxB,YAAY,EAAE,KAAK;QACnB,kBAAkB,EAAE,GAAG;QACvB,sBAAsB,EAAE,EAAE;QAC1B,eAAe,EAAE,eAAe;QAChC,IAAI,EAAE;YACF,MAAM,EAAE,IAAI;YACZ,WAAW,EAAE,IAAI;SACpB;QACD,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAI;QACnB,mBAAmB,EAAE,EAAE;KAC1B;IACD,WAAW,EAAE;QACT,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,QAAQ;QACrB,aAAa,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAC5C,QAAQ,EAAE,IAAI;SACjB;QACD,kBAAkB,EAAE,gDAA6B;QACjD,eAAe,EAAE,IAAI;QACrB,oBAAoB,EAAE,IAAI,+DAA4B,EAAE;QACxD,eAAe,EAAE,GAAG;QACpB,mBAAmB,EAAE,IAAI;QACzB,yBAAyB,EAAE,IAAI;QAC/B,qBAAqB,EAAE;YACnB,UAAU,EAAE,8CAA2B;YACvC,QAAQ,EAAE,4CAAyB;SACtC;QACD,0BAA0B,EAAE,CAAC,IAAI,6DAA4B,EAAE,CAAC;QAChE,2BAA2B,EAAE,CAAC,IAAI,6DAA4B,EAAE,CAAC;QACjE,iBAAiB,EAAE,EAAE;QACrB,uBAAuB,EAAE,IAAI,gEAA6B,EAAE;QAC5D,0BAA0B,EAAE,IAAI,wEAAiC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;KACtF;IACD,cAAc,EAAE;QACZ,iBAAiB,EAAE,qDAAwB;QAC3C,sCAAsC,EAAE,IAAI,kGAA6C,EAAE;QAC3F,oBAAoB,EAAE,IAAI,4DAA2B,EAAE;KAC1D;IACD,gBAAgB,EAAE,IAAI,oDAAuB,EAAE;IAC/C,YAAY,EAAE;QACV,mBAAmB,EAAE,IAAI,0DAA0B,EAAE;QACrD,oBAAoB,EAAE,IAAI,kDAAsB,EAAE;QAClD,oBAAoB,EAAE,IAAI,kDAAsB,EAAE;QAClD,kBAAkB,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC;QAC7D,iBAAiB,EAAE,QAAQ;KAC9B;IACD,mBAAmB,EAAE;QACjB,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,OAAO;KAChB;IACD,aAAa,EAAE;QACX,eAAe,EAAE,KAAK;QACtB,YAAY,EAAE,KAAK;QACnB,iBAAiB,EAAE,EAAE;KACxB;IACD,gBAAgB,EAAE;QACd,mBAAmB,EAAE,sCAA0B;QAC/C,gBAAgB,EAAE,mCAAuB;KAC5C;IACD,eAAe,EAAE;QACb,2BAA2B,EAAE,CAAC,wEAAiC,CAAC;QAChE,mBAAmB,EAAE,CAAC,uDAAyB,CAAC;QAChD,wBAAwB,EAAE,EAAE;QAC5B,mBAAmB,EAAE,CAAC,qDAAwB,CAAC;KAClD;IACD,YAAY,EAAE;QACV,eAAe,EAAE,GAAG;QACpB,mBAAmB,EAAE,GAAG;QACxB,iCAAiC,EAAE,IAAI,wFAAwC,EAAE;QACjF,aAAa,EAAE,IAAI,2CAAmB,EAAE;QACxC,qBAAqB,EAAE,IAAI,qCAAgB,EAAE;QAC7C,OAAO,EAAE,EAAE;QACX,uBAAuB,EAAE,IAAI,kEAA8B,EAAE;QAC7D,iBAAiB,EAAE,IAAI,8CAAwB,EAAE;QACjD,yBAAyB,EAAE,IAAI,gEAAgC,CAAC,IAAI,CAAC;QACrE,4BAA4B,EAAE,IAAI,6EAAmC,EAAE;QACvE,mBAAmB,EAAE,IAAI,0DAA0B,EAAE;KACxD;IACD,cAAc,EAAE;QACZ,gCAAgC,EAAE,EAAE;QACpC,qBAAqB,EAAE,EAAE;QACzB,oBAAoB,EAAE,EAAE;KAC3B;IACD,UAAU,EAAE;QACR,eAAe,EAAE,IAAI,kDAAsB,EAAE;QAC7C,0BAA0B,EAAE,IAAI,yEAAiC,EAAE;KACtE;IACD,mBAAmB,EAAE;QACjB,eAAe,EAAE,SAAS;QAC1B,mBAAmB,EAAE,IAAI,0DAA0B,EAAE;KACxD;IACD,eAAe,EAAE;QACb,gBAAgB,EAAE,IAAI,uDAAwB,EAAE;QAChD,wBAAwB,EAAE,IAAI,wEAAgC,EAAE;QAChE,YAAY,EAAE,EAAE;QAChB,uBAAuB,EAAE,KAAK;QAC9B,MAAM,EAAE,EAAE;KACb;IACD,YAAY,EAAE;QACV,OAAO,EAAE,EAAE;QACX,aAAa,EAAE,EAAE;QACjB,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;QACX,UAAU,EAAE,EAAE;QACd,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAE;QACZ,aAAa,EAAE,EAAE;QACjB,KAAK,EAAE,EAAE;QACT,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,EAAE;QACf,cAAc,EAAE,EAAE;QAClB,KAAK,EAAE,EAAE;QACT,SAAS,EAAE,EAAE;QACb,aAAa,EAAE,EAAE;QACjB,OAAO,EAAE,EAAE;QACX,aAAa,EAAE,EAAE;QACjB,kBAAkB,EAAE,EAAE;QACtB,cAAc,EAAE,EAAE;QAClB,SAAS,EAAE,EAAE;QACb,cAAc,EAAE,EAAE;QAClB,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;KACX;IACD,OAAO,EAAE,EAAE;IACX,aAAa,EAAE;QACX,YAAY,EAAE,CAAC,IAAI,0DAA0B,EAAE,CAAC;KACnD;CACJ,CAAC"}

package/dist/config/entity-id-strategy/entity-id-strategy.d.ts

@@ -10,6 +10,13 @@ export declare type PrimaryKeyType<T> = T extends 'uuid' ? string : T extends 'i
  * but custom strategies can be used, e.g. to apply some custom encoding to the ID before exposing
  * it in the GraphQL API.
  *
+ * {{% 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 %}}
+ *
  * @docsCategory configuration
  * @docsPage EntityIdStrategy
  * */

package/dist/config/entity-metadata/add-foreign-key-indices.d.ts

@@ -0,0 +1,12 @@
+import { EntityMetadataModifier } from './entity-metadata-modifier';
+/**
+ * @description
+ * Dynamically adds `@Index()` metadata to all many-to-one relations. These are already added
+ * by default in MySQL/MariaDB, but not in Postgres. So this modification can lead to improved
+ * performance with Postgres - especially when dealing with large numbers of products, orders etc.
+ *
+ * See https://github.com/vendure-ecommerce/vendure/issues/1502
+ *
+ * TODO: In v2 we will add the Index to all relations manually, this making this redundant.
+ */
+export declare const addForeignKeyIndices: EntityMetadataModifier;

package/dist/config/entity-metadata/add-foreign-key-indices.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addForeignKeyIndices = void 0;
+const typeorm_1 = require("typeorm");
+const stock_movement_entity_1 = require("../../entity/stock-movement/stock-movement.entity");
+/**
+ * @description
+ * Dynamically adds `@Index()` metadata to all many-to-one relations. These are already added
+ * by default in MySQL/MariaDB, but not in Postgres. So this modification can lead to improved
+ * performance with Postgres - especially when dealing with large numbers of products, orders etc.
+ *
+ * See https://github.com/vendure-ecommerce/vendure/issues/1502
+ *
+ * TODO: In v2 we will add the Index to all relations manually, this making this redundant.
+ */
+const addForeignKeyIndices = (metadata) => {
+    var _a;
+    for (const relationMetadata of metadata.relations) {
+        const { relationType, target } = relationMetadata;
+        if (relationType === 'many-to-one') {
+            const embeddedIn = (_a = metadata.embeddeds.find(e => e.type() === relationMetadata.target)) === null || _a === void 0 ? void 0 : _a.target;
+            const targetClass = (embeddedIn !== null && embeddedIn !== void 0 ? embeddedIn : target);
+            if (typeof targetClass === 'function') {
+                const instance = new targetClass();
+                if (!(instance instanceof stock_movement_entity_1.StockMovement)) {
+                    (0, typeorm_1.Index)()(instance, relationMetadata.propertyName);
+                }
+            }
+        }
+    }
+};
+exports.addForeignKeyIndices = addForeignKeyIndices;
+//# sourceMappingURL=add-foreign-key-indices.js.map

package/dist/config/entity-metadata/add-foreign-key-indices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-foreign-key-indices.js","sourceRoot":"","sources":["../../../src/config/entity-metadata/add-foreign-key-indices.ts"],"names":[],"mappings":";;;AAAA,qCAAgC;AAGhC,6FAAkF;AAIlF;;;;;;;;;GASG;AACI,MAAM,oBAAoB,GAA2B,CAAC,QAA6B,EAAE,EAAE;;IAC1F,KAAK,MAAM,gBAAgB,IAAI,QAAQ,CAAC,SAAS,EAAE;QAC/C,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;QAClD,IAAI,YAAY,KAAK,aAAa,EAAE;YAChC,MAAM,UAAU,GAAG,MAAA,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,gBAAgB,CAAC,MAAM,CAAC,0CAAE,MAAM,CAAC;YAC9F,MAAM,WAAW,GAAG,CAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,MAAM,CAAwB,CAAC;YAClE,IAAI,OAAO,WAAW,KAAK,UAAU,EAAE;gBACnC,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;gBACnC,IAAI,CAAC,CAAC,QAAQ,YAAY,qCAAa,CAAC,EAAE;oBACtC,IAAA,eAAK,GAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;iBACpD;aACJ;SACJ;KACJ;AACL,CAAC,CAAC;AAdW,QAAA,oBAAoB,wBAc/B"}

package/dist/config/entity-metadata/entity-metadata-modifier.d.ts

@@ -0,0 +1,55 @@
+import { MetadataArgsStorage } from 'typeorm/metadata-args/MetadataArgsStorage';
+/**
+ * @description
+ * A function which allows TypeORM entity metadata to be manipulated prior to the DB schema being generated
+ * during bootstrap.
+ *
+ * {{% alert "warning" %}}
+ * Certain DB schema modifications will result in auto-generated migrations which will lead to data loss. For instance,
+ * changing the data type of a column will drop the column & data and then re-create it. To avoid loss of important data,
+ * always check and modify your migration scripts as needed.
+ * {{% /alert %}}
+ *
+ * @example
+ * ```TypeScript
+ * import { Index } from 'typeorm';
+ * import { EntityMetadataModifier, ProductVariant } from '\@vendure/core';
+ *
+ * // Adds a unique index to the ProductVariant.sku column
+ * export const addSkuUniqueIndex: EntityMetadataModifier = metadata => {
+ *   const instance = new ProductVariant();
+ *   Index({ unique: true })(instance, 'sku');
+ * };
+ * ```
+ *
+ * @example
+ * ```TypeScript
+ * import { Column } from 'typeorm';
+ * import { EntityMetadataModifier, ProductTranslation } from '\@vendure/core';
+ *
+ * // Use the "mediumtext" datatype for the Product's description rather than
+ * // the default "text" type.
+ * export const makeProductDescriptionMediumText: EntityMetadataModifier = metadata => {
+ *     const descriptionColumnIndex = metadata.columns.findIndex(
+ *         col => col.propertyName === 'description' && col.target === ProductTranslation,
+ *     );
+ *     if (-1 < descriptionColumnIndex) {
+ *         // First we need to remove the existing column definition
+ *         // from the metadata.
+ *         metadata.columns.splice(descriptionColumnIndex, 1);
+ *         // Then we add a new column definition with our custom
+ *         // data type "mediumtext"
+ *         // DANGER: this particular modification will generate a DB migration
+ *         // which will result in data loss of existing descriptions. Make sure
+ *         // to manually check & modify your migration scripts.
+ *         const instance = new ProductTranslation();
+ *         Column({ type: 'mediumtext' })(instance, 'description');
+ *     }
+ * };
+ * ```
+ *
+ * @docsCategory configuration
+ * @docsPage EntityOptions
+ * @since 1.6.0
+ */
+export declare type EntityMetadataModifier = (metadata: MetadataArgsStorage) => void | Promise<void>;

package/{cli/common/types/injectable-strategy.js → dist/config/entity-metadata/entity-metadata-modifier.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=injectable-strategy.js.map
+//# sourceMappingURL=entity-metadata-modifier.js.map

package/dist/config/entity-metadata/entity-metadata-modifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-metadata-modifier.js","sourceRoot":"","sources":["../../../src/config/entity-metadata/entity-metadata-modifier.ts"],"names":[],"mappings":""}

package/dist/config/fulfillment/custom-fulfillment-process.d.ts

@@ -1,6 +1,6 @@
 import { OnTransitionEndFn, OnTransitionErrorFn, OnTransitionStartFn, Transitions } from '../../common/finite-state-machine/types';
 import { InjectableStrategy } from '../../common/types/injectable-strategy';
-import { FulfillmentState, FulfillmentTransitionData } from '../../service/helpers/fulfillment-state-machine/fulfillment-state';
+import { CustomFulfillmentStates, FulfillmentState, FulfillmentTransitionData } from '../../service/helpers/fulfillment-state-machine/fulfillment-state';
 /**
  * @description
  * Used to define extensions to or modifications of the default fulfillment process.
@@ -9,7 +9,7 @@ import { FulfillmentState, FulfillmentTransitionData } from '../../service/helpe
  *
  * @docsCategory fulfillment
  */
-export interface CustomFulfillmentProcess<State extends string> extends InjectableStrategy {
+export interface CustomFulfillmentProcess<State extends keyof CustomFulfillmentStates | string> extends InjectableStrategy {
     transitions?: Transitions<State, State | FulfillmentState> & Partial<Transitions<FulfillmentState | State>>;
     onTransitionStart?: OnTransitionStartFn<State | FulfillmentState, FulfillmentTransitionData>;
     onTransitionEnd?: OnTransitionEndFn<State | FulfillmentState, FulfillmentTransitionData>;

package/dist/config/index.d.ts

@@ -1,3 +1,4 @@
+export * from './asset-import-strategy/asset-import-strategy';
 export * from './asset-naming-strategy/asset-naming-strategy';
 export * from './asset-naming-strategy/default-asset-naming-strategy';
 export * from './asset-preview-strategy/asset-preview-strategy';
@@ -18,6 +19,8 @@ export * from './default-config';
 export * from './entity-id-strategy/auto-increment-id-strategy';
 export * from './entity-id-strategy/entity-id-strategy';
 export * from './entity-id-strategy/uuid-id-strategy';
+export * from './entity-metadata/entity-metadata-modifier';
+export * from './entity-metadata/add-foreign-key-indices';
 export * from './fulfillment/custom-fulfillment-process';
 export * from './fulfillment/fulfillment-handler';
 export * from './fulfillment/manual-fulfillment-handler';
@@ -54,6 +57,7 @@ export * from './shipping-method/default-shipping-calculator';
 export * from './shipping-method/default-shipping-eligibility-checker';
 export * from './shipping-method/shipping-calculator';
 export * from './shipping-method/shipping-eligibility-checker';
+export * from './system/health-check-strategy';
 export * from './tax/default-tax-line-calculation-strategy';
 export * from './tax/default-tax-zone-strategy';
 export * from './tax/tax-line-calculation-strategy';

package/dist/config/index.js

@@ -10,6 +10,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./asset-import-strategy/asset-import-strategy"), exports);
 __exportStar(require("./asset-naming-strategy/asset-naming-strategy"), exports);
 __exportStar(require("./asset-naming-strategy/default-asset-naming-strategy"), exports);
 __exportStar(require("./asset-preview-strategy/asset-preview-strategy"), exports);
@@ -30,6 +31,8 @@ __exportStar(require("./default-config"), exports);
 __exportStar(require("./entity-id-strategy/auto-increment-id-strategy"), exports);
 __exportStar(require("./entity-id-strategy/entity-id-strategy"), exports);
 __exportStar(require("./entity-id-strategy/uuid-id-strategy"), exports);
+__exportStar(require("./entity-metadata/entity-metadata-modifier"), exports);
+__exportStar(require("./entity-metadata/add-foreign-key-indices"), exports);
 __exportStar(require("./fulfillment/custom-fulfillment-process"), exports);
 __exportStar(require("./fulfillment/fulfillment-handler"), exports);
 __exportStar(require("./fulfillment/manual-fulfillment-handler"), exports);
@@ -66,6 +69,7 @@ __exportStar(require("./shipping-method/default-shipping-calculator"), exports);
 __exportStar(require("./shipping-method/default-shipping-eligibility-checker"), exports);
 __exportStar(require("./shipping-method/shipping-calculator"), exports);
 __exportStar(require("./shipping-method/shipping-eligibility-checker"), exports);
+__exportStar(require("./system/health-check-strategy"), exports);
 __exportStar(require("./tax/default-tax-line-calculation-strategy"), exports);
 __exportStar(require("./tax/default-tax-zone-strategy"), exports);
 __exportStar(require("./tax/tax-line-calculation-strategy"), exports);

package/dist/config/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gFAA8D;AAC9D,wFAAsE;AACtE,kFAAgE;AAChE,kFAAgE;AAChE,iEAA+C;AAC/C,0EAAwD;AACxD,8EAA4D;AAC5D,wEAAsD;AACtD,mEAAiD;AACjD,sEAAoD;AACpD,8DAA4C;AAC5C,uEAAqD;AACrD,uFAAqE;AACrE,kDAAgC;AAChC,mDAAiC;AACjC,oEAAkD;AAClD,mDAAiC;AACjC,kFAAgE;AAChE,0EAAwD;AACxD,wEAAsD;AACtD,2EAAyD;AACzD,oEAAkD;AAClD,2EAAyD;AACzD,6EAA2D;AAC3D,iEAA+C;AAC/C,0DAAwC;AACxC,uDAAqC;AACrC,0DAAwC;AACxC,iDAA+B;AAC/B,0EAAwD;AACxD,+DAA6C;AAC7C,kFAAgE;AAChE,wEAAsD;AACtD,4EAA0D;AAC1D,gEAA8C;AAC9C,8DAA4C;AAC5C,gFAA8D;AAC9D,+DAA6C;AAC7C,gEAA8C;AAC9C,oEAAkD;AAClD,gEAA8C;AAC9C,+EAA6D;AAC7D,6DAA2C;AAC3C,mEAAiD;AACjD,yEAAuD;AACvD,2EAAyD;AACzD,+EAA6D;AAC7D,mEAAiD;AACjD,8CAA4B;AAC5B,mFAAiE;AACjE,8EAA4D;AAC5D,yEAAuD;AACvD,gFAA8D;AAC9D,yFAAuE;AACvE,wEAAsD;AACtD,iFAA+D;AAC/D,8EAA4D;AAC5D,kEAAgD;AAChD,sEAAoD;AACpD,0DAAwC;AACxC,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gFAA8D;AAC9D,gFAA8D;AAC9D,wFAAsE;AACtE,kFAAgE;AAChE,kFAAgE;AAChE,iEAA+C;AAC/C,0EAAwD;AACxD,8EAA4D;AAC5D,wEAAsD;AACtD,mEAAiD;AACjD,sEAAoD;AACpD,8DAA4C;AAC5C,uEAAqD;AACrD,uFAAqE;AACrE,kDAAgC;AAChC,mDAAiC;AACjC,oEAAkD;AAClD,mDAAiC;AACjC,kFAAgE;AAChE,0EAAwD;AACxD,wEAAsD;AACtD,6EAA2D;AAC3D,4EAA0D;AAC1D,2EAAyD;AACzD,oEAAkD;AAClD,2EAAyD;AACzD,6EAA2D;AAC3D,iEAA+C;AAC/C,0DAAwC;AACxC,uDAAqC;AACrC,0DAAwC;AACxC,iDAA+B;AAC/B,0EAAwD;AACxD,+DAA6C;AAC7C,kFAAgE;AAChE,wEAAsD;AACtD,4EAA0D;AAC1D,gEAA8C;AAC9C,8DAA4C;AAC5C,gFAA8D;AAC9D,+DAA6C;AAC7C,gEAA8C;AAC9C,oEAAkD;AAClD,gEAA8C;AAC9C,+EAA6D;AAC7D,6DAA2C;AAC3C,mEAAiD;AACjD,yEAAuD;AACvD,2EAAyD;AACzD,+EAA6D;AAC7D,mEAAiD;AACjD,8CAA4B;AAC5B,mFAAiE;AACjE,8EAA4D;AAC5D,yEAAuD;AACvD,gFAA8D;AAC9D,yFAAuE;AACvE,wEAAsD;AACtD,iFAA+D;AAC/D,iEAA+C;AAC/C,8EAA4D;AAC5D,kEAAgD;AAChD,sEAAoD;AACpD,0DAAwC;AACxC,mDAAiC"}

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

@@ -48,6 +48,7 @@ export interface VendureLogger {
     info(message: string, context?: string): void;
     verbose(message: string, context?: string): void;
     debug(message: string, context?: string): void;
+    setDefaultContext?(defaultContext: string): void;
 }
 /**
  * @description

package/dist/config/logger/vendure-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"vendure-logger.js","sourceRoot":"","sources":["../../../src/config/logger/vendure-logger.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,IAAY,QA6BX;AA7BD,WAAY,QAAQ;IAChB;;;;OAIG;IACH,yCAAS,CAAA;IACT;;;;OAIG;IACH,uCAAQ,CAAA;IACR;;;OAGG;IACH,uCAAQ,CAAA;IACR;;;OAGG;IACH,6CAAW,CAAA;IACX;;;;OAIG;IACH,yCAAS,CAAA;AACb,CAAC,EA7BW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA6BnB;AAiBD,MAAM,UAAU,GAAkB;IAC9B,KAAK;QACD,KAAK;IACT,CAAC;IACD,IAAI;QACA,KAAK;IACT,CAAC;IACD,IAAI;QACA,KAAK;IACT,CAAC;IACD,OAAO;QACH,KAAK;IACT,CAAC;IACD,KAAK;QACD,KAAK;IACT,CAAC;CACJ,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,MAAa,MAAM;IAIf,MAAM,KAAK,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC;IACtC,CAAC;IAED,IAAY,QAAQ;QAChB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,gBAAgB;IAChB,MAAM,CAAC,SAAS,CAAC,MAAqB;QAClC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC;IAC5B,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,OAAY,EAAE,KAAc,EAAE,OAAgB;QAChD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAED,gBAAgB;IAChB,IAAI,CAAC,OAAY,EAAE,OAAgB;QAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,gBAAgB;IAChB,GAAG,CAAC,OAAY,EAAE,OAAgB;QAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,gBAAgB;IAChB,OAAO,CAAC,OAAY,EAAE,OAAgB;QAClC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,OAAY,EAAE,OAAgB;QAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,OAAgB,EAAE,KAAc;QAC1D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,OAAgB;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,OAAgB;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,OAAe,EAAE,OAAgB;QAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,OAAgB;QAC1C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;;AA7DL,wBA8DC;AA7DkB,gBAAS,GAAkB,MAAM,CAAC"}
+{"version":3,"file":"vendure-logger.js","sourceRoot":"","sources":["../../../src/config/logger/vendure-logger.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,IAAY,QA6BX;AA7BD,WAAY,QAAQ;IAChB;;;;OAIG;IACH,yCAAS,CAAA;IACT;;;;OAIG;IACH,uCAAQ,CAAA;IACR;;;OAGG;IACH,uCAAQ,CAAA;IACR;;;OAGG;IACH,6CAAW,CAAA;IACX;;;;OAIG;IACH,yCAAS,CAAA;AACb,CAAC,EA7BW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA6BnB;AAkBD,MAAM,UAAU,GAAkB;IAC9B,KAAK;QACD,KAAK;IACT,CAAC;IACD,IAAI;QACA,KAAK;IACT,CAAC;IACD,IAAI;QACA,KAAK;IACT,CAAC;IACD,OAAO;QACH,KAAK;IACT,CAAC;IACD,KAAK;QACD,KAAK;IACT,CAAC;CACJ,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,MAAa,MAAM;IAIf,MAAM,KAAK,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC;IACtC,CAAC;IAED,IAAY,QAAQ;QAChB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,gBAAgB;IAChB,MAAM,CAAC,SAAS,CAAC,MAAqB;QAClC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC;IAC5B,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,OAAY,EAAE,KAAc,EAAE,OAAgB;QAChD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAED,gBAAgB;IAChB,IAAI,CAAC,OAAY,EAAE,OAAgB;QAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,gBAAgB;IAChB,GAAG,CAAC,OAAY,EAAE,OAAgB;QAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,gBAAgB;IAChB,OAAO,CAAC,OAAY,EAAE,OAAgB;QAClC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,OAAY,EAAE,OAAgB;QAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,OAAgB,EAAE,KAAc;QAC1D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,OAAgB;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,OAAgB;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,OAAe,EAAE,OAAgB;QAC5C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,OAAgB;QAC1C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;;AA7DL,wBA8DC;AA7DkB,gBAAS,GAAkB,MAAM,CAAC"}

package/dist/config/order/changed-price-handling-strategy.d.ts

@@ -2,6 +2,7 @@ import { RequestContext } from '../../api/common/request-context';
 import { PriceCalculationResult } from '../../common/types/common-types';
 import { InjectableStrategy } from '../../common/types/injectable-strategy';
 import { OrderItem } from '../../entity/order-item/order-item.entity';
+import { Order } from '../../entity/order/order.entity';
 /**
  * @description
  * This strategy defines how we handle the situation where an OrderItem exists in an Order, and
@@ -20,5 +21,5 @@ export interface ChangedPriceHandlingStrategy extends InjectableStrategy {
      * {@link OrderItemPriceCalculationStrategy}) differs from the initial price at the time
      * that the OrderLine was created.
      */
-    handlePriceChange(ctx: RequestContext, current: PriceCalculationResult, existingItems: OrderItem[]): PriceCalculationResult | Promise<PriceCalculationResult>;
+    handlePriceChange(ctx: RequestContext, current: PriceCalculationResult, existingItems: OrderItem[], order: Order): PriceCalculationResult | Promise<PriceCalculationResult>;
 }

package/dist/config/order/custom-order-process.d.ts

@@ -1,6 +1,6 @@
 import { OnTransitionEndFn, OnTransitionErrorFn, OnTransitionStartFn, Transitions } from '../../common/finite-state-machine/types';
 import { InjectableStrategy } from '../../common/types/injectable-strategy';
-import { OrderState, OrderTransitionData } from '../../service/helpers/order-state-machine/order-state';
+import { CustomOrderStates, OrderState, OrderTransitionData } from '../../service/helpers/order-state-machine/order-state';
 /**
  * @description
  * Used to define extensions to or modifications of the default order process.
@@ -9,7 +9,7 @@ import { OrderState, OrderTransitionData } from '../../service/helpers/order-sta
  *
  * @docsCategory orders
  */
-export interface CustomOrderProcess<State extends string> extends InjectableStrategy {
+export interface CustomOrderProcess<State extends keyof CustomOrderStates | string> extends InjectableStrategy {
     transitions?: Transitions<State, State | OrderState> & Partial<Transitions<OrderState | State>>;
     onTransitionStart?: OnTransitionStartFn<State | OrderState, OrderTransitionData>;
     onTransitionEnd?: OnTransitionEndFn<State | OrderState, OrderTransitionData>;

package/dist/config/order/order-item-price-calculation-strategy.d.ts

@@ -1,6 +1,7 @@
 import { RequestContext } from '../../api/common/request-context';
 import { PriceCalculationResult } from '../../common/types/common-types';
 import { InjectableStrategy } from '../../common/types/injectable-strategy';
+import { Order } from '../../entity/order/order.entity';
 import { ProductVariant } from '../../entity/product-variant/product-variant.entity';
 /**
  * @description
@@ -47,8 +48,11 @@ export interface OrderItemPriceCalculationStrategy extends InjectableStrategy {
      * @description
      * Receives the ProductVariant to be added to the Order as well as any OrderLine custom fields and returns
      * the price for a single unit.
+     *
+     * Note: if you have any `relation` type custom fields defined on the OrderLine entity, they will only be
+     * passed in to this method if they are set to `eager: true`.
      */
     calculateUnitPrice(ctx: RequestContext, productVariant: ProductVariant, orderLineCustomFields: {
         [key: string]: any;
-    }): PriceCalculationResult | Promise<PriceCalculationResult>;
+    }, order: Order): PriceCalculationResult | Promise<PriceCalculationResult>;
 }

package/dist/config/payment/custom-payment-process.d.ts

@@ -1,6 +1,6 @@
 import { OnTransitionEndFn, OnTransitionErrorFn, OnTransitionStartFn, Transitions } from '../../common/finite-state-machine/types';
 import { InjectableStrategy } from '../../common/types/injectable-strategy';
-import { PaymentState, PaymentTransitionData } from '../../service/helpers/payment-state-machine/payment-state';
+import { CustomPaymentStates, PaymentState, PaymentTransitionData } from '../../service/helpers/payment-state-machine/payment-state';
 /**
  * @description
  * Used to define extensions to or modifications of the default payment process.
@@ -9,7 +9,7 @@ import { PaymentState, PaymentTransitionData } from '../../service/helpers/payme
  *
  * @docsCategory fulfillment
  */
-export interface CustomPaymentProcess<State extends string> extends InjectableStrategy {
+export interface CustomPaymentProcess<State extends keyof CustomPaymentStates | string> extends InjectableStrategy {
     transitions?: Transitions<State, State | PaymentState> & Partial<Transitions<PaymentState | State>>;
     onTransitionStart?: OnTransitionStartFn<State | PaymentState, PaymentTransitionData>;
     onTransitionEnd?: OnTransitionEndFn<State | PaymentState, PaymentTransitionData>;

package/dist/config/payment/dummy-payment-method-handler.js

@@ -52,7 +52,7 @@ exports.dummyPaymentHandler = new payment_method_handler_1.PaymentMethodHandler(
             defaultValue: false,
         },
     },
-    createPayment: async (ctx, order, amount, args, metadata) => {
+    createPayment: async (ctx, order, amount, args, metadata, method) => {
         if (metadata.shouldDecline) {
             return {
                 amount,
@@ -81,7 +81,7 @@ exports.dummyPaymentHandler = new payment_method_handler_1.PaymentMethodHandler(
             };
         }
     },
-    settlePayment: async (ctx, order, payment, args) => {
+    settlePayment: async (ctx, order, payment, args, method) => {
         if (payment.metadata.shouldErrorOnSettle) {
             return {
                 success: false,
@@ -92,5 +92,13 @@ exports.dummyPaymentHandler = new payment_method_handler_1.PaymentMethodHandler(
             success: true,
         };
     },
+    cancelPayment: (ctx, order, payment) => {
+        return {
+            success: true,
+            metadata: {
+                cancellationDate: new Date().toISOString(),
+            },
+        };
+    },
 });
 //# sourceMappingURL=dummy-payment-method-handler.js.map

package/dist/config/payment/dummy-payment-method-handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"dummy-payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/dummy-payment-method-handler.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAEnE,qEAAqF;AAErF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,mBAAmB,GAAG,IAAI,6CAAoB,CAAC;IACxD,IAAI,EAAE,uBAAuB;IAC7B,WAAW,EAAE;QACT;YACI,YAAY,EAAE,8BAAY,CAAC,EAAE;YAC7B,KAAK,EAAE,qEAAqE;SAC/E;KACJ;IACD,IAAI,EAAE;QACF,eAAe,EAAE;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE;gBACH;oBACI,YAAY,EAAE,8BAAY,CAAC,EAAE;oBAC7B,KAAK,EAAE,gCAAgC;iBAC1C;aACJ;YACD,WAAW,EAAE;gBACT;oBACI,YAAY,EAAE,8BAAY,CAAC,EAAE;oBAC7B,KAAK,EAAE,8DAA8D;iBACxE;aACJ;YACD,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,KAAK;SACtB;KACJ;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QACxD,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,UAAmB;gBAC1B,QAAQ,EAAE;oBACN,YAAY,EAAE,mBAAmB;iBACpC;aACJ,CAAC;SACL;aAAM,IAAI,QAAQ,CAAC,WAAW,EAAE;YAC7B,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,OAAgB;gBACvB,YAAY,EAAE,iBAAiB;gBAC/B,QAAQ,EAAE;oBACN,YAAY,EAAE,iBAAiB;iBAClC;aACJ,CAAC;SACL;aAAM;YACH,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY;gBACtD,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;gBACnD,QAAQ;aACX,CAAC;SACL;IACL,CAAC;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QAC/C,IAAI,OAAO,CAAC,QAAQ,CAAC,mBAAmB,EAAE;YACtC,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,4BAA4B;aAC7C,CAAC;SACL;QACD,OAAO;YACH,OAAO,EAAE,IAAI;SAChB,CAAC;IACN,CAAC;CACJ,CAAC,CAAC"}
+{"version":3,"file":"dummy-payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/dummy-payment-method-handler.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAEnE,qEAAqF;AAErF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,mBAAmB,GAAG,IAAI,6CAAoB,CAAC;IACxD,IAAI,EAAE,uBAAuB;IAC7B,WAAW,EAAE;QACT;YACI,YAAY,EAAE,8BAAY,CAAC,EAAE;YAC7B,KAAK,EAAE,qEAAqE;SAC/E;KACJ;IACD,IAAI,EAAE;QACF,eAAe,EAAE;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE;gBACH;oBACI,YAAY,EAAE,8BAAY,CAAC,EAAE;oBAC7B,KAAK,EAAE,gCAAgC;iBAC1C;aACJ;YACD,WAAW,EAAE;gBACT;oBACI,YAAY,EAAE,8BAAY,CAAC,EAAE;oBAC7B,KAAK,EAAE,8DAA8D;iBACxE;aACJ;YACD,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,KAAK;SACtB;KACJ;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;QAChE,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,UAAmB;gBAC1B,QAAQ,EAAE;oBACN,YAAY,EAAE,mBAAmB;iBACpC;aACJ,CAAC;SACL;aAAM,IAAI,QAAQ,CAAC,WAAW,EAAE;YAC7B,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,OAAgB;gBACvB,YAAY,EAAE,iBAAiB;gBAC/B,QAAQ,EAAE;oBACN,YAAY,EAAE,iBAAiB;iBAClC;aACJ,CAAC;SACL;aAAM;YACH,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY;gBACtD,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;gBACnD,QAAQ;aACX,CAAC;SACL;IACL,CAAC;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;QACvD,IAAI,OAAO,CAAC,QAAQ,CAAC,mBAAmB,EAAE;YACtC,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,4BAA4B;aAC7C,CAAC;SACL;QACD,OAAO;YACH,OAAO,EAAE,IAAI;SAChB,CAAC;IACN,CAAC;IACD,aAAa,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QACnC,OAAO;YACH,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE;gBACN,gBAAgB,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;aAC7C;SACJ,CAAC;IACN,CAAC;CACJ,CAAC,CAAC"}

package/dist/config/payment/example-payment-method-handler.js

@@ -29,7 +29,7 @@ exports.examplePaymentHandler = new payment_method_handler_1.PaymentMethodHandle
         automaticCapture: { type: 'boolean', required: false },
         apiKey: { type: 'string', required: false },
     },
-    createPayment: async (ctx, order, amount, args, metadata) => {
+    createPayment: async (ctx, order, amount, args, metadata, method) => {
         try {
             const result = await gripeSDK.charges.create({
                 apiKey: args.apiKey,
@@ -53,7 +53,7 @@ exports.examplePaymentHandler = new payment_method_handler_1.PaymentMethodHandle
             };
         }
     },
-    settlePayment: async (ctx, order, payment, args) => {
+    settlePayment: async (ctx, order, payment, args, method) => {
         const result = await gripeSDK.charges.capture(payment.transactionId);
         return {
             success: result,

package/dist/config/payment/example-payment-method-handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"example-payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/example-payment-method-handler.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAEnE,qEAAqF;AAErF;;GAEG;AACH,MAAM,QAAQ,GAAG;IACb,OAAO,EAAE;QACL,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;YACrB,OAAO,OAAO,CAAC,OAAO,CAAC;gBACnB,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;aAC3C,CAAC,CAAC;QACP,CAAC;QACD,OAAO,EAAE,CAAC,aAAqB,EAAE,EAAE;YAC/B,OAAO,IAAI,CAAC;QAChB,CAAC;KACJ;CACJ,CAAC;AAEF;;;GAGG;AACU,QAAA,qBAAqB,GAAG,IAAI,6CAAoB,CAAC;IAC1D,IAAI,EAAE,0BAA0B;IAChC,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,0BAA0B,EAAE,CAAC;IACnF,IAAI,EAAE;QACF,gBAAgB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE;QACtD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;KAC9C;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAgC,EAAE;QACtF,IAAI;YACA,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;gBACzC,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,MAAM;gBACN,MAAM,EAAE,QAAQ,CAAC,SAAS;aAC7B,CAAC,CAAC;YACH,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY;gBACvD,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACnC,QAAQ;aACX,CAAC;SACL;QAAC,OAAO,GAAQ,EAAE;YACf,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,UAAwB;gBAC/B,QAAQ,EAAE;oBACN,YAAY,EAAE,GAAG,CAAC,OAAO;iBAC5B;aACJ,CAAC;SACL;IACL,CAAC;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QAC/C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACrE,OAAO;YACH,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE;gBACN,SAAS,EAAE,SAAS;aACvB;SACJ,CAAC;IACN,CAAC;CACJ,CAAC,CAAC"}
+{"version":3,"file":"example-payment-method-handler.js","sourceRoot":"","sources":["../../../src/config/payment/example-payment-method-handler.ts"],"names":[],"mappings":";;;AAAA,yEAAmE;AAEnE,qEAAqF;AAErF;;GAEG;AACH,MAAM,QAAQ,GAAG;IACb,OAAO,EAAE;QACL,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;YACrB,OAAO,OAAO,CAAC,OAAO,CAAC;gBACnB,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;aAC3C,CAAC,CAAC;QACP,CAAC;QACD,OAAO,EAAE,CAAC,aAAqB,EAAE,EAAE;YAC/B,OAAO,IAAI,CAAC;QAChB,CAAC;KACJ;CACJ,CAAC;AAEF;;;GAGG;AACU,QAAA,qBAAqB,GAAG,IAAI,6CAAoB,CAAC;IAC1D,IAAI,EAAE,0BAA0B;IAChC,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,8BAAY,CAAC,EAAE,EAAE,KAAK,EAAE,0BAA0B,EAAE,CAAC;IACnF,IAAI,EAAE;QACF,gBAAgB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE;QACtD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;KAC9C;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAgC,EAAE;QAC9F,IAAI;YACA,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;gBACzC,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,MAAM;gBACN,MAAM,EAAE,QAAQ,CAAC,SAAS;aAC7B,CAAC,CAAC;YACH,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY;gBACvD,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACnC,QAAQ;aACX,CAAC;SACL;QAAC,OAAO,GAAQ,EAAE;YACf,OAAO;gBACH,MAAM;gBACN,KAAK,EAAE,UAAwB;gBAC/B,QAAQ,EAAE;oBACN,YAAY,EAAE,GAAG,CAAC,OAAO;iBAC5B;aACJ,CAAC;SACL;IACL,CAAC;IACD,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;QACvD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACrE,OAAO;YACH,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE;gBACN,SAAS,EAAE,SAAS;aACvB;SACJ,CAAC;IACN,CAAC;CACJ,CAAC,CAAC"}

package/dist/config/payment/payment-method-eligibility-checker.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 { Order, PaymentMethod } from '../../entity';
 /**
  * @description
  * Configuration passed into the constructor of a {@link PaymentMethodEligibilityChecker} to
@@ -45,7 +45,7 @@ export declare class PaymentMethodEligibilityChecker<T extends ConfigArgs = Conf
      *
      * @internal
      */
-    check(ctx: RequestContext, order: Order, args: ConfigArg[]): Promise<boolean | string>;
+    check(ctx: RequestContext, order: Order, args: ConfigArg[], method: PaymentMethod): Promise<boolean | string>;
 }
 /**
  * @description
@@ -57,4 +57,4 @@ export declare class PaymentMethodEligibilityChecker<T extends ConfigArgs = Conf
  * @docsCategory payment
  * @docsPage PaymentMethodEligibilityChecker
  */
-export declare type CheckPaymentMethodEligibilityCheckerFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>) => boolean | string | Promise<boolean | string>;
+export declare type CheckPaymentMethodEligibilityCheckerFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, args: ConfigArgValues<T>, method: PaymentMethod) => boolean | string | Promise<boolean | string>;

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

@@ -36,8 +36,8 @@ class PaymentMethodEligibilityChecker extends configurable_operation_1.Configura
      *
      * @internal
      */
-    async check(ctx, order, args) {
-        return this.checkFn(ctx, order, this.argsArrayToHash(args));
+    async check(ctx, order, args, method) {
+        return this.checkFn(ctx, order, this.argsArrayToHash(args), method);
     }
 }
 exports.PaymentMethodEligibilityChecker = PaymentMethodEligibilityChecker;

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

@@ -1 +1 @@
-{"version":3,"file":"payment-method-eligibility-checker.js","sourceRoot":"","sources":["../../../src/config/payment/payment-method-eligibility-checker.ts"],"names":[],"mappings":";;;AAGA,gFAK6C;AAe7C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,+BAEX,SAAQ,iDAA2B;IAGjC,YAAY,MAAgD;QACxD,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,GAAmB,EAAE,KAAY,EAAE,IAAiB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,CAAC;CACJ;AAnBD,0EAmBC"}
+{"version":3,"file":"payment-method-eligibility-checker.js","sourceRoot":"","sources":["../../../src/config/payment/payment-method-eligibility-checker.ts"],"names":[],"mappings":";;;AAGA,gFAK6C;AAe7C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,+BAEX,SAAQ,iDAA2B;IAGjC,YAAY,MAAgD;QACxD,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CACP,GAAmB,EACnB,KAAY,EACZ,IAAiB,EACjB,MAAqB;QAErB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;CACJ;AAxBD,0EAwBC"}

package/dist/config/payment/payment-method-handler.d.ts

@@ -3,8 +3,7 @@ import { RequestContext } from '../../api/common/request-context';
 import { ConfigArgs, ConfigArgValues, ConfigurableOperationDef, ConfigurableOperationDefOptions } from '../../common/configurable-operation';
 import { OnTransitionStartFn, StateMachineConfig } from '../../common/finite-state-machine/types';
 import { PaymentMetadata } from '../../common/types/common-types';
-import { Order } from '../../entity/order/order.entity';
-import { Payment } from '../../entity/payment/payment.entity';
+import { Order, Payment, PaymentMethod } from '../../entity';
 import { PaymentState, PaymentTransitionData } from '../../service/helpers/payment-state-machine/payment-state';
 import { RefundState } from '../../service/helpers/refund-state-machine/refund-state';
 export declare type OnPaymentTransitionStartReturnType = ReturnType<Required<StateMachineConfig<any>>['onTransitionStart']>;
@@ -125,6 +124,45 @@ export interface SettlePaymentErrorResult {
     errorMessage?: string;
     metadata?: PaymentMetadata;
 }
+/**
+ * @description
+ * This object is the return value of the {@link CancelPaymentFn} when the Payment
+ * has been successfully cancelled.
+ *
+ * @docsCategory payment
+ * @docsPage Payment Method Types
+ */
+export interface CancelPaymentResult {
+    success: true;
+    metadata?: PaymentMetadata;
+}
+/**
+ * @description
+ * This object is the return value of the {@link CancelPaymentFn} when the Payment
+ * could not be cancelled.
+ *
+ * @docsCategory payment
+ * @docsPage Payment Method Types
+ */
+export interface CancelPaymentErrorResult {
+    success: false;
+    /**
+     * @description
+     * The state to transition this Payment to upon unsuccessful cancellation.
+     * Defaults to `Error`. Note that if using a different state, it must be
+     * legal to transition to that state from the `Authorized` state according
+     * to the PaymentState config (which can be customized using the
+     * {@link CustomPaymentProcess}).
+     */
+    state?: Exclude<PaymentState, 'Cancelled'>;
+    /**
+     * @description
+     * The message that will be returned when attempting to cancel the payment, and will
+     * also be persisted as `Payment.errorMessage`.
+     */
+    errorMessage?: string;
+    metadata?: PaymentMetadata;
+}
 /**
  * @description
  * This function contains the logic for creating a payment. See {@link PaymentMethodHandler} for an example.
@@ -134,7 +172,7 @@ export interface SettlePaymentErrorResult {
  * @docsCategory payment
  * @docsPage Payment Method Types
  */
-export declare type CreatePaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, amount: number, args: ConfigArgValues<T>, metadata: PaymentMetadata) => CreatePaymentResult | CreatePaymentErrorResult | Promise<CreatePaymentResult | CreatePaymentErrorResult>;
+export declare type CreatePaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, amount: number, args: ConfigArgValues<T>, metadata: PaymentMetadata, method: PaymentMethod) => CreatePaymentResult | CreatePaymentErrorResult | Promise<CreatePaymentResult | CreatePaymentErrorResult>;
 /**
  * @description
  * This function contains the logic for settling a payment. See {@link PaymentMethodHandler} for an example.
@@ -142,7 +180,15 @@ export declare type CreatePaymentFn<T extends ConfigArgs> = (ctx: RequestContext
  * @docsCategory payment
  * @docsPage Payment Method Types
  */
-export declare type SettlePaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, payment: Payment, args: ConfigArgValues<T>) => SettlePaymentResult | SettlePaymentErrorResult | Promise<SettlePaymentResult | SettlePaymentErrorResult>;
+export declare type SettlePaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, payment: Payment, args: ConfigArgValues<T>, method: PaymentMethod) => SettlePaymentResult | SettlePaymentErrorResult | Promise<SettlePaymentResult | SettlePaymentErrorResult>;
+/**
+ * @description
+ * This function contains the logic for cancelling a payment. See {@link PaymentMethodHandler} for an example.
+ *
+ * @docsCategory payment
+ * @docsPage Payment Method Types
+ */
+export declare type CancelPaymentFn<T extends ConfigArgs> = (ctx: RequestContext, order: Order, payment: Payment, args: ConfigArgValues<T>, method: PaymentMethod) => CancelPaymentResult | CancelPaymentErrorResult | Promise<CancelPaymentResult | CancelPaymentErrorResult>;
 /**
  * @description
  * This function contains the logic for creating a refund. See {@link PaymentMethodHandler} for an example.
@@ -150,7 +196,7 @@ export declare type SettlePaymentFn<T extends ConfigArgs> = (ctx: RequestContext
  * @docsCategory payment
  * @docsPage Payment Method Types
  */
-export declare type CreateRefundFn<T extends ConfigArgs> = (ctx: RequestContext, input: RefundOrderInput, amount: number, order: Order, payment: Payment, args: ConfigArgValues<T>) => CreateRefundResult | Promise<CreateRefundResult>;
+export declare type CreateRefundFn<T extends ConfigArgs> = (ctx: RequestContext, input: RefundOrderInput, amount: number, order: Order, payment: Payment, args: ConfigArgValues<T>, method: PaymentMethod) => CreateRefundResult | Promise<CreateRefundResult>;
 /**
  * @description
  * Defines the object which is used to construct the {@link PaymentMethodHandler}.
@@ -173,6 +219,17 @@ export interface PaymentMethodConfigOptions<T extends ConfigArgs> extends Config
      * need only return `{ success: true }`.
      */
     settlePayment: SettlePaymentFn<T>;
+    /**
+     * @description
+     * This function provides the logic for cancelling a payment, which would be invoked when a call is
+     * made to the `cancelPayment` mutation in the Admin API. Cancelling a payment can apply
+     * if, for example, you have created a "payment intent" with the payment provider but not yet
+     * completed the payment. It allows the incomplete payment to be cleaned up on the provider's end
+     * if it gets cancelled via Vendure.
+     *
+     * @since 1.7.0
+     */
+    cancelPayment?: CancelPaymentFn<T>;
     /**
      * @description
      * This function provides the logic for refunding a payment created with this
@@ -247,6 +304,7 @@ export interface PaymentMethodConfigOptions<T extends ConfigArgs> extends Config
 export declare class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> extends ConfigurableOperationDef<T> {
     private readonly createPaymentFn;
     private readonly settlePaymentFn;
+    private readonly cancelPaymentFn?;
     private readonly createRefundFn?;
     private readonly onTransitionStartFn?;
     constructor(config: PaymentMethodConfigOptions<T>);
@@ -256,7 +314,7 @@ export declare class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> ext
      *
      * @internal
      */
-    createPayment(ctx: RequestContext, order: Order, amount: number, args: ConfigArg[], metadata: PaymentMetadata): Promise<{
+    createPayment(ctx: RequestContext, order: Order, amount: number, args: ConfigArg[], metadata: PaymentMetadata, method: PaymentMethod): Promise<{
         /**
          * @description
          * The amount (as an integer - i.e. $10 = `1000`) that this payment is for.
@@ -304,14 +362,21 @@ export declare class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> ext
      *
      * @internal
      */
-    settlePayment(ctx: RequestContext, order: Order, payment: Payment, args: ConfigArg[]): Promise<SettlePaymentResult | SettlePaymentErrorResult>;
+    settlePayment(ctx: RequestContext, order: Order, payment: Payment, args: ConfigArg[], method: PaymentMethod): Promise<SettlePaymentResult | SettlePaymentErrorResult>;
+    /**
+     * @description
+     * Called internally to cancel a payment
+     *
+     * @internal
+     */
+    cancelPayment(ctx: RequestContext, order: Order, payment: Payment, args: ConfigArg[], method: PaymentMethod): Promise<CancelPaymentResult | CancelPaymentErrorResult | undefined>;
     /**
      * @description
      * Called internally to create a refund
      *
      * @internal
      */
-    createRefund(ctx: RequestContext, input: RefundOrderInput, amount: number, order: Order, payment: Payment, args: ConfigArg[]): Promise<false | CreateRefundResult>;
+    createRefund(ctx: RequestContext, input: RefundOrderInput, amount: number, order: Order, payment: Payment, args: ConfigArg[], method: PaymentMethod): Promise<false | CreateRefundResult>;
     /**
      * @description
      * This function is called before the state of a Payment is transitioned. If the PaymentMethodHandler