@unchainedshop/core 4.3.5 → 4.4.0

package/src/directors/PaymentPricingAdapter.ts

@@ -1,86 +0,0 @@
-import { PricingCalculation } from '@unchainedshop/utils';
-import {
-  BasePricingAdapter,
-  BasePricingAdapterContext,
-  IPricingAdapter,
-  IPricingSheet,
-} from '../directors/index.js';
-import { PaymentPricingSheet } from './PaymentPricingSheet.js';
-import { PaymentProvider } from '@unchainedshop/core-payment';
-import { OrderDiscount, OrderPayment, Order } from '@unchainedshop/core-orders';
-import { User } from '@unchainedshop/core-users';
-import { Modules } from '../modules.js';
-
-export interface PaymentPricingCalculation extends PricingCalculation {
-  discountId?: string;
-  isTaxable: boolean;
-  isNetPrice: boolean;
-  rate?: number;
-}
-export interface PaymentPricingAdapterContext extends BasePricingAdapterContext {
-  countryCode?: string;
-  currency?: string;
-  user: User | null;
-  orderPayment?: OrderPayment;
-  order: Order;
-  provider: PaymentProvider;
-  discounts: OrderDiscount[];
-}
-
-export type IPaymentPricingSheet = IPricingSheet<PaymentPricingCalculation> & {
-  addFee: (params: { amount: number; isTaxable: boolean; isNetPrice: boolean; meta?: any }) => void;
-  addTax: (params: {
-    amount: number;
-    rate: number;
-    baseCategory?: string;
-    discountId?: string;
-    meta?: any;
-  }) => void;
-  addDiscount: (params: {
-    amount: number;
-    isTaxable: boolean;
-    isNetPrice: boolean;
-    discountId: string;
-    meta?: any;
-  }) => void;
-};
-
-export type IPaymentPricingAdapter<DiscountConfiguration = unknown> = IPricingAdapter<
-  PaymentPricingAdapterContext & { modules: Modules },
-  PaymentPricingCalculation,
-  IPaymentPricingSheet,
-  DiscountConfiguration
->;
-
-const basePricingAdapter = BasePricingAdapter<PaymentPricingAdapterContext, PaymentPricingCalculation>();
-
-export const PaymentPricingAdapter: IPricingAdapter<
-  PaymentPricingAdapterContext,
-  PaymentPricingCalculation,
-  IPaymentPricingSheet
-> = {
-  ...basePricingAdapter,
-
-  isActivatedFor: () => {
-    return false;
-  },
-
-  actions: (params) => {
-    const { context } = params;
-    const { currencyCode } = context.order;
-    const baseActions = basePricingAdapter.actions(params);
-    const resultSheet = PaymentPricingSheet({ currencyCode });
-
-    return {
-      ...baseActions,
-      calculate: async () => {
-        const resultRaw = resultSheet.getRawPricingSheet();
-        resultRaw.forEach(({ amount, category }) =>
-          basePricingAdapter.log(`Payment Calculation -> ${category} ${amount}`),
-        );
-        return resultRaw;
-      },
-      resultSheet: () => resultSheet,
-    };
-  },
-};

package/src/directors/PaymentPricingDirector.ts

