@unchainedshop/core-delivery 1.1.3

package/lib/director/DeliveryPricingSheet.js

@@ -0,0 +1,92 @@
+import { BasePricingSheet } from '@unchainedshop/utils';
+import { DeliveryPricingRowCategory, } from '@unchainedshop/types/delivery.pricing';
+export const DeliveryPricingSheet = (params) => {
+    const basePricingSheet = BasePricingSheet(params);
+    const pricingSheet = {
+        ...basePricingSheet,
+        addDiscount({ amount, isTaxable, isNetPrice, discountId, meta }) {
+            basePricingSheet.calculation.push({
+                category: DeliveryPricingRowCategory.Discount,
+                amount,
+                isTaxable,
+                isNetPrice,
+                discountId,
+                meta,
+            });
+        },
+        addFee({ amount, isTaxable, isNetPrice, meta }) {
+            basePricingSheet.calculation.push({
+                amount,
+                category: DeliveryPricingRowCategory.Delivery,
+                isNetPrice,
+                isTaxable,
+                meta,
+            });
+        },
+        addTax({ amount, rate, meta }) {
+            basePricingSheet.calculation.push({
+                amount,
+                category: DeliveryPricingRowCategory.Tax,
+                isNetPrice: false,
+                isTaxable: false,
+                meta,
+                rate,
+            });
+        },
+        taxSum() {
+            return basePricingSheet.sum({
+                category: DeliveryPricingRowCategory.Tax,
+            });
+        },
+        feeSum() {
+            return basePricingSheet.sum({
+                category: DeliveryPricingRowCategory.Delivery,
+            });
+        },
+        discountSum(discountId) {
+            return basePricingSheet.sum({
+                category: DeliveryPricingRowCategory.Discount,
+                discountId,
+            });
+        },
+        discountPrices(explicitDiscountId) {
+            const discountIds = pricingSheet
+                .getDiscountRows(explicitDiscountId)
+                .map(({ discountId }) => discountId);
+            return [...new Set(discountIds)]
+                .map((discountId) => {
+                const amount = basePricingSheet.sum({
+                    category: DeliveryPricingRowCategory.Discount,
+                    discountId,
+                });
+                if (!amount) {
+                    return null;
+                }
+                return {
+                    discountId,
+                    amount: Math.round(amount),
+                    currency: basePricingSheet.currency,
+                };
+            })
+                .filter(Boolean);
+        },
+        getFeeRows() {
+            return basePricingSheet.filterBy({
+                category: DeliveryPricingRowCategory.Item,
+            });
+        },
+        getDiscountRows(discountId) {
+            return basePricingSheet.filterBy({
+                category: DeliveryPricingRowCategory.Discount,
+                discountId,
+            });
+        },
+        getTaxRows() {
+            return basePricingSheet.filterBy({
+                category: DeliveryPricingRowCategory.Tax,
+            });
+        },
+    };
+    return pricingSheet;
+};
+//# sourceMappingURL=DeliveryPricingSheet.js.map

