@deenruv/core 1.0.0

package/dist/entity/validate-custom-fields-config.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCustomFieldsConfig = void 0;
+const typeorm_1 = require("typeorm");
+const base_entity_1 = require("./base/base.entity");
+function validateCustomFieldsForEntity(entity, customFields) {
+    return [
+        ...assertValidFieldNames(entity.name, customFields),
+        ...assertNoNameConflictsWithEntity(entity, customFields),
+        ...assertNoDuplicatedCustomFieldNames(entity.name, customFields),
+        ...assetNonNullablesHaveDefaults(entity.name, customFields),
+        ...(isTranslatable(entity)
+            ? []
+            : assertNoLocaleStringFields(entity.name, customFields)),
+    ];
+}
+/**
+ * Assert that the custom entity names are valid
+ */
+function assertValidFieldNames(entityName, customFields) {
+    const errors = [];
+    const validNameRe = /^[a-zA-Z_]+[a-zA-Z0-9_]*$/;
+    for (const field of customFields) {
+        if (!validNameRe.test(field.name)) {
+            errors.push(`${entityName} entity has an invalid custom field name: "${field.name}"`);
+        }
+    }
+    return errors;
+}
+function assertNoNameConflictsWithEntity(entity, customFields) {
+    const errors = [];
+    for (const field of customFields) {
+        const conflicts = (e) => {
+            return -1 < getAllColumnNames(e).findIndex((name) => name === field.name);
+        };
+        const translation = getEntityTranslation(entity);
+        if (conflicts(entity) || (translation && conflicts(translation))) {
+            errors.push(`${entity.name} entity already has a field named "${field.name}"`);
+        }
+    }
+    return errors;
+}
+/**
+ * Assert that none of the custom field names conflict with one another.
+ */
+function assertNoDuplicatedCustomFieldNames(entityName, customFields) {
+    const nameCounts = customFields
+        .map((f) => f.name)
+        .reduce((hash, name) => {
+        hash[name] ? hash[name]++ : (hash[name] = 1);
+        return hash;
+    }, {});
+    return Object.entries(nameCounts)
+        .filter(([name, count]) => 1 < count)
+        .map(([name, count]) => `${entityName} entity has duplicated custom field name: "${name}"`);
+}
+/**
+ * For entities which are not localized (Address, Customer), we assert that none of the custom fields
+ * have a type "localeString".
+ */
+function assertNoLocaleStringFields(entityName, customFields) {
+    if (customFields.find((f) => f.type === "localeString")) {
+        return [
+            `${entityName} entity does not support custom fields of type "localeString"`,
+        ];
+    }
+    return [];
+}
+/**
+ * Assert that any non-nullable field must have a defaultValue specified.
+ */
+function assetNonNullablesHaveDefaults(entityName, customFields) {
+    const errors = [];
+    for (const field of customFields) {
+        if (field.nullable === false && field.defaultValue === undefined) {
+            errors.push(`${entityName} entity custom field "${field.name}" is non-nullable and must have a defaultValue`);
+        }
+    }
+    return errors;
+}
+function isTranslatable(entity) {
+    return !!getEntityTranslation(entity);
+}
+function getEntityTranslation(entity) {
+    const metadata = (0, typeorm_1.getMetadataArgsStorage)();
+    const translation = metadata
+        .filterRelations(entity)
+        .find((r) => r.propertyName === "translations");
+    if (translation) {
+        const type = translation.type;
+        if (typeof type === "function") {
+            // See https://github.com/microsoft/TypeScript/issues/37663
+            return type();
+        }
+    }
+}
+function getAllColumnNames(entity) {
+    const metadata = (0, typeorm_1.getMetadataArgsStorage)();
+    const ownColumns = metadata.filterColumns(entity);
+    const relationColumns = metadata.filterRelations(entity);
+    const embeddedColumns = metadata.filterEmbeddeds(entity);
+    const baseColumns = metadata.filterColumns(base_entity_1.DeenruvEntity);
+    return [
+        ...ownColumns,
+        ...relationColumns,
+        ...embeddedColumns,
+        ...baseColumns,
+    ].map((c) => c.propertyName);
+}
+/**
+ * Validates the custom fields config, e.g. by ensuring that there are no naming conflicts with the built-in fields
+ * of each entity.
+ */
+function validateCustomFieldsConfig(customFieldConfig, entities) {
+    let errors = [];
+    (0, typeorm_1.getMetadataArgsStorage)();
+    for (const key of Object.keys(customFieldConfig)) {
+        const entityName = key;
+        const customEntityFields = customFieldConfig[entityName] || [];
+        const entity = entities.find((e) => e.name === entityName);
+        if (entity && customEntityFields.length) {
+            errors = errors.concat(validateCustomFieldsForEntity(entity, customEntityFields));
+        }
+    }
+    return {
+        valid: errors.length === 0,
+        errors,
+    };
+}
+exports.validateCustomFieldsConfig = validateCustomFieldsConfig;
+//# sourceMappingURL=validate-custom-fields-config.js.map