@@ -1,92 +0,0 @@
-import {
-  BasePricingDirector,
-  IPricingDirector,
-  IPaymentPricingAdapter,
-  IPaymentPricingSheet,
-  PaymentPricingAdapterContext,
-  PaymentPricingCalculation,
-} from '../directors/index.js';
-import { PaymentPricingSheet } from './PaymentPricingSheet.js';
-import { PaymentProvider } from '@unchainedshop/core-payment';
-import { OrderPayment, Order } from '@unchainedshop/core-orders';
-import { User } from '@unchainedshop/core-users';
-
-export type PaymentPricingContext =
-  | {
-      countryCode?: string;
-      currencyCode?: string;
-      user?: User;
-      order: Order;
-      provider: PaymentProvider;
-      providerContext?: any;
-    }
-  | {
-      currencyCode: string;
-      item: OrderPayment;
-    };
-
-export type IPaymentPricingDirector<DiscountConfiguration = unknown> = IPricingDirector<
-  PaymentPricingContext,
-  PaymentPricingCalculation,
-  PaymentPricingAdapterContext,
-  IPaymentPricingSheet,
-  IPaymentPricingAdapter<DiscountConfiguration>
->;
-
-const baseDirector = BasePricingDirector<
-  PaymentPricingContext,
-  PaymentPricingAdapterContext,
-  PaymentPricingCalculation,
-  IPaymentPricingAdapter
->('PaymentPricingDirector');
-
-export const PaymentPricingDirector: IPaymentPricingDirector<any> = {
-  ...baseDirector,
-
-  async buildPricingContext(context, unchainedAPI) {
-    const { modules } = unchainedAPI;
-
-    if ('item' in context) {
-      const { item, currencyCode } = context;
-      const order = await modules.orders.findOrder({
-        orderId: item.orderId,
-      });
-      const provider = await modules.payment.paymentProviders.findProvider({
-        paymentProviderId: item.paymentProviderId,
-      });
-      const user = await modules.users.findUserById(order!.userId);
-      const discounts = await modules.orders.discounts.findOrderDiscounts({
-        orderId: item.orderId,
-      });
-
-      return {
-        ...unchainedAPI,
-        countryCode: order!.countryCode,
-        currencyCode,
-        order: order!,
-        provider: provider!,
-        user,
-        discounts,
-        orderPayment: item,
-      };
-    }
-
-    return {
-      ...unchainedAPI,
-      countryCode: context.countryCode,
-      currencyCode: context.currencyCode,
-      order: context.order,
-      provider: context.provider,
-      user: context.user || null,
-      discounts: [],
-      providerContext: context.providerContext,
-    };
-  },
-
-  calculationSheet(pricingContext, calculation) {
-    return PaymentPricingSheet({
-      calculation,
-      currencyCode: pricingContext.currencyCode,
-    });
-  },
-};

package/src/directors/PaymentPricingSheet.ts

@@ -1,92 +0,0 @@
-import {
-  PaymentPricingCalculation,
-  IPaymentPricingSheet,
-  BasePricingSheet,
-  IBasePricingSheet,
-  PricingSheetParams,
-} from '../directors/index.js';
-
-export enum PaymentPricingRowCategory {
-  Item = 'ITEM',
-  Payment = 'PAYMENT',
-  Discount = 'DISCOUNT',
-  Tax = 'TAX',
-}
-
-export const PaymentPricingSheet = (
-  params: PricingSheetParams<PaymentPricingCalculation>,
-): IPaymentPricingSheet => {
-  const basePricingSheet: IBasePricingSheet<PaymentPricingCalculation> = BasePricingSheet(params);
-
-  const pricingSheet: IPaymentPricingSheet = {
-    ...basePricingSheet,
-
-    addDiscount({ amount, isTaxable, isNetPrice, discountId, meta }) {
-      basePricingSheet.calculation.push({
-        category: PaymentPricingRowCategory.Discount,
-        amount,
-        isTaxable,
-        isNetPrice,
-        discountId,
-        meta,
-      });
-    },
-
-    addFee({ amount, isTaxable, isNetPrice, meta }) {
-      basePricingSheet.calculation.push({
-        category: PaymentPricingRowCategory.Payment,
-        amount,
-        isTaxable,
-        isNetPrice,
-        meta,
-      });
-    },
-
-    addTax({ amount, rate, meta }) {
-      basePricingSheet.calculation.push({
-        category: PaymentPricingRowCategory.Tax,
-        amount,
-        isTaxable: false,
-        isNetPrice: false,
-        rate,
-        meta,
-      });
-    },
-
-    taxSum(filter) {
-      return basePricingSheet.sum({
-        category: PaymentPricingRowCategory.Tax,
-        ...(filter || {}),
-      });
-    },
-
-    discountPrices(explicitDiscountId) {
-      const discountIds = pricingSheet
-        .filterBy({
-          category: PaymentPricingRowCategory.Discount,
-          discountId: explicitDiscountId,
-        })
-        .map(({ discountId }) => discountId)
-        .filter(Boolean) as string[];
-
-      return [...new Set(discountIds)]
-        .map((discountId) => {
-          const amount = basePricingSheet.sum({
-            category: PaymentPricingRowCategory.Discount,
-            discountId,
-          });
-          if (!amount) {
-            return null;
-          }
-          return {
-            discountId,
-            amount: Math.round(amount),
-            currencyCode: basePricingSheet.currencyCode,
-          };
-        })
-        .filter(Boolean) as { discountId: string; amount: number; currencyCode: string }[];
-    },
-  };
-
-  return pricingSheet;
-};