package/lib/director/DeliveryPricingSheet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeliveryPricingSheet.js","sourceRoot":"","sources":["../../src/director/DeliveryPricingSheet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAEL,0BAA0B,GAE3B,MAAM,uCAAuC,CAAC;AAG/C,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,MAAsD,EAC/B,EAAE;IACzB,MAAM,gBAAgB,GAAkD,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAEjG,MAAM,YAAY,GAA0B;QAC1C,GAAG,gBAAgB;QAEnB,WAAW,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE;YAC7D,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC;gBAChC,QAAQ,EAAE,0BAA0B,CAAC,QAAQ;gBAC7C,MAAM;gBACN,SAAS;gBACT,UAAU;gBACV,UAAU;gBACV,IAAI;aACL,CAAC,CAAC;QACL,CAAC;QAED,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE;YAC5C,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC;gBAChC,MAAM;gBACN,QAAQ,EAAE,0BAA0B,CAAC,QAAQ;gBAC7C,UAAU;gBACV,SAAS;gBACT,IAAI;aACL,CAAC,CAAC;QACL,CAAC;QAED,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;YAC3B,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC;gBAChC,MAAM;gBACN,QAAQ,EAAE,0BAA0B,CAAC,GAAG;gBACxC,UAAU,EAAE,KAAK;gBACjB,SAAS,EAAE,KAAK;gBAChB,IAAI;gBACJ,IAAI;aACL,CAAC,CAAC;QACL,CAAC;QAED,MAAM;YACJ,OAAO,gBAAgB,CAAC,GAAG,CAAC;gBAC1B,QAAQ,EAAE,0BAA0B,CAAC,GAAG;aACzC,CAAC,CAAC;QACL,CAAC;QAED,MAAM;YACJ,OAAO,gBAAgB,CAAC,GAAG,CAAC;gBAC1B,QAAQ,EAAE,0BAA0B,CAAC,QAAQ;aAC9C,CAAC,CAAC;QACL,CAAC;QAED,WAAW,CAAC,UAAU;YACpB,OAAO,gBAAgB,CAAC,GAAG,CAAC;gBAC1B,QAAQ,EAAE,0BAA0B,CAAC,QAAQ;gBAC7C,UAAU;aACX,CAAC,CAAC;QACL,CAAC;QAED,cAAc,CAAC,kBAAkB;YAC/B,MAAM,WAAW,GAAG,YAAY;iBAC7B,eAAe,CAAC,kBAAkB,CAAC;iBACnC,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC;YAEvC,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;iBAC7B,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;gBAClB,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC;oBAClC,QAAQ,EAAE,0BAA0B,CAAC,QAAQ;oBAC7C,UAAU;iBACX,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,EAAE;oBACX,OAAO,IAAI,CAAC;iBACb;gBACD,OAAO;oBACL,UAAU;oBACV,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;oBAC1B,QAAQ,EAAE,gBAAgB,CAAC,QAAQ;iBACpC,CAAC;YACJ,CAAC,CAAC;iBACD,MAAM,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC;QAED,UAAU;YACR,OAAO,gBAAgB,CAAC,QAAQ,CAAC;gBAC/B,QAAQ,EAAE,0BAA0B,CAAC,IAAI;aAC1C,CAAC,CAAC;QACL,CAAC;QAED,eAAe,CAAC,UAAU;YACxB,OAAO,gBAAgB,CAAC,QAAQ,CAAC;gBAC/B,QAAQ,EAAE,0BAA0B,CAAC,QAAQ;gBAC7C,UAAU;aACX,CAAC,CAAC;QACL,CAAC;QAED,UAAU;YACR,OAAO,gBAAgB,CAAC,QAAQ,CAAC;gBAC/B,QAAQ,EAAE,0BAA0B,CAAC,GAAG;aACzC,CAAC,CAAC;QACL,CAAC;KACF,CAAC;IAEF,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC"}

package/lib/director/DeliveryProviderType.d.ts

@@ -0,0 +1,4 @@
+export declare enum DeliveryProviderType {
+    SHIPPING = "SHIPPING",
+    PICKUP = "PICKUP"
+}

package/lib/director/DeliveryProviderType.js

@@ -0,0 +1,6 @@
+export var DeliveryProviderType;
+(function (DeliveryProviderType) {
+    DeliveryProviderType["SHIPPING"] = "SHIPPING";
+    DeliveryProviderType["PICKUP"] = "PICKUP";
+})(DeliveryProviderType || (DeliveryProviderType = {}));
+//# sourceMappingURL=DeliveryProviderType.js.map

package/lib/director/DeliveryProviderType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeliveryProviderType.js","sourceRoot":"","sources":["../../src/director/DeliveryProviderType.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,6CAAqB,CAAA;IACrB,yCAAiB,CAAA;AACnB,CAAC,EAHW,oBAAoB,KAApB,oBAAoB,QAG/B"}

package/lib/module/configureDeliveryModule.d.ts

@@ -0,0 +1,3 @@
+import { ModuleInput } from '@unchainedshop/types/common';
+import { DeliveryModule, DeliverySettingsOptions } from '@unchainedshop/types/delivery';
+export declare const configureDeliveryModule: ({ db, options: deliveryOptions, }: ModuleInput<DeliverySettingsOptions>) => Promise<DeliveryModule>;

