@deenruv/core 1.0.0

package/dist/service/services/global-settings.service.js

@@ -0,0 +1,99 @@
+"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.GlobalSettingsService = void 0;
+const common_1 = require("@nestjs/common");
+const request_context_cache_service_1 = require("../../cache/request-context-cache.service");
+const constants_1 = require("../../common/constants");
+const errors_1 = require("../../common/error/errors");
+const config_service_1 = require("../../config/config.service");
+const transactional_connection_1 = require("../../connection/transactional-connection");
+const global_settings_entity_1 = require("../../entity/global-settings/global-settings.entity");
+const event_bus_1 = require("../../event-bus");
+const global_settings_event_1 = require("../../event-bus/events/global-settings-event");
+const custom_field_relation_service_1 = require("../helpers/custom-field-relation/custom-field-relation.service");
+const patch_entity_1 = require("../helpers/utils/patch-entity");
+/**
+ * @description
+ * Contains methods relating to the {@link GlobalSettings} entity.
+ *
+ * @docsCategory services
+ */
+let GlobalSettingsService = class GlobalSettingsService {
+    constructor(connection, configService, customFieldRelationService, eventBus, requestCache) {
+        this.connection = connection;
+        this.configService = configService;
+        this.customFieldRelationService = customFieldRelationService;
+        this.eventBus = eventBus;
+        this.requestCache = requestCache;
+    }
+    /**
+     * Ensure there is a single global settings row in the database.
+     * @internal
+     */
+    async initGlobalSettings() {
+        try {
+            const result = await this.connection.rawConnection
+                .getRepository(global_settings_entity_1.GlobalSettings)
+                .find();
+            if (result.length === 0) {
+                throw new Error("No global settings");
+            }
+            if (1 < result.length) {
+                // Strange edge case, see https://github.com/deenruv-ecommerce/deenruv/issues/987
+                const toDelete = result.slice(1);
+                await this.connection.rawConnection
+                    .getRepository(global_settings_entity_1.GlobalSettings)
+                    .remove(toDelete);
+            }
+        }
+        catch (err) {
+            const settings = new global_settings_entity_1.GlobalSettings({
+                availableLanguages: [this.configService.defaultLanguageCode],
+            });
+            await this.connection.rawConnection
+                .getRepository(global_settings_entity_1.GlobalSettings)
+                .save(settings, { reload: false });
+        }
+    }
+    /**
+     * @description
+     * Returns the GlobalSettings entity.
+     */
+    async getSettings(ctx) {
+        const settings = await this.requestCache.get(ctx, constants_1.CacheKey.GlobalSettings, () => this.connection
+            .getRepository(ctx, global_settings_entity_1.GlobalSettings)
+            .createQueryBuilder("global_settings")
+            .orderBy(this.connection.rawConnection.driver.escape("createdAt"), "ASC")
+            .getOne());
+        if (!settings) {
+            throw new errors_1.InternalServerError("error.global-settings-not-found");
+        }
+        return settings;
+    }
+    async updateSettings(ctx, input) {
+        const settings = await this.getSettings(ctx);
+        await this.eventBus.publish(new global_settings_event_1.GlobalSettingsEvent(ctx, settings, input));
+        (0, patch_entity_1.patchEntity)(settings, input);
+        await this.customFieldRelationService.updateRelations(ctx, global_settings_entity_1.GlobalSettings, input, settings);
+        return this.connection.getRepository(ctx, global_settings_entity_1.GlobalSettings).save(settings);
+    }
+};
+exports.GlobalSettingsService = GlobalSettingsService;
+exports.GlobalSettingsService = GlobalSettingsService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [transactional_connection_1.TransactionalConnection,
+        config_service_1.ConfigService,
+        custom_field_relation_service_1.CustomFieldRelationService,
+        event_bus_1.EventBus,
+        request_context_cache_service_1.RequestContextCacheService])
+], GlobalSettingsService);
+//# sourceMappingURL=global-settings.service.js.map