package/src/directors/ProductDiscountAdapter.ts

@@ -1,10 +0,0 @@
-import {
-  BaseDiscountAdapter,
-  IDiscountAdapter,
-  ProductDiscountConfiguration,
-} from '../directors/index.js';
-
-export const ProductDiscountAdapter = BaseDiscountAdapter as Omit<
-  IDiscountAdapter<ProductDiscountConfiguration>,
-  'key' | 'label' | 'version'
->;

package/src/directors/ProductDiscountConfiguration.ts

@@ -1,18 +0,0 @@
-import { Product, ProductConfiguration } from '@unchainedshop/core-products';
-
-type ResolvedConfiguration = {
-  fixedRate?: number;
-  rate?: number;
-  isNetPrice?: boolean;
-  taxRate?: number;
-} & Record<string, any>;
-
-export type PriceConfigurationResolver = (
-  product: Product,
-  quantity: number,
-  configuration: ProductConfiguration[] | null,
-) => ResolvedConfiguration | null;
-
-export interface ProductDiscountConfiguration extends ResolvedConfiguration {
-  customPriceConfigurationResolver?: PriceConfigurationResolver;
-}

package/src/directors/ProductDiscountDirector.ts

@@ -1,4 +0,0 @@
-import { BaseDiscountDirector, ProductDiscountConfiguration } from '../directors/index.js';
-
-export const ProductDiscountDirector =
-  BaseDiscountDirector<ProductDiscountConfiguration>('ProductDiscountDirector');

package/src/directors/ProductPricingAdapter.ts

@@ -1,58 +0,0 @@
-import { Product, ProductConfiguration } from '@unchainedshop/core-products';
-import { Order } from '@unchainedshop/core-orders';
-import {
-  IProductPricingSheet,
-  ProductPricingCalculation,
-  ProductPricingSheet,
-  BasePricingAdapter,
-  BasePricingAdapterContext,
-  IPricingAdapter,
-} from '../directors/index.js';
-import { Modules } from '../modules.js';
-import { User } from '@unchainedshop/core-users';
-
-export interface ProductPricingAdapterContext extends BasePricingAdapterContext {
-  countryCode: string;
-  currencyCode: string;
-  product: Product;
-  quantity: number;
-  configuration: ProductConfiguration[] | null;
-  order?: Order;
-  user?: User;
-}
-
-export type IProductPricingAdapter<DiscountConfiguration = unknown> = IPricingAdapter<
-  ProductPricingAdapterContext & { modules: Modules },
-  ProductPricingCalculation,
-  IProductPricingSheet,
-  DiscountConfiguration
->;
-
-const basePricingAdapter = BasePricingAdapter<ProductPricingAdapterContext, ProductPricingCalculation>();
-
-export const ProductPricingAdapter: IProductPricingAdapter = {
-  ...basePricingAdapter,
-
-  isActivatedFor: () => {
-    return false;
-  },
-
-  actions: (params) => {
-    const { context } = params;
-    const { currencyCode, quantity } = context;
-    const baseActions = basePricingAdapter.actions(params);
-    const resultSheet = ProductPricingSheet({ currencyCode, quantity });
-
-    return {
-      ...baseActions,
-      calculate: async () => {
-        const resultRaw = resultSheet.getRawPricingSheet();
-        resultRaw.forEach(({ amount, category }) =>
-          basePricingAdapter.log(`Product Item Calculation -> ${category} ${amount}`),
-        );
-        return resultRaw;
-      },
-      resultSheet: () => resultSheet,
-    };
-  },
-};

package/src/directors/ProductPricingDirector.ts

