@unchainedshop/plugins 2.0.0-rc.4 → 2.0.1

package/src/pricing/order-discount.test.ts

@@ -0,0 +1,206 @@
+import { applyDiscountToMultipleShares, calculateAmountToSplit, resolveAmountAndTax, resolveRatioAndTaxDivisorForPricingSheet } from "./order-discount.js";
+
+
+
+describe("OrderDiscount helpers ", () => {
+describe("resolveRatioAndTaxDivisorForPricingSheet", () => {
+  it('total is 0 and pricing is not provided', () => {
+    const result = resolveRatioAndTaxDivisorForPricingSheet(null, 0);
+    expect(result).toEqual({ ratio: 1, taxDivisor: 1 });
+  });
+  it('total is not 0 and pricing is not provided', () => {
+    const result = resolveRatioAndTaxDivisorForPricingSheet(null, 10);
+    expect(result).toEqual({ ratio: 1, taxDivisor: 1 });
+  });
+  it('total is 0 and pricing is provided', () => {
+    const pricing = {
+      taxSum: () => 10,
+      gross: () => 20,
+    };
+    const result = resolveRatioAndTaxDivisorForPricingSheet(pricing, 0);
+    expect(result).toEqual({ ratio: 1, taxDivisor: 1 });
+  });
+
+  it('gross - tax is 0', () => {
+    const pricing = {
+      taxSum: () => 10,
+      gross: () => 10,
+    };
+    const result = resolveRatioAndTaxDivisorForPricingSheet(pricing, 20);
+    expect(result).toEqual({ ratio: 0, taxDivisor: 0 });
+  });
+
+  it('gross - tax is not 0', () => {
+    const pricing = {
+      taxSum: () => 10,
+      gross: () => 20,
+    };
+    const result = resolveRatioAndTaxDivisorForPricingSheet(pricing, 20);
+    expect(result).toEqual({ ratio: 1, taxDivisor: 2 });
+  });
+
+  it('taxSum is 0', () => {
+    const pricing = {
+      taxSum: () => 0,
+      gross: () => 20,
+    };
+    const result = resolveRatioAndTaxDivisorForPricingSheet(pricing, 20);
+    expect(result).toEqual({ ratio: 1, taxDivisor: 1 });
+  });
+
+})
+
+
+
+describe("resolveAmountAndTax", () => {
+
+  it('ratio is 0 and taxDivisor is 0', () => {
+    const result = resolveAmountAndTax({ ratio: 0, taxDivisor: 0 }, 100);
+    expect(result).toEqual([0, 0]);
+  });
+
+  it('ratio is not 0 and taxDivisor is 0', () => {
+    const result = resolveAmountAndTax({ ratio: 0.5, taxDivisor: 0 }, 100);
+    expect(result).toEqual([50, 0]);
+  });
+
+  it('ratio is 0 and taxDivisor is not 0', () => {
+    const result = resolveAmountAndTax({ ratio: 0, taxDivisor: 2 }, 100);
+    expect(result).toEqual([0, 0]);
+  });
+
+
+  it('ratio and taxDivisor are not 0', () => {
+    const result = resolveAmountAndTax({ ratio: 0.5, taxDivisor: 2 }, 100);
+    expect(result).toEqual([50, 25]);
+  });
+
+  it('ratio and taxDivisor are not finite number', () => {
+    const result = resolveAmountAndTax({ ratio: Number.NaN, taxDivisor: Number.NaN }, 100);
+    expect(result).toEqual([0, 0]);
+  });
+
+
+
+})
+
+describe("resolveAmountAndTax", () => {
+  it('shares are empty', () => {
+    const result = applyDiscountToMultipleShares([], 100);
+    expect(result).toEqual([0, 0]);
+  });
+
+  it('shares have one share', () => {
+    const shares = [{ ratio: 0.5, taxDivisor: 2 }];
+    const result = applyDiscountToMultipleShares(shares, 100);
+    expect(result).toEqual([50, 25]);
+  });
+
+  it('shares have multiple shares', () => {
+    const shares = [
+      { ratio: 0.5, taxDivisor: 2 },
+      { ratio: 0.2, taxDivisor: 1.5 },
+    ];
+    const result = applyDiscountToMultipleShares(shares, 100);
+    expect(result).toEqual([70, 31.666666666666664]);
+  });
+
+})
+
+describe('calculateAmountToSplit', () => {
+  it('calculates the correct amount to split when using a rate', () => {
+    const configuration = {
+      rate: 0.1,
+      alreadyDeductedForDiscount: 0,
+      amountLeft: 100,
+    };
+    const amount = 1000;
+    expect(calculateAmountToSplit(configuration, amount)).toBe(100);
+  });
+
+  it('calculates the correct amount to split when using a fixed rate', () => {
+    const configuration = {
+      fixedRate: 50,
+      alreadyDeductedForDiscount: 0,
+      amountLeft: 100,
+    };
+    const amount = 1000;
+    expect(calculateAmountToSplit(configuration, amount)).toBe(50);
+  });
+
+  it('calculates the correct amount to split when alreadyDeductedForDiscount is non-zero', () => {
+    const configuration = {
+      rate: 0.1,
+      alreadyDeductedForDiscount: 10,
+      amountLeft: 100,
+    };
+    const amount = 1000;
+    expect(calculateAmountToSplit(configuration, amount)).toBe(90);
+  });
+
+
+  it('calculates the correct amount to split when amountLeft is less than the amount to deduct', () => {
+    const configuration = {
+      rate: 0.1,
+      alreadyDeductedForDiscount: 0,
+      amountLeft: 50,
+    };
+    const amount = 1000;
+    expect(calculateAmountToSplit(configuration, amount)).toBe(50);
+  });
+
+  it('returns 0 when the amount to deduct is less than or equal to alreadyDeductedForDiscount', () => {
+    const configuration = {
+      rate: 0.1,
+      alreadyDeductedForDiscount: 100,
+      amountLeft: 100,
+    };
+    const amount = 1000;
+    expect(calculateAmountToSplit(configuration, amount)).toBe(0);
+  });
+
+  it('returns 0 when the amount is less than or equal to 0', () => {
+    const configuration = {
+      rate: 0.1,
+      alreadyDeductedForDiscount: 0,
+      amountLeft: 100,
+    };
+    const amount = 0;
+    expect(calculateAmountToSplit(configuration, amount)).toBe(0);
+  });
+
+  it('returns 0 when amountLeft is 0', () => {
+    const configuration = {
+      rate: 0.1,
+      alreadyDeductedForDiscount: 0,
+      amountLeft: 0,
+    };
+    const amount = 1000;
+    expect(calculateAmountToSplit(configuration, amount)).toBe(0);
+  });
+
+  it('returns 0 when amount is negative', () => {
+    const configuration = {
+      rate: 0.1,
+      alreadyDeductedForDiscount: 0,
+      amountLeft: 100,
+    };
+    const amount = -1000;
+    expect(calculateAmountToSplit(configuration, amount)).toBe(0);
+  });
+
+  it('returns 0 when configuration rate is negative', () => {
+    const configuration = {
+      rate: -0.1,
+      alreadyDeductedForDiscount: 0,
+      amountLeft: 100,
+    };
+    const amount = 1000;
+    expect(calculateAmountToSplit(configuration, amount)).toBe(0);
+  });
+
+
+});
+
+
+})