package/dist/service/services/global-settings.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global-settings.service.js","sourceRoot":"","sources":["../../../src/service/services/global-settings.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAI5C,6FAAuF;AACvF,sDAAkD;AAClD,sDAAgE;AAChE,gEAA4D;AAC5D,wFAAoF;AACpF,gGAAqF;AACrF,+CAA2C;AAC3C,wFAAmF;AACnF,kHAA4G;AAC5G,gEAA4D;AAE5D;;;;;GAKG;AAEI,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IAChC,YACU,UAAmC,EACnC,aAA4B,EAC5B,0BAAsD,EACtD,QAAkB,EAClB,YAAwC;QAJxC,eAAU,GAAV,UAAU,CAAyB;QACnC,kBAAa,GAAb,aAAa,CAAe;QAC5B,+BAA0B,GAA1B,0BAA0B,CAA4B;QACtD,aAAQ,GAAR,QAAQ,CAAU;QAClB,iBAAY,GAAZ,YAAY,CAA4B;IAC/C,CAAC;IAEJ;;;OAGG;IACH,KAAK,CAAC,kBAAkB;QACtB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;iBAC/C,aAAa,CAAC,uCAAc,CAAC;iBAC7B,IAAI,EAAE,CAAC;YACV,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;gBACtB,iFAAiF;gBACjF,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;qBAChC,aAAa,CAAC,uCAAc,CAAC;qBAC7B,MAAM,CAAC,QAAQ,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,QAAQ,GAAG,IAAI,uCAAc,CAAC;gBAClC,kBAAkB,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC;aAC7D,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;iBAChC,aAAa,CAAC,uCAAc,CAAC;iBAC7B,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,GAAmB;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAC1C,GAAG,EACH,oBAAQ,CAAC,cAAc,EACvB,GAAG,EAAE,CACH,IAAI,CAAC,UAAU;aACZ,aAAa,CAAC,GAAG,EAAE,uCAAc,CAAC;aAClC,kBAAkB,CAAC,iBAAiB,CAAC;aACrC,OAAO,CACN,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EACxD,KAAK,CACN;aACA,MAAM,EAAE,CACd,CAAC;QACF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,4BAAmB,CAAC,iCAAiC,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,GAAmB,EACnB,KAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,2CAAmB,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAC3E,IAAA,0BAAW,EAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC7B,MAAM,IAAI,CAAC,0BAA0B,CAAC,eAAe,CACnD,GAAG,EACH,uCAAc,EACd,KAAK,EACL,QAAQ,CACT,CAAC;QACF,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,uCAAc,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3E,CAAC;CACF,CAAA;AA7EY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,mBAAU,GAAE;qCAGW,kDAAuB;QACpB,8BAAa;QACA,0DAA0B;QAC5C,oBAAQ;QACJ,0DAA0B;GANvC,qBAAqB,CA6EjC"}

package/dist/service/services/history.service.d.ts