@@ -1,100 +0,0 @@
-import { Product, ProductConfiguration } from '@unchainedshop/core-products';
-import { User } from '@unchainedshop/core-users';
-import { Order, OrderDiscount, OrderPosition } from '@unchainedshop/core-orders';
-import {
-  IProductPricingSheet,
-  ProductPricingCalculation,
-  ProductPricingSheet,
-  IProductPricingAdapter,
-  ProductPricingAdapterContext,
-  BasePricingDirector,
-  IPricingDirector,
-} from '../directors/index.js';
-
-export type ProductPricingContext =
-  | {
-      currencyCode: string;
-      countryCode: string;
-      quantity: number;
-      discounts: OrderDiscount[];
-      order?: Order;
-      product: Product;
-      configuration?: ProductConfiguration[];
-      user?: User;
-    }
-  | {
-      currencyCode: string;
-      quantity: number;
-      item: OrderPosition;
-    };
-
-const baseDirector = BasePricingDirector<
-  ProductPricingContext,
-  ProductPricingAdapterContext,
-  ProductPricingCalculation,
-  IProductPricingAdapter
->('ProductPricingDirector');
-
-export type IProductPricingDirector<DiscountConfiguration = unknown> = IPricingDirector<
-  ProductPricingContext,
-  ProductPricingCalculation,
-  ProductPricingAdapterContext,
-  IProductPricingSheet,
-  IProductPricingAdapter<DiscountConfiguration>
->;
-
-export const ProductPricingDirector: IProductPricingDirector<any> = {
-  ...baseDirector,
-
-  async buildPricingContext(context, unchainedAPI) {
-    const { modules } = unchainedAPI;
-    const { quantity = 1, currencyCode } = context;
-
-    if ('item' in context) {
-      const { item } = context;
-
-      const product = await modules.products.findProduct({
-        productId: item.productId,
-      });
-      const order = await modules.orders.findOrder({
-        orderId: item.orderId,
-      });
-      const user = await modules.users.findUserById(order!.userId);
-      const discounts = await modules.orders.discounts.findOrderDiscounts({
-        orderId: item.orderId,
-      });
-
-      return {
-        ...unchainedAPI,
-        countryCode: order!.countryCode,
-        currencyCode,
-        discounts,
-        order: order!,
-        product: product!,
-        quantity,
-        configuration: item.configuration ?? null,
-        user: user!,
-      };
-    }
-
-    return {
-      ...unchainedAPI,
-      countryCode: context.countryCode,
-      currencyCode,
-      discounts: [],
-      order: context.order,
-      product: context.product,
-      quantity,
-      configuration: context.configuration ?? null,
-      user: context.user,
-    };
-  },
-
-  calculationSheet(pricingContext, calculation) {
-    return ProductPricingSheet({
-      calculation,
-      currencyCode: pricingContext.currencyCode,
-      quantity: pricingContext.quantity ?? 1,
-    });
-  },
-};

package/src/directors/ProductPricingSheet.test.ts