package/dist/entity/validate-custom-fields-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-custom-fields-config.js","sourceRoot":"","sources":["../../src/entity/validate-custom-fields-config.ts"],"names":[],"mappings":";;;AACA,qCAAiD;AAOjD,oDAAmD;AAEnD,SAAS,6BAA6B,CACpC,MAA2B,EAC3B,YAAiC;IAEjC,OAAO;QACL,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC;QACnD,GAAG,+BAA+B,CAAC,MAAM,EAAE,YAAY,CAAC;QACxD,GAAG,kCAAkC,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC;QAChE,GAAG,6BAA6B,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC;QAC3D,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC;YACxB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,0BAA0B,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;KAC3D,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAC5B,UAAkB,EAClB,YAAiC;IAEjC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,WAAW,GAAG,2BAA2B,CAAC;IAChD,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,MAAM,CAAC,IAAI,CACT,GAAG,UAAU,8CAA8C,KAAK,CAAC,IAAI,GAAG,CACzE,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,+BAA+B,CACtC,MAAiB,EACjB,YAAiC;IAEjC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,CAAC,CAAY,EAAW,EAAE;YAC1C,OAAO,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5E,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;YACjE,MAAM,CAAC,IAAI,CACT,GAAG,MAAM,CAAC,IAAI,sCAAsC,KAAK,CAAC,IAAI,GAAG,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,kCAAkC,CACzC,UAAkB,EAClB,YAAiC;IAEjC,MAAM,UAAU,GAAG,YAAY;SAC5B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAClB,MAAM,CACL,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QACb,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC,EACD,EAAgC,CACjC,CAAC;IACJ,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;SAC9B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;SACpC,GAAG,CACF,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAChB,GAAG,UAAU,8CAA8C,IAAI,GAAG,CACrE,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,SAAS,0BAA0B,CACjC,UAAkB,EAClB,YAAiC;IAEjC,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,EAAE,CAAC;QACxD,OAAO;YACL,GAAG,UAAU,+DAA+D;SAC7E,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;GAEG;AACH,SAAS,6BAA6B,CACpC,UAAkB,EAClB,YAAiC;IAEjC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,IAAI,KAAK,CAAC,QAAQ,KAAK,KAAK,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACjE,MAAM,CAAC,IAAI,CACT,GAAG,UAAU,yBAAyB,KAAK,CAAC,IAAI,gDAAgD,CACjG,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,MAAiB;IACvC,OAAO,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAiB;IAC7C,MAAM,QAAQ,GAAG,IAAA,gCAAsB,GAAE,CAAC;IAC1C,MAAM,WAAW,GAAG,QAAQ;SACzB,eAAe,CAAC,MAAM,CAAC;SACvB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,cAAc,CAAC,CAAC;IAClD,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC;QAC9B,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;YAC/B,2DAA2D;YAC3D,OAAQ,IAAY,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAiB;IAC1C,MAAM,QAAQ,GAAG,IAAA,gCAAsB,GAAE,CAAC;IAC1C,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,eAAe,GAAG,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,2BAAa,CAAC,CAAC;IAC1D,OAAO;QACL,GAAG,UAAU;QACb,GAAG,eAAe;QAClB,GAAG,eAAe;QAClB,GAAG,WAAW;KACf,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;AAC/B,CAAC;AAED;;;GAGG;AACH,SAAgB,0BAA0B,CACxC,iBAA+B,EAC/B,QAA0B;IAE1B,IAAI,MAAM,GAAa,EAAE,CAAC;IAC1B,IAAA,gCAAsB,GAAE,CAAC;IACzB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACjD,MAAM,UAAU,GAAG,GAAyB,CAAC;QAC7C,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAC/D,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;QAC3D,IAAI,MAAM,IAAI,kBAAkB,CAAC,MAAM,EAAE,CAAC;YACxC,MAAM,GAAG,MAAM,CAAC,MAAM,CACpB,6BAA6B,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAC1D,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM;KACP,CAAC;AACJ,CAAC;AApBD,gEAoBC"}