@@ -0,0 +1,244 @@
+import { UpdateCustomerInput as UpdateCustomerShopInput } from "@deenruv/common/lib/generated-shop-types";
+import { HistoryEntryListOptions, HistoryEntryType, OrderLineInput, UpdateAddressInput, UpdateCustomerInput } from "@deenruv/common/lib/generated-types";
+import { ID, PaginatedList } from "@deenruv/common/lib/shared-types";
+import { RequestContext } from "../../api/common/request-context";
+import { TransactionalConnection } from "../../connection/transactional-connection";
+import { CustomerHistoryEntry } from "../../entity/history-entry/customer-history-entry.entity";
+import { OrderHistoryEntry } from "../../entity/history-entry/order-history-entry.entity";
+import { EventBus } from "../../event-bus";
+import { FulfillmentState } from "../helpers/fulfillment-state-machine/fulfillment-state";
+import { ListQueryBuilder } from "../helpers/list-query-builder/list-query-builder";
+import { OrderState } from "../helpers/order-state-machine/order-state";
+import { PaymentState } from "../helpers/payment-state-machine/payment-state";
+import { RefundState } from "../helpers/refund-state-machine/refund-state";
+import { AdministratorService } from "./administrator.service";
+export interface CustomerHistoryEntryData {
+    [HistoryEntryType.CUSTOMER_REGISTERED]: {
+        strategy: string;
+    };
+    [HistoryEntryType.CUSTOMER_VERIFIED]: {
+        strategy: string;
+    };
+    [HistoryEntryType.CUSTOMER_DETAIL_UPDATED]: {
+        input: UpdateCustomerInput | UpdateCustomerShopInput;
+    };
+    [HistoryEntryType.CUSTOMER_ADDRESS_CREATED]: {
+        address: string;
+    };
+    [HistoryEntryType.CUSTOMER_ADDED_TO_GROUP]: {
+        groupName: string;
+    };
+    [HistoryEntryType.CUSTOMER_REMOVED_FROM_GROUP]: {
+        groupName: string;
+    };
+    [HistoryEntryType.CUSTOMER_ADDRESS_UPDATED]: {
+        address: string;
+        input: UpdateAddressInput;
+    };
+    [HistoryEntryType.CUSTOMER_ADDRESS_DELETED]: {
+        address: string;
+    };
+    [HistoryEntryType.CUSTOMER_PASSWORD_UPDATED]: Record<string, never>;
+    [HistoryEntryType.CUSTOMER_PASSWORD_RESET_REQUESTED]: Record<string, never>;
+    [HistoryEntryType.CUSTOMER_PASSWORD_RESET_VERIFIED]: Record<string, never>;
+    [HistoryEntryType.CUSTOMER_EMAIL_UPDATE_REQUESTED]: {
+        oldEmailAddress: string;
+        newEmailAddress: string;
+    };
+    [HistoryEntryType.CUSTOMER_EMAIL_UPDATE_VERIFIED]: {
+        oldEmailAddress: string;
+        newEmailAddress: string;
+    };
+    [HistoryEntryType.CUSTOMER_NOTE]: {
+        note: string;
+    };
+}
+export interface OrderHistoryEntryData {
+    [HistoryEntryType.ORDER_STATE_TRANSITION]: {
+        from: OrderState;
+        to: OrderState;
+    };
+    [HistoryEntryType.ORDER_PAYMENT_TRANSITION]: {
+        paymentId: ID;
+        from: PaymentState;
+        to: PaymentState;
+    };
+    [HistoryEntryType.ORDER_FULFILLMENT_TRANSITION]: {
+        fulfillmentId: ID;
+        from: FulfillmentState;
+        to: FulfillmentState;
+    };
+    [HistoryEntryType.ORDER_FULFILLMENT]: {
+        fulfillmentId: ID;
+    };
+    [HistoryEntryType.ORDER_CANCELLATION]: {
+        lines: OrderLineInput[];
+        shippingCancelled: boolean;
+        reason?: string;
+    };
+    [HistoryEntryType.ORDER_REFUND_TRANSITION]: {
+        refundId: ID;
+        from: RefundState;
+        to: RefundState;
+        reason?: string;
+    };
+    [HistoryEntryType.ORDER_NOTE]: {
+        note: string;
+    };
+    [HistoryEntryType.ORDER_COUPON_APPLIED]: {
+        couponCode: string;
+        promotionId: ID;
+    };
+    [HistoryEntryType.ORDER_COUPON_REMOVED]: {
+        couponCode: string;
+    };
+    [HistoryEntryType.ORDER_MODIFIED]: {
+        modificationId: ID;
+    };
+    [HistoryEntryType.ORDER_CUSTOMER_UPDATED]: {
+        previousCustomerId?: ID;
+        previousCustomerName?: ID;
+        newCustomerId: ID;
+        newCustomerName: ID;
+        note?: string;
+    };
+}
+export interface CreateCustomerHistoryEntryArgs<T extends keyof CustomerHistoryEntryData> {
+    customerId: ID;
+    ctx: RequestContext;
+    type: T;
+    data: CustomerHistoryEntryData[T];
+}
+export interface CreateOrderHistoryEntryArgs<T extends keyof OrderHistoryEntryData> {
+    orderId: ID;
+    ctx: RequestContext;
+    type: T;
+    data: OrderHistoryEntryData[T];
+}
+export interface UpdateOrderHistoryEntryArgs<T extends keyof OrderHistoryEntryData> {
+    entryId: ID;
+    ctx: RequestContext;
+    type: T;
+    isPublic?: boolean;
+    data?: OrderHistoryEntryData[T];
+}
+export interface UpdateCustomerHistoryEntryArgs<T extends keyof CustomerHistoryEntryData> {
+    entryId: ID;
+    ctx: RequestContext;
+    type: T;
+    data?: CustomerHistoryEntryData[T];
+}
+/**
+ * @description
+ * Contains methods relating to {@link HistoryEntry} entities. Histories are timelines of actions
+ * related to a particular Customer or Order, recording significant events such as creation, state changes,
+ * notes, etc.
+ *
+ * ## Custom History Entry Types
+ *
+ * Since Deenruv v1.9.0, it is possible to define custom HistoryEntry types.
+ *
+ * Let's take an example where we have some Customers who are businesses. We want to verify their
+ * tax ID in order to allow them wholesale rates. As part of this verification, we'd like to add
+ * an entry into the Customer's history with data about the tax ID verification.
+ *
+ * First of all we'd extend the GraphQL `HistoryEntryType` enum for our new type as part of a plugin
+ *
+ * @example
+ * ```ts
+ * import { PluginCommonModule, DeenruvPlugin } from '\@deenruv/core';
+ * import { VerificationService } from './verification.service';
+ *
+ * \@DeenruvPlugin({
+ *   imports: [PluginCommonModule],
+ *   adminApiExtensions: {
+ *     schema: gql`
+ *       extend enum HistoryEntryType {
+ *         CUSTOMER_TAX_ID_VERIFICATION
+ *       }
+ *     `,
+ *   },
+ *   providers: [VerificationService],
+ * })
+ * export class TaxIDVerificationPlugin {}
+ * ```
+ *
+ * Next we need to create a TypeScript type definition file where we extend the `CustomerHistoryEntryData` interface. This is done
+ * via TypeScript's [declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#merging-interfaces)
+ * and [ambient modules](https://www.typescriptlang.org/docs/handbook/modules.html#ambient-modules) features.
+ *
+ * @example
+ * ```ts
+ * // types.ts
+ * import { CustomerHistoryEntryData } from '\@deenruv/core';
+ *
+ * export const CUSTOMER_TAX_ID_VERIFICATION = 'CUSTOMER_TAX_ID_VERIFICATION';
+ *
+ * declare module '@deenruv/core' {
+ *   interface CustomerHistoryEntryData {
+ *     [CUSTOMER_TAX_ID_VERIFICATION]: {
+ *       taxId: string;
+ *       valid: boolean;
+ *       name?: string;
+ *       address?: string;
+ *     };
+ *   }
+ * }
+ * ```
+ *
+ * Note: it works exactly the same way if we wanted to add a custom type for Order history, except in that case we'd extend the
+ * `OrderHistoryEntryData` interface instead.
+ *
+ * Now that we have our types set up, we can use the HistoryService to add a new HistoryEntry in a type-safe manner:
+ *
+ * @example
+ * ```ts
+ * // verification.service.ts
+ * import { Injectable } from '\@nestjs/common';
+ * import { RequestContext } from '\@deenruv/core';
+ * import { CUSTOMER_TAX_ID_VERIFICATION } from './types';
+ *
+ * \@Injectable()
+ * export class VerificationService {
+ *   constructor(private historyService: HistoryService) {}
+ *
+ *   async verifyTaxId(ctx: RequestContext, customerId: ID, taxId: string) {
+ *     const result = await someTaxIdCheckingService(taxId);
+ *
+ *     await this.historyService.createHistoryEntryForCustomer({
+ *       customerId,
+ *       ctx,
+ *       type: CUSTOMER_TAX_ID_VERIFICATION,
+ *       data: {
+ *         taxId,
+ *         valid: result.isValid,
+ *         name: result.companyName,
+ *         address: result.registeredAddress,
+ *       },
+ *     });
+ *   }
+ * }
+ * ```
+ * :::info
+ * It is also possible to define a UI component to display custom history entry types. See the
+ * [Custom History Timeline Components guide](/guides/extending-the-admin-ui/custom-timeline-components/).
+ * :::
+ *
+ * @docsCategory services
+ */
+export declare class HistoryService {
+    private connection;
+    private administratorService;
+    private listQueryBuilder;
+    private eventBus;
+    constructor(connection: TransactionalConnection, administratorService: AdministratorService, listQueryBuilder: ListQueryBuilder, eventBus: EventBus);
+    getHistoryForOrder(ctx: RequestContext, orderId: ID, publicOnly: boolean, options?: HistoryEntryListOptions): Promise<PaginatedList<OrderHistoryEntry>>;
+    createHistoryEntryForOrder<T extends keyof OrderHistoryEntryData>(args: CreateOrderHistoryEntryArgs<T>, isPublic?: boolean): Promise<OrderHistoryEntry>;
+    getHistoryForCustomer(ctx: RequestContext, customerId: ID, publicOnly: boolean, options?: HistoryEntryListOptions): Promise<PaginatedList<CustomerHistoryEntry>>;
+    createHistoryEntryForCustomer<T extends keyof CustomerHistoryEntryData>(args: CreateCustomerHistoryEntryArgs<T>, isPublic?: boolean): Promise<CustomerHistoryEntry>;
+    updateOrderHistoryEntry<T extends keyof OrderHistoryEntryData>(ctx: RequestContext, args: UpdateOrderHistoryEntryArgs<T>): Promise<OrderHistoryEntry>;
+    deleteOrderHistoryEntry(ctx: RequestContext, id: ID): Promise<void>;
+    updateCustomerHistoryEntry<T extends keyof CustomerHistoryEntryData>(ctx: RequestContext, args: UpdateCustomerHistoryEntryArgs<T>): Promise<CustomerHistoryEntry>;
+    deleteCustomerHistoryEntry(ctx: RequestContext, id: ID): Promise<void>;
+    private getAdministratorFromContext;
+}