@@ -1,140 +0,0 @@
-import { beforeEach, describe, it } from 'node:test';
-import assert from 'node:assert';
-import { ProductPricingSheet } from './ProductPricingSheet.js';
-
-const TAX = { category: 'TAX', amount: 50, isNetPrice: false, isTaxable: false };
-const TAX2 = { category: 'TAX', amount: 25, isNetPrice: false, isTaxable: false };
-const DISCOUNT = {
-  category: 'DISCOUNT',
-  amount: 20,
-  isNetPrice: false,
-  isTaxable: false,
-  discountId: 'for-all',
-};
-const DISCOUNT2 = {
-  category: 'DISCOUNT',
-  amount: 20,
-  isNetPrice: false,
-  isTaxable: false,
-  discountId: 'for-all',
-};
-const DISCOUNT3 = {
-  category: 'DISCOUNT',
-  amount: 20,
-  isNetPrice: false,
-  isTaxable: false,
-  discountId: 'special',
-};
-const ITEM1 = { category: 'ITEM', amount: 200, isNetPrice: true, isTaxable: false };
-const ITEM2 = { category: 'ITEM', amount: 200, isNetPrice: true, isTaxable: false };
-const calculations = [TAX, TAX2, DISCOUNT, DISCOUNT2, DISCOUNT3, ITEM1, ITEM2];
-
-describe('ProductPricingSheet', () => {
-  let pricingSheet;
-
-  const pricingSheetParams = {
-    calculation: calculations,
-    currencyCode: 'CHF',
-    quantity: 2,
-  };
-  beforeEach(() => {
-    pricingSheet = ProductPricingSheet(pricingSheetParams);
-  });
-
-  it('should return an object that implements the IProductPricingSheet interface', () => {
-    assert(pricingSheet);
-    assert.equal(pricingSheet.quantity, 2);
-    assert.equal(pricingSheet.currencyCode, 'CHF');
-    assert.equal(typeof pricingSheet.addItem, 'function');
-    assert.equal(typeof pricingSheet.addDiscount, 'function');
-    assert.equal(typeof pricingSheet.addTax, 'function');
-    assert.equal(typeof pricingSheet.taxSum, 'function');
-    assert.equal(typeof pricingSheet.unitPrice, 'function');
-    assert.equal(typeof pricingSheet.discountPrices, 'function');
-  });
-
-  it('gross() should return the GROSS sum of all ProductPricingCalculation', () => {
-    assert.equal(pricingSheet.gross(), 535);
-  });
-
-  it('net() should return the NET sum of all ProductPricingCalculation (i.e before TAX)', () => {
-    assert.equal(pricingSheet.net(), 460);
-  });
-
-  describe('total()', () => {
-    it('should return sum of all ProductPricingCalculations ', () => {
-      assert.deepEqual(pricingSheet.total(), { amount: 535, currencyCode: 'CHF' });
-      assert.deepEqual(pricingSheet.total(), { amount: pricingSheet.gross(), currencyCode: 'CHF' });
-    });
-
-    it('should return sum of all ProductPricingCalculations ', () => {
-      assert.deepEqual(pricingSheet.total({ useNetPrice: true }), { amount: 460, currencyCode: 'CHF' });
-      assert.deepEqual(pricingSheet.total({ useNetPrice: true }), {
-        amount: pricingSheet.net(),
-        currencyCode: 'CHF',
-      });
-    });
-
-    it('should return sum of all ProductPricingCalculations for the provided category ', () => {
-      assert.deepEqual(pricingSheet.total({ category: 'ITEM' }), { amount: 400, currencyCode: 'CHF' });
-      assert.deepEqual(pricingSheet.total({ category: 'DISCOUNT' }), {
-        amount: 60,
-        currencyCode: 'CHF',
-      });
-      assert.deepEqual(pricingSheet.total({ category: 'TAX' }), { amount: 75, currencyCode: 'CHF' });
-    });
-  });
-
-  describe('isValid()', () => {
-    it('should return true if there is at least 1 registered ProductPricingCalculation ', () => {
-      assert.equal(pricingSheet.isValid(), true);
-    });
-    it('should return false if there is no registered ProductPricingCalculation ', () => {
-      const sheet = ProductPricingSheet({ ...pricingSheetParams, calculation: [] });
-      assert.equal(sheet.isValid(), false);
-    });
-  });
-
-  describe('getRawPricingSheet', () => {
-    it('should return all registered ProductPricingCalculation', () => {
-      assert.deepEqual(pricingSheet.getRawPricingSheet(), calculations);
-    });
-  });
-
-  describe('taxSum', () => {
-    it('should return the sum of TAX calculation registered on the adapter', () => {
-      assert.equal(pricingSheet.taxSum(), 75);
-    });
-  });
-
-  describe('unitPrice', () => {
-    it('should return the GROSS sum for a  product price useNetPrice:false', () => {
-      assert.deepEqual(pricingSheet.unitPrice({ useNetPrice: false }), {
-        amount: 268,
-        currencyCode: 'CHF',
-      });
-    });
-
-    it('should return the NET sum for a product price when useNetPrice:true', () => {
-      assert.deepEqual(pricingSheet.unitPrice({ useNetPrice: true }), {
-        amount: 230,
-        currencyCode: 'CHF',
-      });
-    });
-  });
-
-  describe('discountPrices', () => {
-    it('should return the sum of all discounts registered on the price sheet based on discountId', () => {
-      assert.deepEqual(pricingSheet.discountPrices('for-all'), [
-        { amount: 40, currencyCode: 'CHF', discountId: 'for-all' },
-      ]);
-      assert.deepEqual(pricingSheet.discountPrices('special'), [
-        { amount: 20, currencyCode: 'CHF', discountId: 'special' },
-      ]);
-    });
-
-    it('should return empty array if discount with the provided discountId is not found', () => {
-      assert.deepEqual(pricingSheet.discountPrices('non-existing'), []);
-    });
-  });
-});