package/lib/module/configureDeliveryModule.js

@@ -0,0 +1,137 @@
+import { emit, registerEvents } from '@unchainedshop/events';
+import { generateDbFilterById, generateDbMutations } from '@unchainedshop/utils';
+import { DeliveryPricingSheet } from '../director/DeliveryPricingSheet';
+import { DeliveryProvidersCollection } from '../db/DeliveryProvidersCollection';
+import { DeliveryProvidersSchema } from '../db/DeliveryProvidersSchema';
+import { deliverySettings } from '../delivery-settings';
+import { DeliveryDirector } from '../director/DeliveryDirector';
+import { DeliveryPricingDirector } from '../director/DeliveryPricingDirector';
+const DELIVERY_PROVIDER_EVENTS = [
+    'DELIVERY_PROVIDER_CREATE',
+    'DELIVERY_PROVIDER_UPDATE',
+    'DELIVERY_PROVIDER_REMOVE',
+];
+const asyncFilter = async (arr, predicate) => {
+    const results = await Promise.all(arr.map(predicate));
+    return arr.filter((_v, index) => results[index]);
+};
+const buildFindSelector = ({ type } = {}) => {
+    return { ...(type ? { type } : {}), deleted: null };
+};
+export const configureDeliveryModule = async ({ db, options: deliveryOptions = {}, }) => {
+    registerEvents(DELIVERY_PROVIDER_EVENTS);
+    deliverySettings.configureSettings(deliveryOptions);
+    const DeliveryProviders = await DeliveryProvidersCollection(db);
+    const mutations = generateDbMutations(DeliveryProviders, DeliveryProvidersSchema);
+    const getDeliveryAdapter = async (deliveryProviderId, deliveryContext, requestContext) => {
+        const provider = await DeliveryProviders.findOne(generateDbFilterById(deliveryProviderId), {});
+        return DeliveryDirector.actions(provider, deliveryContext, requestContext);
+    };
+    return {
+        // Queries
+        count: async (query) => {
+            const providerCount = await DeliveryProviders.countDocuments(buildFindSelector(query));
+            return providerCount;
+        },
+        findProvider: async ({ deliveryProviderId, ...query }, options) => {
+            return DeliveryProviders.findOne(deliveryProviderId ? generateDbFilterById(deliveryProviderId) : query, options);
+        },
+        findProviders: async (query, options) => {
+            const providers = DeliveryProviders.find(buildFindSelector(query), options);
+            return providers.toArray();
+        },
+        providerExists: async ({ deliveryProviderId }) => {
+            const providerCount = await DeliveryProviders.countDocuments(generateDbFilterById(deliveryProviderId, { deleted: null }), { limit: 1 });
+            return !!providerCount;
+        },
+        // Delivery Adapter
+        findInterface: (deliveryProvider) => {
+            return DeliveryDirector.getAdapter(deliveryProvider.adapterKey);
+        },
+        findInterfaces: ({ type }) => {
+            return DeliveryDirector.getAdapters({
+                adapterFilter: (Adapter) => Adapter.typeSupported(type),
+            }).map((Adapter) => ({
+                _id: Adapter.key,
+                label: Adapter.label,
+                version: Adapter.version,
+            }));
+        },
+        findSupported: async (deliveryContext, requestContext) => {
+            const foundProviders = await DeliveryProviders.find(buildFindSelector({})).toArray();
+            const providers = await asyncFilter(foundProviders, async (provider) => {
+                try {
+                    const director = await DeliveryDirector.actions(provider, deliveryContext, requestContext);
+                    return director.isActive();
+                }
+                catch {
+                    return false;
+                }
+            });
+            return deliverySettings.filterSupportedProviders({
+                providers,
+                order: deliveryContext.order,
+            }, requestContext);
+        },
+        determineDefault: async (deliveryProviders, deliveryContext, requestContext) => {
+            return deliverySettings.determineDefaultProvider({
+                providers: deliveryProviders,
+                ...deliveryContext,
+            }, requestContext);
+        },
+        configurationError: async (deliveryProvider, requestContext) => {
+            const director = await DeliveryDirector.actions(deliveryProvider, {}, requestContext);
+            return director.configurationError();
+        },
+        isActive: async (deliveryProvider, requestContext) => {
+            const director = await DeliveryDirector.actions(deliveryProvider, {}, requestContext);
+            return Boolean(director.isActive());
+        },
+        isAutoReleaseAllowed: async (deliveryProvider, requestContext) => {
+            const director = await DeliveryDirector.actions(deliveryProvider, {}, requestContext);
+            return Boolean(director.isAutoReleaseAllowed());
+        },
+        calculate: async (pricingContext, requestContext) => {
+            const pricing = await DeliveryPricingDirector.actions(pricingContext, requestContext);
+            return pricing.calculate();
+        },
+        send: async (deliveryProviderId, deliveryContext, requestContext) => {
+            const adapter = await getDeliveryAdapter(deliveryProviderId, deliveryContext, requestContext);
+            return adapter.send();
+        },
+        pricingSheet: (params) => {
+            return DeliveryPricingSheet(params);
+        },
+        // Mutations
+        create: async (doc, userId) => {
+            const Adapter = DeliveryDirector.getAdapter(doc.adapterKey);
+            if (!Adapter)
+                return null;
+            const deliveryProviderId = await mutations.create({
+                configuration: Adapter.initialConfiguration,
+                ...doc,
+            }, userId);
+            const deliveryProvider = await DeliveryProviders.findOne(generateDbFilterById(deliveryProviderId), {});
+            emit('DELIVERY_PROVIDER_CREATE', { deliveryProvider });
+            return deliveryProvider;
+        },
+        update: async (_id, doc, userId) => {
+            await mutations.update(_id, doc, userId);
+            const deliveryProvider = await DeliveryProviders.findOne(generateDbFilterById(_id), {});
+            emit('DELIVERY_PROVIDER_UPDATE', { deliveryProvider });
+            return deliveryProvider;
+        },
+        delete: async (_id, userId) => {
+            await mutations.delete(_id, userId);
+            const deliveryProvider = await DeliveryProviders.findOne(generateDbFilterById(_id), {});
+            emit('DELIVERY_PROVIDER_REMOVE', { deliveryProvider });
+            return deliveryProvider;
+        },
+        deletePermanently: async (_id, userId) => {
+            const deliveryProvider = await DeliveryProviders.findOne(generateDbFilterById(_id), {});
+            await mutations.deletePermanently(_id, userId);
+            return deliveryProvider;
+        },
+    };
+};
+//# sourceMappingURL=configureDeliveryModule.js.map