package/dist/service/services/history.service.js

@@ -0,0 +1,256 @@
+"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.HistoryService = void 0;
+const common_1 = require("@nestjs/common");
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const transactional_connection_1 = require("../../connection/transactional-connection");
+const customer_history_entry_entity_1 = require("../../entity/history-entry/customer-history-entry.entity");
+const history_entry_entity_1 = require("../../entity/history-entry/history-entry.entity");
+const order_history_entry_entity_1 = require("../../entity/history-entry/order-history-entry.entity");
+const event_bus_1 = require("../../event-bus");
+const history_entry_event_1 = require("../../event-bus/events/history-entry-event");
+const list_query_builder_1 = require("../helpers/list-query-builder/list-query-builder");
+const administrator_service_1 = require("./administrator.service");
+/**
+ * @description
+ * Contains methods relating to {@link HistoryEntry} entities. Histories are timelines of actions
+ * related to a particular Customer or Order, recording significant events such as creation, state changes,
+ * notes, etc.
+ *
+ * ## Custom History Entry Types
+ *
+ * Since Deenruv v1.9.0, it is possible to define custom HistoryEntry types.
+ *
+ * Let's take an example where we have some Customers who are businesses. We want to verify their
+ * tax ID in order to allow them wholesale rates. As part of this verification, we'd like to add
+ * an entry into the Customer's history with data about the tax ID verification.
+ *
+ * First of all we'd extend the GraphQL `HistoryEntryType` enum for our new type as part of a plugin
+ *
+ * @example
+ * ```ts
+ * import { PluginCommonModule, DeenruvPlugin } from '\@deenruv/core';
+ * import { VerificationService } from './verification.service';
+ *
+ * \@DeenruvPlugin({
+ *   imports: [PluginCommonModule],
+ *   adminApiExtensions: {
+ *     schema: gql`
+ *       extend enum HistoryEntryType {
+ *         CUSTOMER_TAX_ID_VERIFICATION
+ *       }
+ *     `,
+ *   },
+ *   providers: [VerificationService],
+ * })
+ * export class TaxIDVerificationPlugin {}
+ * ```
+ *
+ * Next we need to create a TypeScript type definition file where we extend the `CustomerHistoryEntryData` interface. This is done
+ * via TypeScript's [declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#merging-interfaces)
+ * and [ambient modules](https://www.typescriptlang.org/docs/handbook/modules.html#ambient-modules) features.
+ *
+ * @example
+ * ```ts
+ * // types.ts
+ * import { CustomerHistoryEntryData } from '\@deenruv/core';
+ *
+ * export const CUSTOMER_TAX_ID_VERIFICATION = 'CUSTOMER_TAX_ID_VERIFICATION';
+ *
+ * declare module '@deenruv/core' {
+ *   interface CustomerHistoryEntryData {
+ *     [CUSTOMER_TAX_ID_VERIFICATION]: {
+ *       taxId: string;
+ *       valid: boolean;
+ *       name?: string;
+ *       address?: string;
+ *     };
+ *   }
+ * }
+ * ```
+ *
+ * Note: it works exactly the same way if we wanted to add a custom type for Order history, except in that case we'd extend the
+ * `OrderHistoryEntryData` interface instead.
+ *
+ * Now that we have our types set up, we can use the HistoryService to add a new HistoryEntry in a type-safe manner:
+ *
+ * @example
+ * ```ts
+ * // verification.service.ts
+ * import { Injectable } from '\@nestjs/common';
+ * import { RequestContext } from '\@deenruv/core';
+ * import { CUSTOMER_TAX_ID_VERIFICATION } from './types';
+ *
+ * \@Injectable()
+ * export class VerificationService {
+ *   constructor(private historyService: HistoryService) {}
+ *
+ *   async verifyTaxId(ctx: RequestContext, customerId: ID, taxId: string) {
+ *     const result = await someTaxIdCheckingService(taxId);
+ *
+ *     await this.historyService.createHistoryEntryForCustomer({
+ *       customerId,
+ *       ctx,
+ *       type: CUSTOMER_TAX_ID_VERIFICATION,
+ *       data: {
+ *         taxId,
+ *         valid: result.isValid,
+ *         name: result.companyName,
+ *         address: result.registeredAddress,
+ *       },
+ *     });
+ *   }
+ * }
+ * ```
+ * :::info
+ * It is also possible to define a UI component to display custom history entry types. See the
+ * [Custom History Timeline Components guide](/guides/extending-the-admin-ui/custom-timeline-components/).
+ * :::
+ *
+ * @docsCategory services
+ */
+let HistoryService = class HistoryService {
+    constructor(connection, administratorService, listQueryBuilder, eventBus) {
+        this.connection = connection;
+        this.administratorService = administratorService;
+        this.listQueryBuilder = listQueryBuilder;
+        this.eventBus = eventBus;
+    }
+    async getHistoryForOrder(ctx, orderId, publicOnly, options) {
+        return this.listQueryBuilder
+            .build(history_entry_entity_1.HistoryEntry, options, {
+            where: Object.assign({ order: { id: orderId } }, (publicOnly ? { isPublic: true } : {})),
+            relations: ["administrator"],
+            ctx,
+        })
+            .getManyAndCount()
+            .then(([items, totalItems]) => ({
+            items,
+            totalItems,
+        }));
+    }
+    async createHistoryEntryForOrder(args, isPublic = true) {
+        const { ctx, data, orderId, type } = args;
+        const administrator = await this.getAdministratorFromContext(ctx);
+        const entry = new order_history_entry_entity_1.OrderHistoryEntry({
+            type,
+            isPublic,
+            data: data,
+            order: { id: orderId },
+            administrator,
+        });
+        const history = await this.connection
+            .getRepository(ctx, order_history_entry_entity_1.OrderHistoryEntry)
+            .save(entry);
+        await this.eventBus.publish(new history_entry_event_1.HistoryEntryEvent(ctx, history, "created", "order", { type, data }));
+        return history;
+    }
+    async getHistoryForCustomer(ctx, customerId, publicOnly, options) {
+        return this.listQueryBuilder
+            .build(history_entry_entity_1.HistoryEntry, options, {
+            where: Object.assign({ customer: { id: customerId } }, (publicOnly ? { isPublic: true } : {})),
+            relations: ["administrator"],
+            ctx,
+        })
+            .getManyAndCount()
+            .then(([items, totalItems]) => ({
+            items,
+            totalItems,
+        }));
+    }
+    async createHistoryEntryForCustomer(args, isPublic = false) {
+        const { ctx, data, customerId, type } = args;
+        const administrator = await this.getAdministratorFromContext(ctx);
+        const entry = new customer_history_entry_entity_1.CustomerHistoryEntry({
+            createdAt: new Date(),
+            type,
+            isPublic,
+            data: data,
+            customer: { id: customerId },
+            administrator,
+        });
+        const history = await this.connection
+            .getRepository(ctx, customer_history_entry_entity_1.CustomerHistoryEntry)
+            .save(entry);
+        await this.eventBus.publish(new history_entry_event_1.HistoryEntryEvent(ctx, history, "created", "customer", {
+            type,
+            data,
+        }));
+        return history;
+    }
+    async updateOrderHistoryEntry(ctx, args) {
+        const entry = await this.connection.getEntityOrThrow(ctx, order_history_entry_entity_1.OrderHistoryEntry, args.entryId, {
+            where: { type: args.type },
+        });
+        if (args.data) {
+            entry.data = args.data;
+        }
+        if (typeof args.isPublic === "boolean") {
+            entry.isPublic = args.isPublic;
+        }
+        const administrator = await this.getAdministratorFromContext(ctx);
+        if (administrator) {
+            entry.administrator = administrator;
+        }
+        const newEntry = await this.connection
+            .getRepository(ctx, order_history_entry_entity_1.OrderHistoryEntry)
+            .save(entry);
+        await this.eventBus.publish(new history_entry_event_1.HistoryEntryEvent(ctx, entry, "updated", "order", args));
+        return newEntry;
+    }
+    async deleteOrderHistoryEntry(ctx, id) {
+        const entry = await this.connection.getEntityOrThrow(ctx, order_history_entry_entity_1.OrderHistoryEntry, id);
+        const deletedEntry = new order_history_entry_entity_1.OrderHistoryEntry(entry);
+        await this.connection.getRepository(ctx, order_history_entry_entity_1.OrderHistoryEntry).remove(entry);
+        await this.eventBus.publish(new history_entry_event_1.HistoryEntryEvent(ctx, deletedEntry, "deleted", "order", id));
+    }
+    async updateCustomerHistoryEntry(ctx, args) {
+        const entry = await this.connection.getEntityOrThrow(ctx, customer_history_entry_entity_1.CustomerHistoryEntry, args.entryId, {
+            where: { type: args.type },
+        });
+        if (args.data) {
+            entry.data = args.data;
+        }
+        const administrator = await this.getAdministratorFromContext(ctx);
+        if (administrator) {
+            entry.administrator = administrator;
+        }
+        const newEntry = await this.connection
+            .getRepository(ctx, customer_history_entry_entity_1.CustomerHistoryEntry)
+            .save(entry);
+        await this.eventBus.publish(new history_entry_event_1.HistoryEntryEvent(ctx, entry, "updated", "customer", args));
+        return newEntry;
+    }
+    async deleteCustomerHistoryEntry(ctx, id) {
+        const entry = await this.connection.getEntityOrThrow(ctx, customer_history_entry_entity_1.CustomerHistoryEntry, id);
+        const deletedEntry = new customer_history_entry_entity_1.CustomerHistoryEntry(entry);
+        await this.connection
+            .getRepository(ctx, customer_history_entry_entity_1.CustomerHistoryEntry)
+            .remove(entry);
+        await this.eventBus.publish(new history_entry_event_1.HistoryEntryEvent(ctx, deletedEntry, "deleted", "customer", id));
+    }
+    async getAdministratorFromContext(ctx) {
+        const administrator = ctx.activeUserId
+            ? await this.administratorService.findOneByUserId(ctx, ctx.activeUserId)
+            : null;
+        return administrator !== null && administrator !== void 0 ? administrator : undefined;
+    }
+};
+exports.HistoryService = HistoryService;
+exports.HistoryService = HistoryService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [transactional_connection_1.TransactionalConnection,
+        administrator_service_1.AdministratorService,
+        list_query_builder_1.ListQueryBuilder,
+        event_bus_1.EventBus])
+], HistoryService);
+//# sourceMappingURL=history.service.js.map