package/src/pricing/order-discount.ts

@@ -1,7 +1,7 @@
 import { IOrderPricingAdapter, OrderPricingRowCategory } from '@unchainedshop/types/orders.pricing.js';
 import { OrderPricingDirector, OrderPricingAdapter } from '@unchainedshop/core-orders';
 
-const resolveRatioAndTaxDivisorForPricingSheet = (pricing, total) => {
+export const resolveRatioAndTaxDivisorForPricingSheet = (pricing, total) => {
   if (total === 0 || !pricing) {
     return {
       ratio: 1,
@@ -22,14 +22,16 @@ const resolveRatioAndTaxDivisorForPricingSheet = (pricing, total) => {
   };
 };
 
-const resolveAmountAndTax = ({ ratio, taxDivisor }, amount) => {
+export const resolveAmountAndTax = ({ ratio, taxDivisor }, amount) => {
   const shareAmount = Number.isFinite(ratio) ? amount * ratio : 0;
   const shareTaxAmount =
     Number.isFinite(taxDivisor) && taxDivisor !== 0 ? shareAmount - shareAmount / taxDivisor : 0;
   return [shareAmount, shareTaxAmount];
 };
 
-const applyDiscountToMultipleShares = (shares, amount) => {
+// TODO: move to separate file because its used in multiple places
+
+export const applyDiscountToMultipleShares = (shares, amount) => {
   return shares.reduce(
     ([currentDiscountAmount, currentTaxAmount], share) => {
       const [shareAmount, shareTaxAmount] = resolveAmountAndTax(share, amount);
@@ -39,7 +41,7 @@ const applyDiscountToMultipleShares = (shares, amount) => {
   );
 };
 
-const calculateAmountToSplit = (configuration, amount) => {
+export const calculateAmountToSplit = (configuration, amount) => {
   const deductionAmount = configuration.rate ? amount * configuration.rate : configuration.fixedRate;
 
   const leftInDiscount = Math.max(0, deductionAmount - (configuration.alreadyDeductedForDiscount || 0));

package/src/pricing/order-items-discount.ts

@@ -1,6 +1,6 @@
 import { IOrderPricingAdapter, OrderPricingRowCategory } from '@unchainedshop/types/orders.pricing.js';
 import { OrderPricingDirector, OrderPricingAdapter } from '@unchainedshop/core-orders';
-
+// TODO: move into separate file and share multiple places
 const resolveRatioAndTaxDivisorForPricingSheet = (pricing, total) => {
   if (total === 0 || !pricing) {
     return {
@@ -16,12 +16,14 @@ const resolveRatioAndTaxDivisorForPricingSheet = (pricing, total) => {
   };
 };
 
+// TODO: move into separate file and share multiple places
 const resolveAmountAndTax = ({ ratio, taxDivisor }, amount) => {
   const shareAmount = Number.isFinite(ratio) ? amount * ratio : 0;
   const shareTaxAmount = Number.isFinite(taxDivisor) ? shareAmount - shareAmount / taxDivisor : 0;
   return [shareAmount, shareTaxAmount];
 };
 
+// TODO: move into separate file and share multiple places
 const applyDiscountToMultipleShares = (shares, amount) => {
   return shares.reduce(
     ([currentDiscountAmount, currentTaxAmount], share) => {
@@ -32,6 +34,7 @@ const applyDiscountToMultipleShares = (shares, amount) => {
   );
 };
 
+// TODO: move into separate file and share multiple places
 const calculateAmountToSplit = (configuration, amount) => {
   const deductionAmount = configuration.rate
     ? amount * configuration.rate

package/src/pricing/product-catalog-price.ts

@@ -1,7 +1,7 @@
 import { IProductPricingAdapter } from '@unchainedshop/types/products.pricing.js';
 import { ProductPricingDirector, ProductPricingAdapter } from '@unchainedshop/core-products';
 
-const ProductPrice: IProductPricingAdapter = {
+export const ProductPrice: IProductPricingAdapter = {
   ...ProductPricingAdapter,
 
   key: 'shop.unchained.pricing.product-price',

package/src/pricing/product-discount.ts

@@ -5,9 +5,9 @@ import {
 } from '@unchainedshop/types/products.pricing.js';
 import { ProductPricingDirector, ProductPricingAdapter } from '@unchainedshop/core-products';
 
-const applyRate = (configuration: DiscountConfiguration, amount) => {
+export const applyRate = (configuration: DiscountConfiguration, amount) => {
   const { rate, fixedRate } = configuration;
-  return rate ? amount * rate : Math.min(fixedRate, amount);
+  return rate ? amount * rate : Math.min(fixedRate || 0, amount);
 };
 const ProductDiscount: IProductPricingAdapter = {
   ...ProductPricingAdapter,

package/src/pricing/product-price-rateconversion.ts

@@ -1,7 +1,7 @@
 import { IProductPricingAdapter } from '@unchainedshop/types/products.pricing.js';
 import { ProductPricingDirector, ProductPricingAdapter } from '@unchainedshop/core-products';
 
-const ProductPriceRateConversion: IProductPricingAdapter = {
+export const ProductPriceRateConversion: IProductPricingAdapter = {
   ...ProductPricingAdapter,
 
   key: 'shop.unchained.pricing.rate-conversion',

package/src/pricing/product-price-round.ts

@@ -1,8 +1,8 @@
 import { IProductPricingAdapter } from '@unchainedshop/types/products.pricing.js';
-import { ProductPricingDirector, ProductPricingAdapter } from '@unchainedshop/core-products';
-
-const roundToNext = (value, precision) => Math.ceil(value / precision) * precision;
+import { ProductPricingAdapter, ProductPricingDirector } from '@unchainedshop/core-products';
 
+export const roundToNext = (value, precision) => Math.ceil(value / precision) * precision;
+// TODO: Move to types
 // String is referencing to a currency
 interface PriceRoundSettings {
   configurations: Record<string, number>;
@@ -10,7 +10,7 @@ interface PriceRoundSettings {
   skip: Array<string>;
 }
 
-const ProductPriceRoundSettings: PriceRoundSettings = {
+export const ProductPriceRoundSettings: PriceRoundSettings = {
   configurations: {},
   defaultPrecision: 50,
   skip: [],

package/src/pricing/product-swiss-tax.test.ts

@@ -0,0 +1,141 @@
+import { getTaxRate, isDeliveryAddressInSwitzerland,  SwissTaxCategories } from './product-swiss-tax.js';
+
+describe("ProductSwissTax", () => {
+describe('SwissTaxCategories', () => {
+  it('DEFAULT rate', () => {
+    expect(SwissTaxCategories.DEFAULT.rate()).toBe(0.077);
+  });
+
+  it('REDUCED rate', () => {
+    expect(SwissTaxCategories.REDUCED.rate()).toBe(0.025);
+  });
+
+  it('SPECIAL rate', () => {
+    expect(SwissTaxCategories.SPECIAL.rate()).toBe(0.037);
+  });
+});
+
+describe('getTaxRate', () => {
+  it('default rate', () => {
+    const context: any = {
+      product: {
+        tags: []
+      },
+      provider: {
+        configuration: [],
+      },
+    };
+    expect(getTaxRate(context)).toBe(0.077);
+  });
+
+  it('reduced rate', () => {
+    const context: any = {
+      product: {
+        tags: ['swiss-tax-category:reduced']
+      },
+      provider: {
+        configuration: [
+          {
+            key: 'swiss-tax-category',
+            value: SwissTaxCategories.REDUCED.rate(),
+          },
+        ],
+      },
+    };
+    expect(getTaxRate(context)).toBe(0.025);
+  });
+
+  it('special rate', () => {
+    const context: any = {
+      product: {
+        tags: ['swiss-tax-category:special']
+      },
+      provider: {
+        configuration: [
+          {
+            key: 'swiss-tax-category',
+            value: SwissTaxCategories.SPECIAL.rate(),
+          },
+        ],
+      },
+    };
+    expect(getTaxRate(context)).toBe(0.037);
+  });
+
+  it('default rate', () => {
+    const context: any = {
+      product: {
+        tags: ['swiss-tax-category:default']
+      },
+      provider: {
+        configuration: [
+          {
+            key: 'swiss-tax-category',
+            value: SwissTaxCategories.DEFAULT.rate(),
+          },
+        ],
+      },
+    };
+    expect(getTaxRate(context)).toBe(0.077);
+  });
+
+})
+
+describe('isDeliveryAddressInSwitzerland', () => {
+  const context =  {
+    modules:  {
+      orders: {
+        deliveries: {
+          findDelivery: import.meta.jest.fn(async({orderDeliveryId}) =>{ 
+            if(orderDeliveryId === 'CH' || orderDeliveryId === 'LI' )
+           return {context: { address: { countryCode: 'CH'}}}
+           if(orderDeliveryId === null)
+           return {context: { address: null}}
+           return {context: { address: {countryCode: 'RT'}}}
+          })
+        }
+      }
+    },
+    order : {
+      deliveryId: 'CH',
+      billingAddress: {countryCode: 'LI'}
+    },
+    country: 'CH'
+  }
+  it('Should return true when passed country code CH', async () => {
+    expect(await isDeliveryAddressInSwitzerland({...context, country: 'ch', order: null})).toBe(true);
+  });
+
+  it('Should return true when passed country code LI', async () => {
+    expect(await isDeliveryAddressInSwitzerland({...context, country: 'LI', order: null})).toBe(true);
+  });
+
+  it('Should return false when country is neither CH nor LI and order is null', async () => {
+    expect(await isDeliveryAddressInSwitzerland({...context, country: 'ET', order: null})).toBe(false);
+  });
+
+  it('Order should take precedence over country parameter', async () => {
+    // not CH or LI order so returns false
+    expect(await isDeliveryAddressInSwitzerland({...context, country: 'CH', order : {
+      deliveryId: 'ET',
+      billingAddress: {countryCode: 'ET'}
+    }})).toBe(false);
+  });
+
+  it('If order is not from CH and LI but billingAddress is, it should take precedence over country ', async () => {
+    expect(await isDeliveryAddressInSwitzerland({...context, country: 'IT', order : {
+      deliveryId: null,
+      billingAddress: { countryCode: 'CH'}
+    }})).toBe(true);
+  });
+
+  it('Should return false if billingAddress is neither CH or LI and order does not have address', async () => {
+    expect(await isDeliveryAddressInSwitzerland({...context, country: null, order : {
+      deliveryId: null,
+      billingAddress: {countryCode: 'HH'}
+    }})).toBe(false);
+  });
+});
+
+
+})

package/src/pricing/product-swiss-tax.ts

@@ -24,7 +24,7 @@ export const SwissTaxCategories = {
   },
 };
 
-const getTaxRate = (context: ProductPricingAdapterContext) => {
+export const getTaxRate = (context: ProductPricingAdapterContext) => {
   const { product } = context;
 
   if (product.tags?.includes(SwissTaxCategories.REDUCED.tag)) {
@@ -36,7 +36,7 @@ const getTaxRate = (context: ProductPricingAdapterContext) => {
   return SwissTaxCategories.DEFAULT.rate();
 };
 
-const isDeliveryAddressInSwitzerland = async ({ order, country, modules }) => {
+export const isDeliveryAddressInSwitzerland = async ({ order, country, modules }) => {
   let countryCode = country?.toUpperCase().trim();
 
   if (order) {
@@ -53,7 +53,7 @@ const isDeliveryAddressInSwitzerland = async ({ order, country, modules }) => {
   return countryCode === 'CH' || countryCode === 'LI';
 };
 
-const ProductSwissTax: IProductPricingAdapter = {
+export const ProductSwissTax: IProductPricingAdapter = {
   ...ProductPricingAdapter,
 
   key: 'shop.unchained.pricing.product-swiss-tax',

package/src/pricing/roundToNext.test.ts

@@ -0,0 +1,24 @@
+import { roundToNext } from "./product-price-round.js";
+
+describe('roundToNext', () => {
+  it('rounds to the next multiple of precision correctly when the value is positive', () => {
+    expect(roundToNext(5, 2)).toBe(6);
+    expect(roundToNext(10, 5)).toBe(10);
+    expect(roundToNext(13, 5)).toBe(15);
+  });
+
+  it('rounds to the next multiple of precision correctly when the value is negative', () => {
+    expect(roundToNext(-5, 2)).toBe(-4);
+    expect(roundToNext(-10, 5)).toBe(-10);
+    expect(roundToNext(-13, 5)).toBe(-10);
+  });
+
+  it('returns 0 when the value is 0', () => {
+    expect(roundToNext(0, 5)).toBe(0);
+  });
+
+  it('returns the same value when the precision is 1', () => {
+    expect(roundToNext(5, 1)).toBe(5);
+  });
+
+});

package/src/worker/email.ts

@@ -9,7 +9,7 @@ import nodemailer from 'nodemailer';
 
 const logger = createLogger('unchained:plugins:worker:email');
 
-const checkEmailInterceptionEnabled = () => {
+export const checkEmailInterceptionEnabled = () => {
   return process.env.NODE_ENV !== 'production' && !process.env.UNCHAINED_DISABLE_EMAIL_INTERCEPTION;
 };
 

package/src/worker/push-notification.ts

@@ -0,0 +1,106 @@
+import { WorkerDirector, WorkerAdapter } from '@unchainedshop/core-worker';
+import { createLogger } from '@unchainedshop/logger';
+import { IWorkerAdapter } from '@unchainedshop/types/worker.js';
+import webPush from 'web-push';
+
+const { PUSH_NOTIFICATION_PUBLIC_KEY, PUSH_NOTIFICATION_PRIVATE_KEY } = process.env;
+
+const logger = createLogger('unchained:plugins:worker:push-notification');
+
+type NotificationOptions = {
+  vapidDetails: {
+    subject: string;
+    publicKey: string;
+    privateKey: string;
+  };
+  TTL: number;
+  urgency?: 'very-low' | 'low' | 'normal' | 'high';
+  topic?: string;
+};
+
+const PushNotificationWorkerPlugin: IWorkerAdapter<
+  {
+    subscription: any;
+    payload: string;
+    subject: string;
+    urgency?: 'very-low' | 'low' | 'normal' | 'high';
+    topic?: string;
+  },
+  any
+> = {
+  ...WorkerAdapter,
+
+  key: 'shop.unchained.worker-plugin.push-notification',
+  label: 'Push Notification',
+
+  version: '1.0',
+
+  type: 'PUSH',
+
+  doWork: async ({ subscription, subject, payload, urgency = null, topic = null }) => {
+    logger.debug(`${PushNotificationWorkerPlugin.key} -> doWork: Push -> ${subject}`);
+    if (!PUSH_NOTIFICATION_PUBLIC_KEY)
+      return {
+        success: false,
+        error: {
+          name: 'VAPID_PUBLIC_KEY_REQUIRED',
+          message: 'vapidPublicKey key required to send push notifications',
+        },
+      };
+    if (!PUSH_NOTIFICATION_PRIVATE_KEY)
+      return {
+        success: false,
+        error: {
+          name: 'VAPID_PRIVATE_KEY_REQUIRED',
+          message: 'vapidPrivateKey key are required to send push notifications',
+        },
+      };
+
+    if (!subscription) {
+      return {
+        success: false,
+        error: {
+          name: 'USER_SUBSCRIPTION_OBJECT_REQUIRED',
+          message: 'PUSH service subscription required',
+        },
+      };
+    }
+
+    const options: NotificationOptions = {
+      vapidDetails: {
+        subject,
+        publicKey: PUSH_NOTIFICATION_PUBLIC_KEY,
+        privateKey: PUSH_NOTIFICATION_PRIVATE_KEY,
+      },
+      TTL: 60,
+    };
+
+    if (urgency) {
+      options.urgency = urgency;
+    }
+
+    if (topic) {
+      options.topic = topic;
+    }
+
+    try {
+      await webPush.sendNotification(subscription, payload, options);
+
+      return {
+        success: true,
+        error: null,
+      };
+    } catch (err) {
+      return {
+        success: false,
+        error: {
+          name: err.name,
+          message: err.message,
+          stack: err.stack,
+        },
+      };
+    }
+  },
+};
+
+WorkerDirector.registerAdapter(PushNotificationWorkerPlugin);

package/tsconfig.json

@@ -1,35 +1,16 @@
 {
+  "extends": "../shared/base.tsconfig.json",
   "compilerOptions": {
-    "allowJs": true,
-    "allowSyntheticDefaultImports": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
     "rootDir": "src",
-    "lib": [
-      "esnext"
-    ],
-    "module": "Node16",
-    "moduleResolution": "Node16",
-    "noImplicitReturns": true,
-    "noUnusedLocals": false,
     "outDir": "lib",
-    "preserveWatchOutput": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "target": "ES2022",
-    "types": [
-      "node",
-      "jest"
-    ],
     "paths": {
       "postfinancecheckout": [
         "./src/payment/postfinance-checkout/silence-postfinancecheckout.d.ts"
       ],
     }
   },
+  "exclude": ["**/*.test.ts", "**/*.test.js", "tests"],
   "include": [
-    "src"
+    "./src"
   ]
 }

package/lib/pricing/utils/cache.d.ts

@@ -1,9 +0,0 @@
-import 'abort-controller/polyfill.js';
-declare class Cache {
-    cache: any;
-    constructor(ttlSeconds?: number);
-    get(key: any, currentFuntion: any): any;
-    del(keys: any): void;
-    flushAll(): void;
-}
-export default Cache;