package/lib/module/configureDeliveryModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configureDeliveryModule.js","sourceRoot":"","sources":["../../src/module/configureDeliveryModule.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,2BAA2B,EAAE,MAAM,mCAAmC,CAAC;AAChF,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAE9E,MAAM,wBAAwB,GAAa;IACzC,0BAA0B;IAC1B,0BAA0B;IAC1B,0BAA0B;CAC3B,CAAC;AAEF,MAAM,WAAW,GAAG,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE;IAC3C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IAEtD,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,EAAE,IAAI,KAA4B,EAAE,EAAE,EAAE;IACjE,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AACtD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAE,EAC5C,EAAE,EACF,OAAO,EAAE,eAAe,GAAG,EAAE,GACQ,EAA2B,EAAE;IAClE,cAAc,CAAC,wBAAwB,CAAC,CAAC;IAEzC,gBAAgB,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAEpD,MAAM,iBAAiB,GAAG,MAAM,2BAA2B,CAAC,EAAE,CAAC,CAAC;IAEhE,MAAM,SAAS,GAAG,mBAAmB,CACnC,iBAAiB,EACjB,uBAAuB,CACa,CAAC;IAEvC,MAAM,kBAAkB,GAAG,KAAK,EAC9B,kBAA0B,EAC1B,eAAgC,EAChC,cAAuB,EACvB,EAAE;QACF,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,EAAE,EAAE,CAAC,CAAC;QAE/F,OAAO,gBAAgB,CAAC,OAAO,CAAC,QAAQ,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC;IAC7E,CAAC,CAAC;IAEF,OAAO;QACL,UAAU;QACV,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;YACvF,OAAO,aAAa,CAAC;QACvB,CAAC;QAED,YAAY,EAAE,KAAK,EAAE,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE;YAChE,OAAO,iBAAiB,CAAC,OAAO,CAC9B,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,KAAK,EACrE,OAAO,CACR,CAAC;QACJ,CAAC;QAED,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACtC,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5E,OAAO,SAAS,CAAC,OAAO,EAAE,CAAC;QAC7B,CAAC;QAED,cAAc,EAAE,KAAK,EAAE,EAAE,kBAAkB,EAAE,EAAE,EAAE;YAC/C,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAAC,cAAc,CAC1D,oBAAoB,CAAC,kBAAkB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAC3D,EAAE,KAAK,EAAE,CAAC,EAAE,CACb,CAAC;YACF,OAAO,CAAC,CAAC,aAAa,CAAC;QACzB,CAAC;QAED,mBAAmB;QAEnB,aAAa,EAAE,CAAC,gBAAgB,EAAE,EAAE;YAClC,OAAO,gBAAgB,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAClE,CAAC;QAED,cAAc,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;YAC3B,OAAO,gBAAgB,CAAC,WAAW,CAAC;gBAClC,aAAa,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC;aACxD,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBACnB,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,OAAO,EAAE,OAAO,CAAC,OAAO;aACzB,CAAC,CAAC,CAAC;QACN,CAAC;QAED,aAAa,EAAE,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,EAAE;YACvD,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YACrF,MAAM,SAAS,GAAsB,MAAM,WAAW,CACpD,cAAc,EACd,KAAK,EAAE,QAA0B,EAAE,EAAE;gBACnC,IAAI;oBACF,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,QAAQ,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC;oBAC3F,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;iBAC5B;gBAAC,MAAM;oBACN,OAAO,KAAK,CAAC;iBACd;YACH,CAAC,CACF,CAAC;YAEF,OAAO,gBAAgB,CAAC,wBAAwB,CAC9C;gBACE,SAAS;gBACT,KAAK,EAAE,eAAe,CAAC,KAAK;aAC7B,EACD,cAAc,CACf,CAAC;QACJ,CAAC;QAED,gBAAgB,EAAE,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,EAAE;YAC7E,OAAO,gBAAgB,CAAC,wBAAwB,CAC9C;gBACE,SAAS,EAAE,iBAAiB;gBAC5B,GAAG,eAAe;aACnB,EACD,cAAc,CACf,CAAC;QACJ,CAAC;QAED,kBAAkB,EAAE,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,EAAE;YAC7D,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;YACtF,OAAO,QAAQ,CAAC,kBAAkB,EAAE,CAAC;QACvC,CAAC;QAED,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,EAAE;YACnD,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;YACtF,OAAO,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtC,CAAC;QAED,oBAAoB,EAAE,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,EAAE;YAC/D,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;YACtF,OAAO,OAAO,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;QAClD,CAAC;QAED,SAAS,EAAE,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,EAAE;YAClD,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAAC,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;YACtF,OAAO,OAAO,CAAC,SAAS,EAAE,CAAC;QAC7B,CAAC;QAED,IAAI,EAAE,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,cAAc,EAAE,EAAE;YAClE,MAAM,OAAO,GAAG,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC;YAC9F,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC;QAED,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;YACvB,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACtC,CAAC;QAED,YAAY;QACZ,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;YAC5B,MAAM,OAAO,GAAG,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC5D,IAAI,CAAC,OAAO;gBAAE,OAAO,IAAI,CAAC;YAE1B,MAAM,kBAAkB,GAAG,MAAM,SAAS,CAAC,MAAM,CAC/C;gBACE,aAAa,EAAE,OAAO,CAAC,oBAAoB;gBAC3C,GAAG,GAAG;aACP,EACD,MAAM,CACP,CAAC;YACF,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,OAAO,CACtD,oBAAoB,CAAC,kBAAkB,CAAC,EACxC,EAAE,CACH,CAAC;YACF,IAAI,CAAC,0BAA0B,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;YACvD,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAW,EAAE,GAAqB,EAAE,MAAc,EAAE,EAAE;YACnE,MAAM,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;YACzC,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YACxF,IAAI,CAAC,0BAA0B,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;YACvD,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;YAC5B,MAAM,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YACpC,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YACxF,IAAI,CAAC,0BAA0B,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;YACvD,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,iBAAiB,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;YACvC,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YACxF,MAAM,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAC/C,OAAO,gBAAgB,CAAC;QAC1B,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/package.js