package/dist/entity/value-transformers.d.ts

@@ -0,0 +1,8 @@
+import { ValueTransformer } from "typeorm";
+/**
+ * Decimal types are returned as strings (e.g. "20.00") by some DBs, e.g. MySQL & Postgres
+ */
+export declare class DecimalTransformer implements ValueTransformer {
+    to(value: any): any;
+    from(value: any): any;
+}

package/dist/entity/value-transformers.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DecimalTransformer = void 0;
+/**
+ * Decimal types are returned as strings (e.g. "20.00") by some DBs, e.g. MySQL & Postgres
+ */
+class DecimalTransformer {
+    to(value) {
+        return value;
+    }
+    from(value) {
+        return Number.parseFloat(value);
+    }
+}
+exports.DecimalTransformer = DecimalTransformer;
+//# sourceMappingURL=value-transformers.js.map

package/dist/entity/value-transformers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"value-transformers.js","sourceRoot":"","sources":["../../src/entity/value-transformers.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,kBAAkB;IAC7B,EAAE,CAAC,KAAU;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,KAAU;QACb,OAAO,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;CACF;AARD,gDAQC"}

package/dist/entity/zone/zone.entity.d.ts

@@ -0,0 +1,23 @@
+import { DeepPartial } from "@deenruv/common/lib/shared-types";
+import { HasCustomFields } from "../../config/custom-field/custom-field-types";
+import { DeenruvEntity } from "../base/base.entity";
+import { Channel } from "../channel/channel.entity";
+import { CustomZoneFields } from "../custom-entity-fields";
+import { Region } from "../region/region.entity";
+import { TaxRate } from "../tax-rate/tax-rate.entity";
+/**
+ * @description
+ * A Zone is a grouping of one or more {@link Country} entities. It is used for
+ * calculating applicable shipping and taxes.
+ *
+ * @docsCategory entities
+ */
+export declare class Zone extends DeenruvEntity implements HasCustomFields {
+    constructor(input?: DeepPartial<Zone>);
+    name: string;
+    members: Region[];
+    customFields: CustomZoneFields;
+    defaultShippingZoneChannels: Channel[];
+    defaultTaxZoneChannels: Channel[];
+    taxRates: TaxRate[];
+}

package/dist/entity/zone/zone.entity.js

