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

package/dist/event-bus/event-bus.js

@@ -13,6 +13,7 @@ exports.EventBus = void 0;
 const common_1 = require("@nestjs/common");
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
+const shared_utils_1 = require("../../../common/lib/shared-utils");
 const request_context_1 = require("../api/common/request-context");
 const constants_1 = require("../common/constants");
 const transaction_subscriber_1 = require("../connection/transaction-subscriber");
@@ -82,7 +83,7 @@ let EventBus = class EventBus {
      * data related to the event.
      */
     ofType(type) {
-        return this.eventStream.asObservable().pipe((0, operators_1.takeUntil)(this.destroy$), (0, operators_1.filter)(e => e.constructor === type), (0, operators_1.mergeMap)(event => this.awaitActiveTransactions(event)));
+        return this.eventStream.asObservable().pipe((0, operators_1.takeUntil)(this.destroy$), (0, operators_1.filter)(e => e.constructor === type), (0, operators_1.mergeMap)(event => this.awaitActiveTransactions(event)), (0, operators_1.filter)(shared_utils_1.notNullOrUndefined));
     }
     /** @internal */
     onModuleDestroy() {
@@ -108,15 +109,34 @@ let EventBus = class EventBus {
      * * https://github.com/vendure-ecommerce/vendure/issues/1107
      */
     async awaitActiveTransactions(event) {
-        const ctx = Object.values(event).find(value => value instanceof request_context_1.RequestContext);
-        if (!ctx) {
+        const entry = Object.entries(event).find(([_, value]) => value instanceof request_context_1.RequestContext);
+        if (!entry) {
             return event;
         }
+        const [key, ctx] = entry;
         const transactionManager = ctx[constants_1.TRANSACTION_MANAGER_KEY];
         if (!(transactionManager === null || transactionManager === void 0 ? void 0 : transactionManager.queryRunner)) {
             return event;
         }
-        return this.transactionSubscriber.awaitRelease(transactionManager.queryRunner).then(() => event);
+        try {
+            await this.transactionSubscriber.awaitCommit(transactionManager.queryRunner);
+            // Copy context and remove transaction manager
+            // This will prevent queries to released query runner
+            const newContext = ctx.copy();
+            delete newContext[constants_1.TRANSACTION_MANAGER_KEY];
+            // Reassign new context
+            event[key] = newContext;
+            return event;
+        }
+        catch (e) {
+            if (e instanceof transaction_subscriber_1.TransactionSubscriberError) {
+                // Expected commit, but rollback or something else happened.
+                // This is still reliable behavior, return undefined
+                // as event should not be exposed from this transaction
+                return;
+            }
+            throw e;
+        }
     }
 };
 EventBus = __decorate([

package/dist/event-bus/event-bus.js.map

@@ -1 +1 @@
-{"version":3,"file":"event-bus.js","sourceRoot":"","sources":["../../src/event-bus/event-bus.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA6D;AAE7D,+BAA2C;AAC3C,8CAA6D;AAG7D,mEAA+D;AAC/D,mDAA8D;AAC9D,iFAA6E;AAI7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA0CK;AAEL,IAAa,QAAQ,GAArB,MAAa,QAAQ;IAIjB,YAAoB,qBAA4C;QAA5C,0BAAqB,GAArB,qBAAqB,CAAuB;QAHxD,gBAAW,GAAG,IAAI,cAAO,EAAgB,CAAC;QAC1C,aAAQ,GAAG,IAAI,cAAO,EAAQ,CAAC;IAE4B,CAAC;IAEpE;;;OAGG;IACH,OAAO,CAAyB,KAAQ;QACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAyB,IAAa;QACxC,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,IAAI,CACvC,IAAA,qBAAS,EAAC,IAAI,CAAC,QAAQ,CAAC,EACxB,IAAA,kBAAM,EAAC,CAAC,CAAC,EAAE,CAAE,CAAS,CAAC,WAAW,KAAK,IAAI,CAAC,EAC5C,IAAA,oBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CACxC,CAAC;IACvB,CAAC;IAED,gBAAgB;IAChB,eAAe;QACX,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACK,KAAK,CAAC,uBAAuB,CAAyB,KAAQ;QAClE,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,YAAY,gCAAc,CAAC,CAAC;QAChF,IAAI,CAAC,GAAG,EAAE;YACN,OAAO,KAAK,CAAC;SAChB;QACD,MAAM,kBAAkB,GAA+B,GAAW,CAAC,mCAAuB,CAAC,CAAC;QAC5F,IAAI,CAAC,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,WAAW,CAAA,EAAE;YAClC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IACrG,CAAC;CACJ,CAAA;AAlEY,QAAQ;IADpB,IAAA,mBAAU,GAAE;qCAKkC,8CAAqB;GAJvD,QAAQ,CAkEpB;AAlEY,4BAAQ"}
+{"version":3,"file":"event-bus.js","sourceRoot":"","sources":["../../src/event-bus/event-bus.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA6D;AAE7D,+BAA2C;AAC3C,8CAA6D;AAE7D,mEAAsE;AAEtE,mEAA+D;AAC/D,mDAA8D;AAC9D,iFAAyG;AAIzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA0CK;AAEL,IAAa,QAAQ,GAArB,MAAa,QAAQ;IAIjB,YAAoB,qBAA4C;QAA5C,0BAAqB,GAArB,qBAAqB,CAAuB;QAHxD,gBAAW,GAAG,IAAI,cAAO,EAAgB,CAAC;QAC1C,aAAQ,GAAG,IAAI,cAAO,EAAQ,CAAC;IAE4B,CAAC;IAEpE;;;OAGG;IACH,OAAO,CAAyB,KAAQ;QACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAyB,IAAa;QACxC,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,IAAI,CACvC,IAAA,qBAAS,EAAC,IAAI,CAAC,QAAQ,CAAC,EACxB,IAAA,kBAAM,EAAC,CAAC,CAAC,EAAE,CAAE,CAAS,CAAC,WAAW,KAAK,IAAI,CAAC,EAC5C,IAAA,oBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,EACtD,IAAA,kBAAM,EAAC,iCAAkB,CAAC,CACZ,CAAC;IACvB,CAAC;IAED,gBAAgB;IAChB,eAAe;QACX,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACK,KAAK,CAAC,uBAAuB,CAAyB,KAAQ;QAClE,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,YAAY,gCAAc,CAAC,CAAC;QAE1F,IAAI,CAAC,KAAK,EAAE;YACR,OAAO,KAAK,CAAC;SAChB;QAED,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAA6B,KAAK,CAAC;QAEnD,MAAM,kBAAkB,GAA+B,GAAW,CAAC,mCAAuB,CAAC,CAAC;QAC5F,IAAI,CAAC,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,WAAW,CAAA,EAAE;YAClC,OAAO,KAAK,CAAC;SAChB;QAED,IAAI;YACA,MAAM,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;YAE7E,8CAA8C;YAC9C,qDAAqD;YACrD,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;YAC9B,OAAQ,UAAkB,CAAC,mCAAuB,CAAC,CAAC;YAEpD,uBAAuB;YACtB,KAAa,CAAC,GAAG,CAAC,GAAG,UAAU,CAAA;YAEhC,OAAO,KAAK,CAAC;SAChB;QAAC,OAAO,CAAM,EAAE;YACb,IAAI,CAAC,YAAY,mDAA0B,EAAE;gBACzC,4DAA4D;gBAC5D,oDAAoD;gBACpD,uDAAuD;gBACvD,OAAO;aACV;YAED,MAAM,CAAC,CAAC;SACX;IACL,CAAC;CACJ,CAAA;AA7FY,QAAQ;IADpB,IAAA,mBAAU,GAAE;qCAKkC,8CAAqB;GAJvD,QAAQ,CA6FpB;AA7FY,4BAAQ"}

package/dist/event-bus/events/initializer-event.d.ts

@@ -0,0 +1,12 @@
+import { VendureEvent } from '../vendure-event';
+/**
+ * @description
+ * This event is fired when vendure finished initializing its services inside the {@code InitializerService}
+ *
+ * @docsCategory events
+ * @docsPage Event Types
+ * @since 1.7.0
+ */
+export declare class InitializerEvent extends VendureEvent {
+    constructor();
+}

package/dist/event-bus/events/initializer-event.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InitializerEvent = void 0;
+const vendure_event_1 = require("../vendure-event");
+/**
+ * @description
+ * This event is fired when vendure finished initializing its services inside the {@code InitializerService}
+ *
+ * @docsCategory events
+ * @docsPage Event Types
+ * @since 1.7.0
+ */
+class InitializerEvent extends vendure_event_1.VendureEvent {
+    constructor() {
+        super();
+    }
+}
+exports.InitializerEvent = InitializerEvent;
+//# sourceMappingURL=initializer-event.js.map

package/dist/event-bus/events/initializer-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initializer-event.js","sourceRoot":"","sources":["../../../src/event-bus/events/initializer-event.ts"],"names":[],"mappings":";;;AAAA,oDAAgD;AAEhD;;;;;;;GAOG;AACH,MAAa,gBAAiB,SAAQ,4BAAY;IAC9C;QACI,KAAK,EAAE,CAAC;IACZ,CAAC;CACJ;AAJD,4CAIC"}

package/dist/event-bus/events/product-option-event.d.ts

@@ -13,6 +13,6 @@ declare type ProductOptionInputTypes = CreateGroupOptionInput | CreateProductOpt
  * @since 1.4
  */
 export declare class ProductOptionEvent extends VendureEntityEvent<ProductOption, ProductOptionInputTypes> {
-    constructor(ctx: RequestContext, entity: ProductOption, type: 'created' | 'updated', input?: ProductOptionInputTypes);
+    constructor(ctx: RequestContext, entity: ProductOption, type: 'created' | 'updated' | 'deleted', input?: ProductOptionInputTypes);
 }
 export {};

package/dist/event-bus/events/product-option-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"product-option-event.js","sourceRoot":"","sources":["../../../src/event-bus/events/product-option-event.ts"],"names":[],"mappings":";;;AASA,kEAA6D;AAQ7D;;;;;;;GAOG;AACH,MAAa,kBAAmB,SAAQ,yCAA0D;IAC9F,YACI,GAAmB,EACnB,MAAqB,EACrB,IAA2B,EAC3B,KAA+B;QAE/B,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;CACJ;AATD,gDASC"}
+{"version":3,"file":"product-option-event.js","sourceRoot":"","sources":["../../../src/event-bus/events/product-option-event.ts"],"names":[],"mappings":";;;AASA,kEAA6D;AAQ7D;;;;;;;GAOG;AACH,MAAa,kBAAmB,SAAQ,yCAA0D;IAC9F,YACI,GAAmB,EACnB,MAAqB,EACrB,IAAuC,EACvC,KAA+B;QAE/B,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;CACJ;AATD,gDASC"}

package/dist/event-bus/events/product-option-group-event.d.ts

@@ -13,6 +13,6 @@ declare type ProductOptionGroupInputTypes = CreateProductOptionGroupInput | Upda
  * @since 1.4
  */
 export declare class ProductOptionGroupEvent extends VendureEntityEvent<ProductOptionGroup, ProductOptionGroupInputTypes> {
-    constructor(ctx: RequestContext, entity: ProductOptionGroup, type: 'created' | 'updated', input?: ProductOptionGroupInputTypes);
+    constructor(ctx: RequestContext, entity: ProductOptionGroup, type: 'created' | 'updated' | 'deleted', input?: ProductOptionGroupInputTypes);
 }
 export {};

package/dist/event-bus/events/product-option-group-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"product-option-group-event.js","sourceRoot":"","sources":["../../../src/event-bus/events/product-option-group-event.ts"],"names":[],"mappings":";;;AAQA,kEAA6D;AAI7D;;;;;;;GAOG;AACH,MAAa,uBAAwB,SAAQ,yCAG5C;IACG,YACI,GAAmB,EACnB,MAA0B,EAC1B,IAA2B,EAC3B,KAAoC;QAEpC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;CACJ;AAZD,0DAYC"}
+{"version":3,"file":"product-option-group-event.js","sourceRoot":"","sources":["../../../src/event-bus/events/product-option-group-event.ts"],"names":[],"mappings":";;;AAQA,kEAA6D;AAI7D;;;;;;;GAOG;AACH,MAAa,uBAAwB,SAAQ,yCAG5C;IACG,YACI,GAAmB,EACnB,MAA0B,EAC1B,IAAuC,EACvC,KAAoC;QAEpC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;CACJ;AAZD,0DAYC"}

package/dist/event-bus/events/role-event.d.ts

@@ -6,7 +6,7 @@ import { VendureEntityEvent } from '../vendure-entity-event';
 declare type RoleInputTypes = CreateRoleInput | UpdateRoleInput | ID;
 /**
  * @description
- * This event is fired whenever one {@link Role} is  is added, updated or deleted.
+ * This event is fired whenever one {@link Role} is added, updated or deleted.
  *
  * @docsCategory events
  * @docsPage Event Types

package/dist/event-bus/events/role-event.js

@@ -4,7 +4,7 @@ exports.RoleEvent = void 0;
 const vendure_entity_event_1 = require("../vendure-entity-event");
 /**
  * @description
- * This event is fired whenever one {@link Role} is  is added, updated or deleted.
+ * This event is fired whenever one {@link Role} is added, updated or deleted.
  *
  * @docsCategory events
  * @docsPage Event Types

package/dist/event-bus/events/search-event.d.ts

@@ -0,0 +1,20 @@
+import { SearchInput } from '@vendure/common/lib/generated-types';
+import { RequestContext } from '../../api/common/request-context';
+import { VendureEvent } from '../vendure-event';
+declare type ExtendedSearchInput = SearchInput & {
+    [extendedInputField: string]: any;
+};
+/**
+ * @description
+ * This event is fired whenever a search query is executed.
+ *
+ * @docsCategory events
+ * @docsPage Event Types
+ * @since 1.6.0
+ */
+export declare class SearchEvent extends VendureEvent {
+    ctx: RequestContext;
+    input: ExtendedSearchInput;
+    constructor(ctx: RequestContext, input: ExtendedSearchInput);
+}
+export {};

package/dist/event-bus/events/search-event.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchEvent = void 0;
+const vendure_event_1 = require("../vendure-event");
+/**
+ * @description
+ * This event is fired whenever a search query is executed.
+ *
+ * @docsCategory events
+ * @docsPage Event Types
+ * @since 1.6.0
+ */
+class SearchEvent extends vendure_event_1.VendureEvent {
+    constructor(ctx, input) {
+        super();
+        this.ctx = ctx;
+        this.input = input;
+    }
+}
+exports.SearchEvent = SearchEvent;
+//# sourceMappingURL=search-event.js.map

package/dist/event-bus/events/search-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-event.js","sourceRoot":"","sources":["../../../src/event-bus/events/search-event.ts"],"names":[],"mappings":";;;AAGA,oDAAgD;AAMhD;;;;;;;GAOG;AACH,MAAa,WAAY,SAAQ,4BAAY;IACzC,YAAmB,GAAmB,EAAS,KAA0B;QACrE,KAAK,EAAE,CAAC;QADO,QAAG,GAAH,GAAG,CAAgB;QAAS,UAAK,GAAL,KAAK,CAAqB;IAEzE,CAAC;CACJ;AAJD,kCAIC"}

package/dist/event-bus/index.d.ts

@@ -25,6 +25,7 @@ export * from './events/global-settings-event';
 export * from './events/history-entry-event';
 export * from './events/identifier-change-event';
 export * from './events/identifier-change-request-event';
+export * from './events/initializer-event';
 export * from './events/login-event';
 export * from './events/logout-event';
 export * from './events/order-event';
@@ -46,6 +47,7 @@ export * from './events/promotion-event';
 export * from './events/refund-state-transition-event';
 export * from './events/role-change-event';
 export * from './events/role-event';
+export * from './events/search-event';
 export * from './events/shipping-method-event';
 export * from './events/stock-movement-event';
 export * from './events/tax-category-event';

package/dist/event-bus/index.js

@@ -37,6 +37,7 @@ __exportStar(require("./events/global-settings-event"), exports);
 __exportStar(require("./events/history-entry-event"), exports);
 __exportStar(require("./events/identifier-change-event"), exports);
 __exportStar(require("./events/identifier-change-request-event"), exports);
+__exportStar(require("./events/initializer-event"), exports);
 __exportStar(require("./events/login-event"), exports);
 __exportStar(require("./events/logout-event"), exports);
 __exportStar(require("./events/order-event"), exports);
@@ -58,6 +59,7 @@ __exportStar(require("./events/promotion-event"), exports);
 __exportStar(require("./events/refund-state-transition-event"), exports);
 __exportStar(require("./events/role-change-event"), exports);
 __exportStar(require("./events/role-event"), exports);
+__exportStar(require("./events/search-event"), exports);
 __exportStar(require("./events/shipping-method-event"), exports);
 __exportStar(require("./events/stock-movement-event"), exports);
 __exportStar(require("./events/tax-category-event"), exports);

package/dist/event-bus/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/event-bus/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,qDAAmC;AACnC,kDAAgC;AAEhC,sEAAoD;AACpD,kEAAgD;AAChD,+DAA6C;AAC7C,+DAA6C;AAC7C,uDAAqC;AACrC,iEAA+C;AAC/C,gEAA8C;AAC9C,yDAAuC;AACvC,4DAA0C;AAC1C,yEAAuD;AACvD,yDAAuC;AACvC,6DAA2C;AAC3C,kEAAgD;AAChD,0DAAwC;AACxC,uEAAqD;AACrD,gEAA8C;AAC9C,uDAAqC;AACrC,6DAA2C;AAC3C,6DAA2C;AAC3C,8EAA4D;AAC5D,iEAA+C;AAC/C,+DAA6C;AAC7C,mEAAiD;AACjD,2EAAyD;AACzD,uDAAqC;AACrC,wDAAsC;AACtC,uDAAqC;AACrC,4DAA0C;AAC1C,8DAA4C;AAC5C,wEAAsD;AACtD,gEAA8C;AAC9C,yEAAuD;AACvD,gEAA8C;AAC9C,0EAAwD;AACxD,iEAA+C;AAC/C,yDAAuC;AACvC,gEAA8C;AAC9C,6EAA2D;AAC3D,sEAAoD;AACpD,yEAAuD;AACvD,iEAA+C;AAC/C,2DAAyC;AACzC,yEAAuD;AACvD,6DAA2C;AAC3C,sDAAoC;AACpC,iEAA+C;AAC/C,gEAA8C;AAC9C,8DAA4C;AAC5C,0DAAwC;AACxC,uEAAqD;AACrD,sDAAoC;AACpC,8DAA4C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/event-bus/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,qDAAmC;AACnC,kDAAgC;AAEhC,sEAAoD;AACpD,kEAAgD;AAChD,+DAA6C;AAC7C,+DAA6C;AAC7C,uDAAqC;AACrC,iEAA+C;AAC/C,gEAA8C;AAC9C,yDAAuC;AACvC,4DAA0C;AAC1C,yEAAuD;AACvD,yDAAuC;AACvC,6DAA2C;AAC3C,kEAAgD;AAChD,0DAAwC;AACxC,uEAAqD;AACrD,gEAA8C;AAC9C,uDAAqC;AACrC,6DAA2C;AAC3C,6DAA2C;AAC3C,8EAA4D;AAC5D,iEAA+C;AAC/C,+DAA6C;AAC7C,mEAAiD;AACjD,2EAAyD;AACzD,6DAA2C;AAC3C,uDAAqC;AACrC,wDAAsC;AACtC,uDAAqC;AACrC,4DAA0C;AAC1C,8DAA4C;AAC5C,wEAAsD;AACtD,gEAA8C;AAC9C,yEAAuD;AACvD,gEAA8C;AAC9C,0EAAwD;AACxD,iEAA+C;AAC/C,yDAAuC;AACvC,gEAA8C;AAC9C,6EAA2D;AAC3D,sEAAoD;AACpD,yEAAuD;AACvD,iEAA+C;AAC/C,2DAAyC;AACzC,yEAAuD;AACvD,6DAA2C;AAC3C,sDAAoC;AACpC,wDAAsC;AACtC,iEAA+C;AAC/C,gEAA8C;AAC9C,8DAA4C;AAC5C,0DAAwC;AACxC,uEAAqD;AACrD,sDAAoC;AACpC,8DAA4C"}

package/dist/health-check/health-check-registry.service.d.ts

@@ -13,7 +13,13 @@ import { HealthIndicatorFunction } from '@nestjs/terminus';
  * Plugins which rely on external services (web services, databases etc.) can make use of this
  * service to add a check for that dependency to the Vendure health check.
  *
- * To use it in your plugin, you'll need to import the {@link PluginCommonModule}:
+ *
+ * Since v1.6.0, the preferred way to implement a custom health check is by creating a new
+ * {@link HealthCheckStrategy} and then passing it to the `systemOptions.healthChecks` array.
+ * See the {@link HealthCheckStrategy} docs for an example configuration.
+ *
+ * The alternative way to register a health check is by injecting this service directly into your
+ * plugin module. To use it in your plugin, you'll need to import the {@link PluginCommonModule}:
  *
  * @example
  * ```TypeScript

package/dist/health-check/health-check-registry.service.js

@@ -15,7 +15,13 @@ exports.HealthCheckRegistryService = void 0;
  * Plugins which rely on external services (web services, databases etc.) can make use of this
  * service to add a check for that dependency to the Vendure health check.
  *
- * To use it in your plugin, you'll need to import the {@link PluginCommonModule}:
+ *
+ * Since v1.6.0, the preferred way to implement a custom health check is by creating a new
+ * {@link HealthCheckStrategy} and then passing it to the `systemOptions.healthChecks` array.
+ * See the {@link HealthCheckStrategy} docs for an example configuration.
+ *
+ * The alternative way to register a health check is by injecting this service directly into your
+ * plugin module. To use it in your plugin, you'll need to import the {@link PluginCommonModule}:
  *
  * @example
  * ```TypeScript

package/dist/health-check/health-check-registry.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"health-check-registry.service.js","sourceRoot":"","sources":["../../src/health-check/health-check-registry.service.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAa,0BAA0B;IAAvC;QAKY,8BAAyB,GAA8B,EAAE,CAAC;IAYtE,CAAC;IAhBG,gBAAgB;IAChB,IAAI,wBAAwB;QACxB,OAAO,IAAI,CAAC,yBAAyB,CAAC;IAC1C,CAAC;IAGD;;;;;OAKG;IACH,yBAAyB,CAAC,EAAuD;QAC7E,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;IACpD,CAAC;CACJ;AAjBD,gEAiBC"}
+{"version":3,"file":"health-check-registry.service.js","sourceRoot":"","sources":["../../src/health-check/health-check-registry.service.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAa,0BAA0B;IAAvC;QAKY,8BAAyB,GAA8B,EAAE,CAAC;IAYtE,CAAC;IAhBG,gBAAgB;IAChB,IAAI,wBAAwB;QACxB,OAAO,IAAI,CAAC,yBAAyB,CAAC;IAC1C,CAAC;IAGD;;;;;OAKG;IACH,yBAAyB,CAAC,EAAuD;QAC7E,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;IACpD,CAAC;CACJ;AAjBD,gEAiBC"}

package/dist/health-check/health-check.module.d.ts

@@ -1,11 +1,9 @@
-import { TypeOrmHealthIndicator } from '@nestjs/terminus';
 import { ConfigService } from '../config/config.service';
 import { HealthCheckRegistryService } from './health-check-registry.service';
 import { WorkerHealthIndicator } from './worker-health-indicator';
 export declare class HealthCheckModule {
     private configService;
     private healthCheckRegistryService;
-    private typeOrm;
     private worker;
-    constructor(configService: ConfigService, healthCheckRegistryService: HealthCheckRegistryService, typeOrm: TypeOrmHealthIndicator, worker: WorkerHealthIndicator);
+    constructor(configService: ConfigService, healthCheckRegistryService: HealthCheckRegistryService, worker: WorkerHealthIndicator);
 }

package/dist/health-check/health-check.module.js

@@ -20,13 +20,15 @@ const health_check_registry_service_1 = require("./health-check-registry.service
 const health_check_controller_1 = require("./health-check.controller");
 const worker_health_indicator_1 = require("./worker-health-indicator");
 let HealthCheckModule = class HealthCheckModule {
-    constructor(configService, healthCheckRegistryService, typeOrm, worker) {
+    constructor(configService, healthCheckRegistryService, worker) {
         this.configService = configService;
         this.healthCheckRegistryService = healthCheckRegistryService;
-        this.typeOrm = typeOrm;
         this.worker = worker;
-        // Register the default health checks for database and worker
-        this.healthCheckRegistryService.registerIndicatorFunction([() => this.typeOrm.pingCheck('database')]);
+        // Register all configured health checks
+        for (const strategy of this.configService.systemOptions.healthChecks) {
+            this.healthCheckRegistryService.registerIndicatorFunction(strategy.getHealthIndicator());
+        }
+        // TODO: Remove in v2
         const { enableWorkerHealthCheck, jobQueueStrategy } = this.configService.jobQueueOptions;
         if (enableWorkerHealthCheck && (0, inspectable_job_queue_strategy_1.isInspectableJobQueueStrategy)(jobQueueStrategy)) {
             this.healthCheckRegistryService.registerIndicatorFunction([() => this.worker.isHealthy()]);
@@ -42,7 +44,6 @@ HealthCheckModule = __decorate([
     }),
     __metadata("design:paramtypes", [config_service_1.ConfigService,
         health_check_registry_service_1.HealthCheckRegistryService,
-        terminus_1.TypeOrmHealthIndicator,
         worker_health_indicator_1.WorkerHealthIndicator])
 ], HealthCheckModule);
 exports.HealthCheckModule = HealthCheckModule;

package/dist/health-check/health-check.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"health-check.module.js","sourceRoot":"","sources":["../../src/health-check/health-check.module.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAwC;AACxC,+CAA0E;AAE1E,2DAAuD;AACvD,6DAAyD;AACzD,uGAAmG;AACnG,oEAA+D;AAE/D,mFAA6E;AAC7E,uEAA6D;AAC7D,uEAAkE;AAQlE,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAC1B,YACY,aAA4B,EAC5B,0BAAsD,EACtD,OAA+B,EAC/B,MAA6B;QAH7B,kBAAa,GAAb,aAAa,CAAe;QAC5B,+BAA0B,GAA1B,0BAA0B,CAA4B;QACtD,YAAO,GAAP,OAAO,CAAwB;QAC/B,WAAM,GAAN,MAAM,CAAuB;QAErC,6DAA6D;QAC7D,IAAI,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtG,MAAM,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC;QACzF,IAAI,uBAAuB,IAAI,IAAA,8DAA6B,EAAC,gBAAgB,CAAC,EAAE;YAC5E,IAAI,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;SAC9F;IACL,CAAC;CACJ,CAAA;AAdY,iBAAiB;IAN7B,IAAA,eAAM,EAAC;QACJ,OAAO,EAAE,CAAC,yBAAc,EAAE,4BAAY,EAAE,iCAAc,CAAC;QACvD,WAAW,EAAE,CAAC,0CAAgB,CAAC;QAC/B,SAAS,EAAE,CAAC,0DAA0B,EAAE,+CAAqB,CAAC;QAC9D,OAAO,EAAE,CAAC,0DAA0B,CAAC;KACxC,CAAC;qCAG6B,8BAAa;QACA,0DAA0B;QAC7C,iCAAsB;QACvB,+CAAqB;GALhC,iBAAiB,CAc7B;AAdY,8CAAiB"}
+{"version":3,"file":"health-check.module.js","sourceRoot":"","sources":["../../src/health-check/health-check.module.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAwC;AACxC,+CAAkD;AAElD,2DAAuD;AACvD,6DAAyD;AACzD,uGAAmG;AACnG,oEAA+D;AAE/D,mFAA6E;AAC7E,uEAA6D;AAC7D,uEAAkE;AAQlE,IAAa,iBAAiB,GAA9B,MAAa,iBAAiB;IAC1B,YACY,aAA4B,EAC5B,0BAAsD,EACtD,MAA6B;QAF7B,kBAAa,GAAb,aAAa,CAAe;QAC5B,+BAA0B,GAA1B,0BAA0B,CAA4B;QACtD,WAAM,GAAN,MAAM,CAAuB;QAErC,wCAAwC;QACxC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,YAAY,EAAE;YAClE,IAAI,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC,CAAC;SAC5F;QAED,qBAAqB;QACrB,MAAM,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC;QACzF,IAAI,uBAAuB,IAAI,IAAA,8DAA6B,EAAC,gBAAgB,CAAC,EAAE;YAC5E,IAAI,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;SAC9F;IACL,CAAC;CACJ,CAAA;AAjBY,iBAAiB;IAN7B,IAAA,eAAM,EAAC;QACJ,OAAO,EAAE,CAAC,yBAAc,EAAE,4BAAY,EAAE,iCAAc,CAAC;QACvD,WAAW,EAAE,CAAC,0CAAgB,CAAC;QAC/B,SAAS,EAAE,CAAC,0DAA0B,EAAE,+CAAqB,CAAC;QAC9D,OAAO,EAAE,CAAC,0DAA0B,CAAC;KACxC,CAAC;qCAG6B,8BAAa;QACA,0DAA0B;QAC9C,+CAAqB;GAJhC,iBAAiB,CAiB7B;AAjBY,8CAAiB"}

package/dist/health-check/http-health-check-strategy.d.ts

@@ -0,0 +1,36 @@
+import { HealthIndicatorFunction } from '@nestjs/terminus';
+import { Injector } from '../common/index';
+import { HealthCheckStrategy } from '../config/system/health-check-strategy';
+export interface HttpHealthCheckOptions {
+    key: string;
+    url: string;
+    timeout?: number;
+}
+/**
+ * @description
+ * A {@link HealthCheckStrategy} used to check health by pinging a url. Internally it uses
+ * the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
+ *
+ * @example
+ * ```TypeScript
+ * import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '\@vendure/core';
+ *
+ * export const config = {
+ *   // ...
+ *   systemOptions: {
+ *     healthChecks: [
+ *       new TypeORMHealthCheckStrategy(),
+ *       new HttpHealthCheckStrategy({ key: 'my-service', url: 'https://my-service.com' }),
+ *     ]
+ *   },
+ * };
+ * ```
+ *
+ * @docsCategory health-check
+ */
+export declare class HttpHealthCheckStrategy implements HealthCheckStrategy {
+    private options;
+    constructor(options: HttpHealthCheckOptions);
+    init(injector: Injector): Promise<void>;
+    getHealthIndicator(): HealthIndicatorFunction;
+}

package/dist/health-check/http-health-check-strategy.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpHealthCheckStrategy = void 0;
+const terminus_1 = require("@nestjs/terminus");
+let indicator;
+/**
+ * @description
+ * A {@link HealthCheckStrategy} used to check health by pinging a url. Internally it uses
+ * the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
+ *
+ * @example
+ * ```TypeScript
+ * import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '\@vendure/core';
+ *
+ * export const config = {
+ *   // ...
+ *   systemOptions: {
+ *     healthChecks: [
+ *       new TypeORMHealthCheckStrategy(),
+ *       new HttpHealthCheckStrategy({ key: 'my-service', url: 'https://my-service.com' }),
+ *     ]
+ *   },
+ * };
+ * ```
+ *
+ * @docsCategory health-check
+ */
+class HttpHealthCheckStrategy {
+    constructor(options) {
+        this.options = options;
+    }
+    async init(injector) {
+        indicator = await injector.get(terminus_1.HttpHealthIndicator);
+    }
+    getHealthIndicator() {
+        const { key, url, timeout } = this.options;
+        return () => indicator.pingCheck(key, url, { timeout });
+    }
+}
+exports.HttpHealthCheckStrategy = HttpHealthCheckStrategy;
+//# sourceMappingURL=http-health-check-strategy.js.map

package/dist/health-check/http-health-check-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-health-check-strategy.js","sourceRoot":"","sources":["../../src/health-check/http-health-check-strategy.ts"],"names":[],"mappings":";;;AAAA,+CAAgF;AAKhF,IAAI,SAA8B,CAAC;AAQnC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,uBAAuB;IAChC,YAAoB,OAA+B;QAA/B,YAAO,GAAP,OAAO,CAAwB;IAAG,CAAC;IAEvD,KAAK,CAAC,IAAI,CAAC,QAAkB;QACzB,SAAS,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,8BAAmB,CAAC,CAAC;IACxD,CAAC;IAED,kBAAkB;QACd,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3C,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACJ;AAXD,0DAWC"}

package/dist/health-check/index.d.ts

@@ -1,2 +1,4 @@
 export * from './constants';
 export * from './health-check-registry.service';
+export * from './typeorm-health-check-strategy';
+export * from './http-health-check-strategy';

package/dist/health-check/index.js

@@ -12,4 +12,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./constants"), exports);
 __exportStar(require("./health-check-registry.service"), exports);
+__exportStar(require("./typeorm-health-check-strategy"), exports);
+__exportStar(require("./http-health-check-strategy"), exports);
 //# sourceMappingURL=index.js.map

package/dist/health-check/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/health-check/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,kEAAgD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/health-check/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,kEAAgD;AAChD,kEAAgD;AAChD,+DAA6C"}

package/dist/health-check/typeorm-health-check-strategy.d.ts

@@ -0,0 +1,36 @@
+import { HealthIndicatorFunction } from '@nestjs/terminus';
+import { Injector } from '../common/index';
+import { HealthCheckStrategy } from '../config/system/health-check-strategy';
+export interface TypeORMHealthCheckOptions {
+    key?: string;
+    timeout?: number;
+}
+/**
+ * @description
+ * A {@link HealthCheckStrategy} used to check the health of the database. This health
+ * check is included by default, but can be customized by explicitly adding it to the
+ * `systemOptions.healthChecks` array:
+ *
+ * @example
+ * ```TypeScript
+ * import { TypeORMHealthCheckStrategy } from '\@vendure/core';
+ *
+ * export const config = {
+ *   // ...
+ *   systemOptions: [
+ *     // The default key is "database" and the default timeout is 1000ms
+ *     // Sometimes this is too short and leads to false negatives in the
+ *     // /health endpoint.
+ *     new TypeORMHealthCheckStrategy({ key: 'postgres-db', timeout: 5000 }),
+ *   ]
+ * }
+ * ```
+ *
+ * @docsCategory health-check
+ */
+export declare class TypeORMHealthCheckStrategy implements HealthCheckStrategy {
+    private options?;
+    constructor(options?: TypeORMHealthCheckOptions | undefined);
+    init(injector: Injector): Promise<void>;
+    getHealthIndicator(): HealthIndicatorFunction;
+}

package/dist/health-check/typeorm-health-check-strategy.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeORMHealthCheckStrategy = void 0;
+const terminus_1 = require("@nestjs/terminus");
+let indicator;
+/**
+ * @description
+ * A {@link HealthCheckStrategy} used to check the health of the database. This health
+ * check is included by default, but can be customized by explicitly adding it to the
+ * `systemOptions.healthChecks` array:
+ *
+ * @example
+ * ```TypeScript
+ * import { TypeORMHealthCheckStrategy } from '\@vendure/core';
+ *
+ * export const config = {
+ *   // ...
+ *   systemOptions: [
+ *     // The default key is "database" and the default timeout is 1000ms
+ *     // Sometimes this is too short and leads to false negatives in the
+ *     // /health endpoint.
+ *     new TypeORMHealthCheckStrategy({ key: 'postgres-db', timeout: 5000 }),
+ *   ]
+ * }
+ * ```
+ *
+ * @docsCategory health-check
+ */
+class TypeORMHealthCheckStrategy {
+    constructor(options) {
+        this.options = options;
+    }
+    async init(injector) {
+        indicator = await injector.resolve(terminus_1.TypeOrmHealthIndicator);
+    }
+    getHealthIndicator() {
+        var _a, _b, _c;
+        const key = ((_a = this.options) === null || _a === void 0 ? void 0 : _a.key) || 'database';
+        const timeout = (_c = (_b = this.options) === null || _b === void 0 ? void 0 : _b.timeout) !== null && _c !== void 0 ? _c : 1000;
+        return () => indicator.pingCheck(key, { timeout });
+    }
+}
+exports.TypeORMHealthCheckStrategy = TypeORMHealthCheckStrategy;
+//# sourceMappingURL=typeorm-health-check-strategy.js.map

package/dist/health-check/typeorm-health-check-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeorm-health-check-strategy.js","sourceRoot":"","sources":["../../src/health-check/typeorm-health-check-strategy.ts"],"names":[],"mappings":";;;AAAA,+CAAmF;AAKnF,IAAI,SAAiC,CAAC;AAOtC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,0BAA0B;IACnC,YAAoB,OAAmC;QAAnC,YAAO,GAAP,OAAO,CAA4B;IAAG,CAAC;IAE3D,KAAK,CAAC,IAAI,CAAC,QAAkB;QACzB,SAAS,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,iCAAsB,CAAC,CAAC;IAC/D,CAAC;IAED,kBAAkB;;QACd,MAAM,GAAG,GAAG,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,GAAG,KAAI,UAAU,CAAC;QAC5C,MAAM,OAAO,GAAG,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,OAAO,mCAAI,IAAI,CAAC;QAC9C,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACvD,CAAC;CACJ;AAZD,gEAYC"}

package/dist/i18n/messages/en.json

@@ -9,6 +9,8 @@
     "cannot-transition-payment-from-to": "Cannot transition Payment from \"{ fromState }\" to \"{ toState }\"",
     "cannot-transition-refund-from-to": "Cannot transition Refund from \"{ fromState }\" to \"{ toState }\"",
     "cannot-transition-fulfillment-from-to": "Cannot transition Fulfillment from \"{ fromState }\" to \"{ toState }\"",
+    "channel-not-found": "No Channel with the token \"{ token }\" could be found",
+    "collections-cannot-be-removed-from-default-channel": "Collections cannot be removed from the default Channel",
     "collection-id-or-slug-must-be-provided": "Either the Collection id or slug must be provided",
     "collection-id-slug-mismatch": "The provided id and slug refer to different Collections",
     "conditions-required-for-action": "The PromotionAction '{ action }' requires the following conditions: { conditions }",
@@ -18,6 +20,7 @@
     "default-channel-not-found": "Default channel not found",
     "entity-has-no-translation-in-language": "Translatable entity '{ entityName }' has not been translated into the requested language ({ languageCode })",
     "entity-with-id-not-found": "No { entityName } with the id '{ id }' could be found",
+    "facets-cannot-be-removed-from-default-channel": "Facets cannot be removed from the default Channel",
     "facetfilterinput-invalid-input": "A FacetValueFilterInput object may not specify the 'and' and 'or' fields simultaneously",
     "field-invalid-datetime-range-max": "The custom field '{ name }' value [{ value }] is greater than the maximum [{ max }]",
     "field-invalid-datetime-range-min": "The custom field '{ name }' value [{ value }] is less than the minimum [{ min }]",
@@ -40,6 +43,7 @@
     "products-cannot-be-removed-from-default-channel": "Products cannot be removed from the default Channel",
     "product-id-or-slug-must-be-provided": "Either the Product id or slug must be provided",
     "product-id-slug-mismatch": "The provided id and slug refer to different Products",
+    "product-option-group-already-assigned": "The ProductOptionGroup \"{ groupCode }\" is already assigned to the Product \"{ productName }\"",
     "product-variant-option-ids-not-compatible": "ProductVariant optionIds must include one optionId from each of the groups: {groupNames}",
     "product-variant-options-combination-already-exists": "A ProductVariant with the selected options already exists: {variantName}",
     "promotion-channels-can-only-be-changed-from-default-channel": "Promotions channels may only be changed from the Default Channel",
@@ -51,6 +55,7 @@
     "ALREADY_LOGGED_IN_ERROR": "Cannot set a Customer for the Order when already logged in",
     "ALREADY_REFUNDED_ERROR": "Cannot refund an OrderItem which has already been refunded",
     "CANCEL_ACTIVE_ORDER_ERROR": "Cannot cancel OrderLines from an Order in the \"{ orderState }\" state",
+    "CANCEL_PAYMENT_ERROR": "Cancelling the payment failed",
     "CHANNEL_DEFAULT_LANGUAGE_ERROR": "Cannot make language \"{ language }\" unavailable as it is used as the defaultLanguage by the channel \"{ channelCode }\"",
     "COUPON_CODE_EXPIRED_ERROR": "Coupon code \"{ couponCode }\" has expired",
     "COUPON_CODE_INVALID_ERROR": "Coupon code \"{ couponCode }\" is not valid",
@@ -58,6 +63,7 @@
     "CREATE_FULFILLMENT_ERROR": "An error occurred when attempting to create the Fulfillment",
     "EMAIL_ADDRESS_CONFLICT_ERROR": "The email address is not available.",
     "EMPTY_ORDER_LINE_SELECTION_ERROR": "At least one OrderLine must be specified",
+    "FACET_IN_USE_ERROR": "The Facet \"{ facetCode }\" includes FacetValues which are assigned to {productCount, plural, =0 {} one {1 Product} other {# Products}} {variantCount, plural, =0 {} one {1 ProductVariant} other {# ProductVariants}}",
     "IDENTIFIER_CHANGE_TOKEN_INVALID_ERROR": "Identifier change token not recognized",
     "INELIGIBLE_SHIPPING_METHOD_ERROR": "This Order is not eligible for the selected ShippingMethod",
     "INSUFFICIENT_STOCK_ERROR": "{quantityAvailable, plural, =0 {No items were} one {Only 1 item was} other {Only # items were}} added to the order due to insufficient stock",
@@ -112,10 +118,11 @@
     "cannot-transition-without-settled-payments": "Cannot transition Order to the \"PaymentSettled\" state when the total is not covered by settled Payments",
     "country-used-in-addresses": "The selected Country cannot be deleted as it is used in {count, plural, one {1 Address} other {# Addresses}}",
     "facet-force-deleted": "The Facet was deleted and its FacetValues were removed from {products, plural, =0 {} one {1 Product} other {# Products}}{both, select, both { , } single {}}{variants, plural, =0 {} one {1 ProductVariant} other {# ProductVariants}}",
-    "facet-used": "The selected Facet includes FacetValues which are assigned to {products, plural, =0 {} one {1 Product} other {# Products}}{both, select, both { , } single {}}{variants, plural, =0 {} one {1 ProductVariant} other {# ProductVariants}}",
+    "facet-used": "The Facet \"{ facetCode }\" includes FacetValues which are assigned to {products, plural, =0 {} one {1 Product} other {# Products}}{both, select, both { , } single {}}{variants, plural, =0 {} one {1 ProductVariant} other {# ProductVariants}}",
     "facet-value-force-deleted": "The selected FacetValue was removed from {products, plural, =0 {} one {1 Product} other {# Products}}{both, select, both { , } single {}}{variants, plural, =0 {} one {1 ProductVariant} other {# ProductVariants}} and deleted",
     "facet-value-used": "The selected FacetValue is assigned to {products, plural, =0 {} one {1 Product} other {# Products}}{both, select, both { , } single {}}{variants, plural, =0 {} one {1 ProductVariant} other {# ProductVariants}}",
     "payment-method-used-in-channels": "The selected PaymentMethod is assigned to the following Channels: { channelCodes }. Set \"force: true\" to delete from all Channels.",
+    "product-option-used": "Cannot delete the option \"{code}\" as it is being used by {count, plural, =0 {} one {1 ProductVariant} other {# ProductVariants}}",
     "zone-used-in-channels": "The selected Zone cannot be deleted as it used as a default in the following Channels: { channelCodes }",
     "zone-used-in-tax-rates": "The selected Zone cannot be deleted as it is used in the following TaxRates: { taxRateNames }"
   }

package/dist/job-queue/subscribable-job.d.ts

@@ -10,6 +10,27 @@ import { JobData } from './types';
  * @docsPage types
  */
 export declare type JobUpdate<T extends JobData<T>> = Pick<Job<T>, 'id' | 'state' | 'progress' | 'result' | 'error' | 'data'>;
+/**
+ * @description
+ * Job update options, that you can specify by calling {@link SubscribableJob.updates updates()} method.
+ *
+ * @docsCategory JobQueue
+ * @docsPage types
+ */
+export declare type JobUpdateOptions = {
+    /**
+     * Polling interval. Defaults to 200ms
+     */
+    pollInterval?: number;
+    /**
+     * Polling timeout in milliseconds. Defaults to 1 hour
+     */
+    timeoutMs?: number;
+    /**
+     * Observable sequence will end with an error if true. Default to false
+     */
+    errorOnFail?: boolean;
+};
 /**
  * @description
  * This is a type of Job object that allows you to subscribe to updates to the Job. It is returned
@@ -27,11 +48,7 @@ export declare class SubscribableJob<T extends JobData<T> = any> extends Job<T>
      * Returns an Observable stream of updates to the Job. Works by polling the current JobQueueStrategy's `findOne()` method
      * to obtain updates. If this updates are not subscribed to, then no polling occurs.
      *
-     * The polling interval defaults to 200ms, but can be configured by passing in an options argument. Polling will also timeout
-     * after 1 hour, but this timeout can also be configured by passing the `timeoutMs` option.
+     * Polling interval, timeout and other options may be configured with an options arguments {@link JobUpdateOptions}.
      */
-    updates(options?: {
-        pollInterval?: number;
-        timeoutMs?: number;
-    }): Observable<JobUpdate<T>>;
+    updates(options?: JobUpdateOptions): Observable<JobUpdate<T>>;
 }