@@ -0,0 +1,33 @@
+Package.describe({
+  name: 'unchained:core-delivery',
+  version: '1.1.3',
+  summary: 'Unchained Engine Core: Delivery',
+  git: 'https://github.com/unchainedshop/unchained',
+  documentation: 'README.md',
+});
+
+Npm.depends({
+  'simpl-schema': '1.12.0',
+  '@unchainedshop/logger': '1.1.3',
+  '@unchainedshop/utils': '1.1.3',
+  // '@unchainedshop/events': '1.1.4', // PEER
+});
+
+Package.onUse((api) => {
+  api.versionsFrom('2.7.3');
+  api.use('ecmascript');
+  api.use('typescript');
+
+  api.mainModule('src/delivery-index.ts', 'server');
+});
+
+Package.onTest((api) => {
+  api.use('meteortesting:mocha');
+  api.use('ecmascript');
+  api.use('typescript');
+
+  api.use('unchained:mongodb');
+  api.use('unchained:core-delivery');
+
+  api.mainModule('tests/delivery-index.test.ts');
+});

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@unchainedshop/core-delivery",
+  "version": "1.1.3",
+  "main": "lib/delivery-index.js",
+  "types": "lib/delivery-index.d.ts",
+  "type": "module",
+  "scripts": {
+    "clean": "rm -rf lib",
+    "build": "npm run clean && tsc -p tsconfig.build.json",
+    "watch": "tsc --watch",
+    "link:core": "npm link @unchainedshop/types",
+    "test": "cross-env METEOR_PACKAGE_DIRS=../ TEST_CLIENT=0 TEST_WATCH=1 meteor test-packages ./ --driver-package meteortesting:mocha --port 4200"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unchainedshop/unchained.git"
+  },
+  "keywords": [
+    "unchained",
+    "ecommerce",
+    "core"
+  ],
+  "author": "Joël Meiller",
+  "license": "EUPL-1.2",
+  "bugs": {
+    "url": "https://github.com/unchainedshop/unchained/issues"
+  },
+  "homepage": "https://github.com/unchainedshop/unchained#readme",
+  "dependencies": {
+    "@unchainedshop/events": "latest",
+    "@unchainedshop/logger": "latest",
+    "@unchainedshop/utils": "latest",
+    "simpl-schema": "^1.12.2"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
+    "@unchainedshop/types": "latest",
+    "chai": "^4.3.6",
+    "cross-env": "^7.0.3",
+    "typescript": "^4.7.4"
+  }
+}