package/dist/service/services/history.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.service.js","sourceRoot":"","sources":["../../../src/service/services/history.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAE5C,yEAM6C;AAI7C,wFAAoF;AAEpF,4GAAgG;AAChG,0FAA+E;AAC/E,sGAA0F;AAC1F,+CAA2C;AAC3C,oFAA+E;AAE/E,yFAAoF;AAKpF,mEAA+D;AAoI/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiGG;AAEI,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,YACU,UAAmC,EACnC,oBAA0C,EAC1C,gBAAkC,EAClC,QAAkB;QAHlB,eAAU,GAAV,UAAU,CAAyB;QACnC,yBAAoB,GAApB,oBAAoB,CAAsB;QAC1C,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,aAAQ,GAAR,QAAQ,CAAU;IACzB,CAAC;IAEJ,KAAK,CAAC,kBAAkB,CACtB,GAAmB,EACnB,OAAW,EACX,UAAmB,EACnB,OAAiC;QAEjC,OAAO,IAAI,CAAC,gBAAgB;aACzB,KAAK,CAAC,mCAA8C,EAAE,OAAO,EAAE;YAC9D,KAAK,kBACH,KAAK,EAAE,EAAE,EAAE,EAAE,OAAO,EAAS,IAC1B,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC1C;YACD,SAAS,EAAE,CAAC,eAAe,CAAC;YAC5B,GAAG;SACJ,CAAC;aACD,eAAe,EAAE;aACjB,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9B,KAAK;YACL,UAAU;SACX,CAAC,CAAC,CAAC;IACR,CAAC;IAED,KAAK,CAAC,0BAA0B,CAC9B,IAAoC,EACpC,QAAQ,GAAG,IAAI;QAEf,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAC1C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAClE,MAAM,KAAK,GAAG,IAAI,8CAAiB,CAAC;YAClC,IAAI;YACJ,QAAQ;YACR,IAAI,EAAE,IAAW;YACjB,KAAK,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE;YACtB,aAAa;SACd,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU;aAClC,aAAa,CAAC,GAAG,EAAE,8CAAiB,CAAC;aACrC,IAAI,CAAC,KAAK,CAAC,CAAC;QACf,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,uCAAiB,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CACxE,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,qBAAqB,CACzB,GAAmB,EACnB,UAAc,EACd,UAAmB,EACnB,OAAiC;QAEjC,OAAO,IAAI,CAAC,gBAAgB;aACzB,KAAK,CAAC,mCAAiD,EAAE,OAAO,EAAE;YACjE,KAAK,kBACH,QAAQ,EAAE,EAAE,EAAE,EAAE,UAAU,EAAS,IAChC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC1C;YACD,SAAS,EAAE,CAAC,eAAe,CAAC;YAC5B,GAAG;SACJ,CAAC;aACD,eAAe,EAAE;aACjB,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9B,KAAK;YACL,UAAU;SACX,CAAC,CAAC,CAAC;IACR,CAAC;IAED,KAAK,CAAC,6BAA6B,CACjC,IAAuC,EACvC,QAAQ,GAAG,KAAK;QAEhB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAC7C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAClE,MAAM,KAAK,GAAG,IAAI,oDAAoB,CAAC;YACrC,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,IAAI;YACJ,QAAQ;YACR,IAAI,EAAE,IAAW;YACjB,QAAQ,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE;YAC5B,aAAa;SACd,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU;aAClC,aAAa,CAAC,GAAG,EAAE,oDAAoB,CAAC;aACxC,IAAI,CAAC,KAAK,CAAC,CAAC;QACf,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,uCAAiB,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE;YACzD,IAAI;YACJ,IAAI;SACL,CAAC,CACH,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,uBAAuB,CAC3B,GAAmB,EACnB,IAAoC;QAEpC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAClD,GAAG,EACH,8CAAiB,EACjB,IAAI,CAAC,OAAO,EACZ;YACE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;SAC3B,CACF,CAAC;QAEF,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACzB,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACvC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjC,CAAC;QACD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAClE,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,CAAC,aAAa,GAAG,aAAa,CAAC;QACtC,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU;aACnC,aAAa,CAAC,GAAG,EAAE,8CAAiB,CAAC;aACrC,IAAI,CAAC,KAAK,CAAC,CAAC;QACf,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,uCAAiB,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,CAC5D,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,GAAmB,EAAE,EAAM;QACvD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAClD,GAAG,EACH,8CAAiB,EACjB,EAAE,CACH,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,8CAAiB,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,8CAAiB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1E,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,uCAAiB,CAAC,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,CAAC,CACjE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,0BAA0B,CAC9B,GAAmB,EACnB,IAAuC;QAEvC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAClD,GAAG,EACH,oDAAoB,EACpB,IAAI,CAAC,OAAO,EACZ;YACE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;SAC3B,CACF,CAAC;QAEF,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACzB,CAAC;QACD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAClE,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,CAAC,aAAa,GAAG,aAAa,CAAC;QACtC,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU;aACnC,aAAa,CAAC,GAAG,EAAE,oDAAoB,CAAC;aACxC,IAAI,CAAC,KAAK,CAAC,CAAC;QACf,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,uCAAiB,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,CAC/D,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,0BAA0B,CAAC,GAAmB,EAAE,EAAM;QAC1D,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAClD,GAAG,EACH,oDAAoB,EACpB,EAAE,CACH,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,oDAAoB,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,IAAI,CAAC,UAAU;aAClB,aAAa,CAAC,GAAG,EAAE,oDAAoB,CAAC;aACxC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjB,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,uCAAiB,CAAC,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,CAAC,CACpE,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,2BAA2B,CACvC,GAAmB;QAEnB,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY;YACpC,CAAC,CAAC,MAAM,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAC;YACxE,CAAC,CAAC,IAAI,CAAC;QACT,OAAO,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,SAAS,CAAC;IACpC,CAAC;CACF,CAAA;AArMY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;qCAGW,kDAAuB;QACb,4CAAoB;QACxB,qCAAgB;QACxB,oBAAQ;GALjB,cAAc,CAqM1B"}