@@ -0,0 +1,61 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Zone = void 0;
+const typeorm_1 = require("typeorm");
+const base_entity_1 = require("../base/base.entity");
+const channel_entity_1 = require("../channel/channel.entity");
+const custom_entity_fields_1 = require("../custom-entity-fields");
+const region_entity_1 = require("../region/region.entity");
+const tax_rate_entity_1 = require("../tax-rate/tax-rate.entity");
+/**
+ * @description
+ * A Zone is a grouping of one or more {@link Country} entities. It is used for
+ * calculating applicable shipping and taxes.
+ *
+ * @docsCategory entities
+ */
+let Zone = class Zone extends base_entity_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+exports.Zone = Zone;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], Zone.prototype, "name", void 0);
+__decorate([
+    (0, typeorm_1.ManyToMany)((type) => region_entity_1.Region),
+    (0, typeorm_1.JoinTable)(),
+    __metadata("design:type", Array)
+], Zone.prototype, "members", void 0);
+__decorate([
+    (0, typeorm_1.Column)((type) => custom_entity_fields_1.CustomZoneFields),
+    __metadata("design:type", custom_entity_fields_1.CustomZoneFields)
+], Zone.prototype, "customFields", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => channel_entity_1.Channel, (country) => country.defaultShippingZone),
+    __metadata("design:type", Array)
+], Zone.prototype, "defaultShippingZoneChannels", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => channel_entity_1.Channel, (country) => country.defaultTaxZone),
+    __metadata("design:type", Array)
+], Zone.prototype, "defaultTaxZoneChannels", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)((type) => tax_rate_entity_1.TaxRate, (taxRate) => taxRate.zone),
+    __metadata("design:type", Array)
+], Zone.prototype, "taxRates", void 0);
+exports.Zone = Zone = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], Zone);
+//# sourceMappingURL=zone.entity.js.map

package/dist/entity/zone/zone.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zone.entity.js","sourceRoot":"","sources":["../../../src/entity/zone/zone.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,qCAA2E;AAG3E,qDAAoD;AACpD,8DAAoD;AACpD,kEAA2D;AAE3D,2DAAiD;AACjD,iEAAsD;AAEtD;;;;;;GAMG;AAEI,IAAM,IAAI,GAAV,MAAM,IAAK,SAAQ,2BAAa;IACrC,YAAY,KAAyB;QACnC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CAmBF,CAAA;AAtBY,oBAAI;AAKL;IAAT,IAAA,gBAAM,GAAE;;kCAAc;AAIvB;IAFC,IAAA,oBAAU,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,sBAAM,CAAC;IAC5B,IAAA,mBAAS,GAAE;;qCACM;AAGlB;IADC,IAAA,gBAAM,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,uCAAgB,CAAC;8BACrB,uCAAgB;0CAAC;AAG/B;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC;;yDAChC;AAGvC;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC;;oDAChC;AAGlC;IADC,IAAA,mBAAS,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,yBAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;;sCACpC;eArBT,IAAI;IADhB,IAAA,gBAAM,GAAE;;GACI,IAAI,CAsBhB"}

package/dist/event-bus/deenruv-entity-event.d.ts

@@ -0,0 +1,16 @@
+import { RequestContext } from "../api";
+import { DeenruvEvent } from "./deenruv-event";
+/**
+ * @description
+ * The base class for all entity events used by the EventBus system.
+ * * For event type `'deleted'` the input will most likely be an `id: ID`
+ *
+ * @docsCategory events
+ * */
+export declare abstract class DeenruvEntityEvent<Entity, Input = any> extends DeenruvEvent {
+    readonly entity: Entity;
+    readonly type: "created" | "updated" | "deleted";
+    readonly ctx: RequestContext;
+    readonly input?: Input;
+    protected constructor(entity: Entity, type: "created" | "updated" | "deleted", ctx: RequestContext, input?: Input);
+}

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeenruvEntityEvent = void 0;
+const deenruv_event_1 = require("./deenruv-event");
+/**
+ * @description
+ * The base class for all entity events used by the EventBus system.
+ * * For event type `'deleted'` the input will most likely be an `id: ID`
+ *
+ * @docsCategory events
+ * */
+class DeenruvEntityEvent extends deenruv_event_1.DeenruvEvent {
+    constructor(entity, type, ctx, input) {
+        super();
+        this.entity = entity;
+        this.type = type;
+        this.ctx = ctx;
+        this.input = input;
+    }
+}
+exports.DeenruvEntityEvent = DeenruvEntityEvent;
+//# sourceMappingURL=deenruv-entity-event.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deenruv-entity-event.js","sourceRoot":"","sources":["../../src/event-bus/deenruv-entity-event.ts"],"names":[],"mappings":";;;AAEA,mDAA+C;AAE/C;;;;;;KAMK;AACL,MAAsB,kBAGpB,SAAQ,4BAAY;IAMpB,YACE,MAAc,EACd,IAAuC,EACvC,GAAmB,EACnB,KAAa;QAEb,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AArBD,gDAqBC"}

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