package/src/db/DeliveryProvidersCollection.ts

@@ -0,0 +1,11 @@
+import { Db } from '@unchainedshop/types/common';
+import { DeliveryProvider } from '@unchainedshop/types/delivery';
+import { buildDbIndexes } from '@unchainedshop/utils';
+
+export const DeliveryProvidersCollection = async (db: Db) => {
+  const DeliveryProviders = db.collection<DeliveryProvider>('delivery-providers');
+
+  await buildDbIndexes<DeliveryProvider>(DeliveryProviders, [{ index: { type: 1 } }]);
+
+  return DeliveryProviders;
+};

package/src/db/DeliveryProvidersSchema.js

@@ -0,0 +1,16 @@
+import { Schemas } from '@unchainedshop/utils';
+import SimpleSchema from 'simpl-schema';
+
+export const DeliveryProvidersSchema = new SimpleSchema(
+  {
+    type: { type: String, required: true },
+    adapterKey: { type: String, required: true },
+    authorId: { type: String, required: true },
+    configuration: { type: Array },
+    'configuration.$': { type: Object },
+    'configuration.$.key': { type: String },
+    'configuration.$.value': { type: String },
+    ...Schemas.timestampFields,
+  },
+  { requiredByDefault: false },
+);

package/src/delivery-index.ts