package/dist/service/services/order-testing.service.d.ts

@@ -0,0 +1,39 @@
+import { ShippingMethodQuote, TestEligibleShippingMethodsInput, TestShippingMethodInput, TestShippingMethodResult } from "@deenruv/common/lib/generated-types";
+import { RequestContext } from "../../api/common/request-context";
+import { ConfigService } from "../../config/config.service";
+import { TransactionalConnection } from "../../connection/transactional-connection";
+import { ConfigArgService } from "../helpers/config-arg/config-arg.service";
+import { OrderCalculator } from "../helpers/order-calculator/order-calculator";
+import { ProductPriceApplicator } from "../helpers/product-price-applicator/product-price-applicator";
+import { ShippingCalculator } from "../helpers/shipping-calculator/shipping-calculator";
+import { TranslatorService } from "../helpers/translator/translator.service";
+/**
+ * @description
+ * This service is responsible for creating temporary mock Orders against which tests can be run, such as
+ * testing a ShippingMethod or Promotion.
+ *
+ * @docsCategory services
+ */
+export declare class OrderTestingService {
+    private connection;
+    private orderCalculator;
+    private shippingCalculator;
+    private configArgService;
+    private configService;
+    private productPriceApplicator;
+    private translator;
+    constructor(connection: TransactionalConnection, orderCalculator: OrderCalculator, shippingCalculator: ShippingCalculator, configArgService: ConfigArgService, configService: ConfigService, productPriceApplicator: ProductPriceApplicator, translator: TranslatorService);
+    /**
+     * @description
+     * Runs a given ShippingMethod configuration against a mock Order to test for eligibility and resulting
+     * price.
+     */
+    testShippingMethod(ctx: RequestContext, input: TestShippingMethodInput): Promise<TestShippingMethodResult>;
+    /**
+     * @description
+     * Tests all available ShippingMethods against a mock Order and return those which are eligible. This
+     * is intended to simulate a call to the `eligibleShippingMethods` query of the Shop API.
+     */
+    testEligibleShippingMethods(ctx: RequestContext, input: TestEligibleShippingMethodsInput): Promise<ShippingMethodQuote[]>;
+    private buildMockOrder;
+}