@@ -0,0 +1,10 @@
+/**
+ * @description
+ * The base class for all events used by the EventBus system.
+ *
+ * @docsCategory events
+ * */
+export declare abstract class DeenruvEvent {
+    readonly createdAt: Date;
+    protected constructor();
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeenruvEvent = void 0;
+/**
+ * @description
+ * The base class for all events used by the EventBus system.
+ *
+ * @docsCategory events
+ * */
+class DeenruvEvent {
+    constructor() {
+        this.createdAt = new Date();
+    }
+}
+exports.DeenruvEvent = DeenruvEvent;
+//# sourceMappingURL=deenruv-event.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deenruv-event.js","sourceRoot":"","sources":["../../src/event-bus/deenruv-event.ts"],"names":[],"mappings":";;;AAAA;;;;;KAKK;AACL,MAAsB,YAAY;IAEhC;QACE,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;CACF;AALD,oCAKC"}

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

@@ -0,0 +1,179 @@
+import { OnModuleDestroy } from "@nestjs/common";
+import { Type } from "@deenruv/common/lib/shared-types";
+import { Observable } from "rxjs";
+import { TransactionSubscriber } from "../connection/transaction-subscriber";
+import { DeenruvEvent } from "./deenruv-event";
+/**
+ * @description
+ * Options for registering a blocking event handler.
+ *
+ * @since 2.2.0
+ * @docsCategory events
+ */
+export type BlockingEventHandlerOptions<T extends DeenruvEvent> = {
+    /**
+     * @description
+     * The event type to which the handler should listen.
+     * Can be a single event type or an array of event types.
+     */
+    event: Type<T> | Array<Type<T>>;
+    /**
+     * @description
+     * The handler function which will be executed when the event is published.
+     * If the handler returns a Promise, the event publishing code will wait for the Promise to resolve
+     * before continuing. Any errors thrown by the handler will cause the event publishing code to fail.
+     */
+    handler: (event: T) => void | Promise<void>;
+    /**
+     * @description
+     * A unique identifier for the handler. This can then be used to specify the order in which
+     * handlers should be executed using the `before` and `after` options in other handlers.
+     */
+    id: string;
+    /**
+     * @description
+     * The ID of another handler which this handler should execute before.
+     */
+    before?: string;
+    /**
+     * @description
+     * The ID of another handler which this handler should execute after.
+     */
+    after?: string;
+};
+/**
+ * @description
+ * The EventBus is used to globally publish events which can then be subscribed to.
+ *
+ * Events are published whenever certain actions take place within the Deenruv server, for example:
+ *
+ * * when a Product is updated ({@link ProductEvent})
+ * * when an Order transitions state ({@link OrderStateTransitionEvent})
+ * * when a Customer registers a new account ({@link AccountRegistrationEvent})
+ *
+ * Using the EventBus it is possible to subscribe to an take action when these events occur.
+ * This is done with the `.ofType()` method, which takes an event type and returns an rxjs observable
+ * stream of events:
+ *
+ * @example
+ * ```ts
+ * import { OnApplicationBootstrap } from '\@nestjs/common';
+ * import { EventBus, PluginCommonModule, DeenruvPlugin } from '\@deenruv/core';
+ * import { filter } from 'rxjs/operators';
+ *
+ * \@DeenruvPlugin({
+ *     imports: [PluginCommonModule]
+ * })
+ * export class MyPlugin implements OnApplicationBootstrap {
+ *
+ *   constructor(private eventBus: EventBus) {}
+ *
+ *   async onApplicationBootstrap() {
+ *
+ *     this.eventBus
+ *       .ofType(OrderStateTransitionEvent)
+ *       .pipe(
+ *         filter(event => event.toState === 'PaymentSettled'),
+ *       )
+ *       .subscribe((event) => {
+ *         // do some action when this event fires
+ *       });
+ *   }
+ * }
+ * ```
+ *
+ * @docsCategory events
+ * */
+export declare class EventBus implements OnModuleDestroy {
+    private transactionSubscriber;
+    private eventStream;
+    private destroy$;
+    private blockingEventHandlers;
+    constructor(transactionSubscriber: TransactionSubscriber);
+    /**
+     * @description
+     * Publish an event which any subscribers can react to.
+     *
+     * @example
+     * ```ts
+     * await eventBus.publish(new SomeEvent());
+     * ```
+     */
+    publish<T extends DeenruvEvent>(event: T): Promise<void>;
+    /**
+     * @description
+     * Returns an RxJS Observable stream of events of the given type.
+     * If the event contains a {@link RequestContext} object, the subscriber
+     * will only get called after any active database transactions are complete.
+     *
+     * This means that the subscriber function can safely access all updated
+     * data related to the event.
+     */
+    ofType<T extends DeenruvEvent>(type: Type<T>): Observable<T>;
+    /**
+     * @description
+     * Returns an RxJS Observable stream of events filtered by a custom predicate.
+     * If the event contains a {@link RequestContext} object, the subscriber
+     * will only get called after any active database transactions are complete.
+     *
+     * This means that the subscriber function can safely access all updated
+     * data related to the event.
+     */
+    filter<T extends DeenruvEvent>(predicate: (event: DeenruvEvent) => boolean): Observable<T>;
+    /**
+     * @description
+     * Register an event handler function which will be executed when an event of the given type is published,
+     * and will block execution of the code which published the event until the handler has completed.
+     *
+     * This is useful when you need assurance that the event handler has successfully completed, and you want
+     * the triggering code to fail if the handler fails.
+     *
+     * ::: warning
+     * This API should be used with caution, as errors or performance issues in the handler can cause the
+     * associated operation to be slow or fail entirely. For this reason, any handler which takes longer than
+     * 100ms to execute will log a warning. Any non-trivial task to be performed in a blocking event handler
+     * should be offloaded to a background job using the {@link JobQueueService}.
+     *
+     * Also, be aware that the handler will be executed in the _same database transaction_ as the code which published
+     * the event (as long as you pass the `ctx` object from the event to any TransactionalConnection calls).
+     * :::
+     *
+     * @example
+     * ```ts
+     * eventBus.registerBlockingEventHandler({
+     *   event: OrderStateTransitionEvent,
+     *   id: 'my-order-state-transition-handler',
+     *   handler: async (event) => {
+     *     // perform some synchronous task
+     *   }
+     * });
+     * ```
+     *
+     * @since 2.2.0
+     */
+    registerBlockingEventHandler<T extends DeenruvEvent>(handlerOptions: BlockingEventHandlerOptions<T>): void;
+    /** @internal */
+    onModuleDestroy(): any;
+    private executeBlockingEventHandlers;
+    private orderEventHandlers;
+    /**
+     * If the Event includes a RequestContext property, we need to check for any active transaction
+     * associated with it, and if there is one, we await that transaction to either commit or rollback
+     * before publishing the event.
+     *
+     * The reason for this is that if the transaction is still active when event subscribers execute,
+     * this can cause a couple of issues:
+     *
+     * 1. If the transaction hasn't completed by the time the subscriber runs, the new data inside
+     *  the transaction will not be available to the subscriber.
+     * 2. If the subscriber gets a reference to the EntityManager which has an active transaction,
+     *   and then the transaction completes, and then the subscriber attempts a DB operation using that
+     *   EntityManager, a fatal QueryRunnerAlreadyReleasedError will be thrown.
+     *
+     * For more context on these two issues, see:
+     *
+     * * https://github.com/deenruv-ecommerce/deenruv/issues/520
+     * * https://github.com/deenruv-ecommerce/deenruv/issues/1107
+     */
+    private awaitActiveTransactions;
+}