@@ -0,0 +1,11 @@
+export { configureDeliveryModule } from './module/configureDeliveryModule';
+
+export { deliverySettings } from './delivery-settings';
+
+export { DeliveryAdapter } from './director/DeliveryAdapter';
+export { DeliveryDirector } from './director/DeliveryDirector';
+export { DeliveryError } from './director/DeliveryError';
+export { DeliveryProviderType } from './director/DeliveryProviderType';
+
+export { DeliveryPricingAdapter } from './director/DeliveryPricingAdapter';
+export { DeliveryPricingDirector } from './director/DeliveryPricingDirector';

package/src/delivery-settings.ts

@@ -0,0 +1,46 @@
+import {
+  DeliveryProvider,
+  DeliverySettings,
+  DetermineDefaultProvider,
+  FilterProviders,
+} from '@unchainedshop/types/delivery';
+import { createLogger } from '@unchainedshop/logger';
+
+const logger = createLogger('unchained:core-delivery');
+
+const sortByCreationDate = (left: DeliveryProvider, right: DeliveryProvider) => {
+  return new Date(left.created).getTime() - new Date(right.created).getTime();
+};
+
+const allProviders: FilterProviders = async ({ providers }) => {
+  return providers.sort(sortByCreationDate);
+};
+
+const firstProviderIsDefault: DetermineDefaultProvider = async ({ providers }) => {
+  return providers?.length > 0 && providers[0];
+};
+
+const defaultFilterSupportedProviders =
+  (sortProviders) =>
+  async ({ providers }) => {
+    return providers.sort(sortProviders);
+  };
+
+export const deliverySettings: DeliverySettings = {
+  filterSupportedProviders: null,
+  determineDefaultProvider: null,
+
+  configureSettings({
+    sortProviders = undefined,
+    filterSupportedProviders = allProviders,
+    determineDefaultProvider = firstProviderIsDefault,
+  } = {}) {
+    if (sortProviders) {
+      logger.warn('sortProviders is deprecated, please specifc filterSupportedProviders instead');
+      deliverySettings.filterSupportedProviders = defaultFilterSupportedProviders(sortProviders);
+    } else {
+      deliverySettings.filterSupportedProviders = filterSupportedProviders;
+    }
+    deliverySettings.determineDefaultProvider = determineDefaultProvider;
+  },
+};

package/src/director/DeliveryAdapter.ts

@@ -0,0 +1,56 @@
+import { IDeliveryAdapter } from '@unchainedshop/types/delivery';
+import { log, LogLevel } from '@unchainedshop/logger';
+import { DeliveryError } from './DeliveryError';
+
+export const DeliveryAdapter: Omit<IDeliveryAdapter, 'key' | 'label' | 'version'> = {
+  initialConfiguration: [],
+
+  typeSupported: () => {
+    return false;
+  },
+
+  actions: () => {
+    return {
+      configurationError: () => {
+        return DeliveryError.NOT_IMPLEMENTED;
+      },
+
+      estimatedDeliveryThroughput: async () => {
+        return 0;
+      },
+
+      isActive: () => {
+        return false;
+      },
+
+      isAutoReleaseAllowed: () => {
+        // if you return false here,
+        // the order will need manual confirmation before
+        // unchained will try to invoke send()
+        return true;
+      },
+
+      send: async () => {
+        // if you return true, the status will be changed to DELIVERED
+
+        // if you return false, the order delivery status stays the
+        // same but the order status might change
+
+        // if you throw an error, you cancel the whole checkout process
+        return false;
+      },
+
+      pickUpLocationById: async () => {
+        return null;
+      },
+
+      pickUpLocations: async () => {
+        return [];
+      },
+    };
+  },
+
+  log: (message: string, { level = LogLevel.Debug, ...options } = {}) => {
+    return log(message, { level, ...options });
+  },
+};

package/src/director/DeliveryDirector.ts

@@ -0,0 +1,76 @@
+import { IDeliveryAdapter, IDeliveryDirector } from '@unchainedshop/types/delivery';
+import { log, LogLevel } from '@unchainedshop/logger';
+import { BaseDirector } from '@unchainedshop/utils';
+import { DeliveryError } from './DeliveryError';
+
+const baseDirector = BaseDirector<IDeliveryAdapter>('DeliveryDirector');
+
+export const DeliveryDirector: IDeliveryDirector = {
+  ...baseDirector,
+
+  actions: async (deliveryProvider, deliveryContext, requestContext) => {
+    const Adapter = baseDirector.getAdapter(deliveryProvider.adapterKey);
+
+    const context = { ...deliveryContext, ...requestContext };
+    const adapter = Adapter.actions(deliveryProvider.configuration, context);
+
+    return {
+      configurationError: () => {
+        try {
+          return adapter.configurationError();
+        } catch (error) {
+          return DeliveryError.ADAPTER_NOT_FOUND;
+        }
+      },
+
+      estimatedDeliveryThroughput: async (warehousingThroughputTime) => {
+        try {
+          const throughput = await adapter.estimatedDeliveryThroughput(warehousingThroughputTime);
+          return throughput;
+        } catch (error) {
+          log('Delivery Director -> Error while estimating delivery throughput', {
+            level: LogLevel.Warning,
+            ...error,
+          });
+          return null;
+        }
+      },
+
+      isActive: () => {
+        try {
+          return adapter.isActive();
+        } catch (error) {
+          log('Delivery Director -> Error while checking if is active', {
+            level: LogLevel.Warning,
+            ...error,
+          });
+          return false;
+        }
+      },
+
+      isAutoReleaseAllowed: () => {
+        try {
+          return adapter.isAutoReleaseAllowed();
+        } catch (error) {
+          log('Delivery Director -> Error while checking if auto release is allowed', {
+            level: LogLevel.Warning,
+            ...error,
+          });
+          return false;
+        }
+      },
+
+      send: async () => {
+        return adapter.send();
+      },
+
+      pickUpLocationById: async (locationId) => {
+        return adapter.pickUpLocationById(locationId);
+      },
+
+      pickUpLocations: async () => {
+        return adapter.pickUpLocations();
+      },
+    };
+  },
+};

package/src/director/DeliveryError.ts

@@ -0,0 +1,6 @@
+export enum DeliveryError {
+  ADAPTER_NOT_FOUND = 'ADAPTER_NOT_FOUND',
+  NOT_IMPLEMENTED = 'NOT_IMPLEMENTED',
+  INCOMPLETE_CONFIGURATION = 'INCOMPLETE_CONFIGURATION',
+  WRONG_CREDENTIALS = 'WRONG_CREDENTIALS',
+}

package/src/director/DeliveryPricingAdapter.ts

@@ -0,0 +1,39 @@
+import {
+  DeliveryPricingAdapterContext,
+  DeliveryPricingCalculation,
+  IDeliveryPricingAdapter,
+} from '@unchainedshop/types/delivery.pricing';
+import { BasePricingAdapter } from '@unchainedshop/utils';
+import { DeliveryPricingSheet } from './DeliveryPricingSheet';
+
+const basePricingAdapter = BasePricingAdapter<
+  DeliveryPricingAdapterContext,
+  DeliveryPricingCalculation
+>();
+
+export const DeliveryPricingAdapter: IDeliveryPricingAdapter = {
+  ...basePricingAdapter,
+
+  isActivatedFor: () => {
+    return false;
+  },
+
+  actions: (params) => {
+    const { context } = params;
+    const { currency } = context;
+    const baseActions = basePricingAdapter.actions(params);
+    const resultSheet = DeliveryPricingSheet({ currency });
+
+    return {
+      ...baseActions,
+      calculate: async () => {
+        const resultRaw = resultSheet.getRawPricingSheet();
+        resultRaw.forEach(({ amount, category }) =>
+          basePricingAdapter.log(`Delivery Calculation -> ${category} ${amount}`),
+        );
+        return resultRaw;
+      },
+      resultSheet: () => resultSheet,
+    };
+  },
+};