@unchainedshop/plugins 5.0.0-alpha.1 → 5.0.0-alpha.3

package/lib/pricing/product-uk-tax/index.d.ts

@@ -0,0 +1,4 @@
+import { type IPlugin } from '@unchainedshop/core';
+export declare const ProductUkTaxPlugin: IPlugin;
+export default ProductUkTaxPlugin;
+export { ProductUkTax } from './adapter.ts';

package/lib/pricing/product-uk-tax/index.js

@@ -0,0 +1,10 @@
+import {} from '@unchainedshop/core';
+import { ProductUkTax } from "./adapter.js";
+export const ProductUkTaxPlugin = {
+    key: 'shop.unchained.pricing.product-uk-tax',
+    label: 'Product UK Tax Plugin',
+    version: '1.0.0',
+    adapters: [ProductUkTax],
+};
+export default ProductUkTaxPlugin;
+export { ProductUkTax } from "./adapter.js";

package/lib/pricing/product-uk-tax.d.ts

@@ -0,0 +1,2 @@
+import { type IProductPricingAdapter } from '@unchainedshop/core';
+export declare const ProductUkTax: IProductPricingAdapter;

package/lib/pricing/product-uk-tax.js

@@ -0,0 +1,57 @@
+import { ProductPricingDirector, ProductPricingAdapter, ProductPricingRowCategory, } from '@unchainedshop/core';
+import { resolveUkTaxCategoryFromDeliveryProvider, resolveUkTaxCategoryFromProduct, UkTaxCategories, UK_VAT_COUNTRY_CODES, } from "./tax/uk.js";
+import isDeliveryAddressInCountry from "./utils/isDeliveryAddressInCountry.js";
+import { applyTaxRateToTaxableRows } from "./tax/applyTaxRateToTaxableRows.js";
+export const ProductUkTax = {
+    ...ProductPricingAdapter,
+    key: 'shop.unchained.pricing.product-uk-tax',
+    version: '1.0.0',
+    label: 'Apply UK VAT on Product',
+    orderIndex: 80,
+    isActivatedFor: () => {
+        return true;
+    },
+    actions: (params) => {
+        const pricingAdapter = ProductPricingAdapter.actions(params);
+        const { context } = params;
+        return {
+            ...pricingAdapter,
+            calculate: async () => {
+                const orderDelivery = context.order?.deliveryId
+                    ? await context.modules.orders.deliveries.findDelivery({
+                        orderDeliveryId: context.order?.deliveryId,
+                    })
+                    : null;
+                if (!isDeliveryAddressInCountry({
+                    ...context,
+                    orderDelivery,
+                }, UK_VAT_COUNTRY_CODES)) {
+                    return pricingAdapter.calculate();
+                }
+                let taxCategory = resolveUkTaxCategoryFromProduct(context.product);
+                if (!taxCategory) {
+                    const provider = orderDelivery?.deliveryProviderId
+                        ? await context.modules.delivery.findProvider({
+                            deliveryProviderId: orderDelivery?.deliveryProviderId,
+                        })
+                        : null;
+                    if (provider)
+                        taxCategory = resolveUkTaxCategoryFromDeliveryProvider(provider);
+                }
+                if (!taxCategory)
+                    taxCategory = UkTaxCategories.STANDARD;
+                const taxRate = taxCategory.rate(context.order?.ordered);
+                ProductPricingAdapter.log(`ProductUkTax -> Tax Multiplicator: ${taxRate}`);
+                applyTaxRateToTaxableRows({
+                    calculationSheet: params.calculationSheet,
+                    resultSheet: pricingAdapter.resultSheet(),
+                    taxRate,
+                    baseCategory: ProductPricingRowCategory.Item,
+                    adapterKey: ProductUkTax.key,
+                });
+                return pricingAdapter.calculate();
+            },
+        };
+    },
+};
+ProductPricingDirector.registerAdapter(ProductUkTax);

package/lib/pricing/product-us-sales-tax/adapter.d.ts

@@ -0,0 +1,3 @@
+import { type IProductPricingAdapter } from '@unchainedshop/core';
+export declare const ProductUsSalesTax: IProductPricingAdapter;
+export default ProductUsSalesTax;

package/lib/pricing/product-us-sales-tax/adapter.js

@@ -0,0 +1,52 @@
+import { ProductPricingAdapter, ProductPricingRowCategory, } from '@unchainedshop/core';
+import { US_COUNTRY_CODE, isProductExemptFromUsSalesTax, resolveUsSalesTaxRate } from "../tax/us.js";
+import resolveDeliveryLocation from "../utils/resolveDeliveryLocation.js";
+import { applyTaxRateToTaxableRows } from "../tax/applyTaxRateToTaxableRows.js";
+export const ProductUsSalesTax = {
+    ...ProductPricingAdapter,
+    key: 'shop.unchained.pricing.product-us-sales-tax',
+    version: '1.0.0',
+    label: 'Apply US State Sales Tax on Product',
+    orderIndex: 80,
+    isActivatedFor: () => {
+        return true;
+    },
+    actions: (params) => {
+        const pricingAdapter = ProductPricingAdapter.actions(params);
+        const { context } = params;
+        return {
+            ...pricingAdapter,
+            calculate: async () => {
+                if (isProductExemptFromUsSalesTax(context.product)) {
+                    return pricingAdapter.calculate();
+                }
+                const orderDelivery = context.order?.deliveryId
+                    ? await context.modules.orders.deliveries.findDelivery({
+                        orderDeliveryId: context.order?.deliveryId,
+                    })
+                    : null;
+                const { countryCode, regionCode } = resolveDeliveryLocation({ ...context, orderDelivery });
+                if (countryCode !== US_COUNTRY_CODE)
+                    return pricingAdapter.calculate();
+                const taxRate = resolveUsSalesTaxRate({
+                    regionCode,
+                    referenceDate: context.order?.ordered,
+                });
+                if (taxRate === null) {
+                    ProductPricingAdapter.log(`ProductUsSalesTax -> unknown state '${regionCode}', no sales tax applied`);
+                    return pricingAdapter.calculate();
+                }
+                ProductPricingAdapter.log(`ProductUsSalesTax -> Tax Multiplicator: ${taxRate}`);
+                applyTaxRateToTaxableRows({
+                    calculationSheet: params.calculationSheet,
+                    resultSheet: pricingAdapter.resultSheet(),
+                    taxRate,
+                    baseCategory: ProductPricingRowCategory.Item,
+                    adapterKey: ProductUsSalesTax.key,
+                });
+                return pricingAdapter.calculate();
+            },
+        };
+    },
+};
+export default ProductUsSalesTax;

package/lib/pricing/product-us-sales-tax/index.d.ts

@@ -0,0 +1,4 @@
+import { type IPlugin } from '@unchainedshop/core';
+export declare const ProductUsSalesTaxPlugin: IPlugin;
+export default ProductUsSalesTaxPlugin;
+export { ProductUsSalesTax } from './adapter.ts';

package/lib/pricing/product-us-sales-tax/index.js

@@ -0,0 +1,10 @@
+import {} from '@unchainedshop/core';
+import { ProductUsSalesTax } from "./adapter.js";
+export const ProductUsSalesTaxPlugin = {
+    key: 'shop.unchained.pricing.product-us-sales-tax',
+    label: 'Product US Sales Tax Plugin',
+    version: '1.0.0',
+    adapters: [ProductUsSalesTax],
+};
+export default ProductUsSalesTaxPlugin;
+export { ProductUsSalesTax } from "./adapter.js";

package/lib/pricing/product-us-sales-tax.d.ts

@@ -0,0 +1,2 @@
+import { type IProductPricingAdapter } from '@unchainedshop/core';
+export declare const ProductUsSalesTax: IProductPricingAdapter;

package/lib/pricing/product-us-sales-tax.js

@@ -0,0 +1,52 @@
+import { ProductPricingDirector, ProductPricingAdapter, ProductPricingRowCategory, } from '@unchainedshop/core';
+import { US_COUNTRY_CODE, isProductExemptFromUsSalesTax, resolveUsSalesTaxRate } from "./tax/us.js";
+import resolveDeliveryLocation from "./utils/resolveDeliveryLocation.js";
+import { applyTaxRateToTaxableRows } from "./tax/applyTaxRateToTaxableRows.js";
+export const ProductUsSalesTax = {
+    ...ProductPricingAdapter,
+    key: 'shop.unchained.pricing.product-us-sales-tax',
+    version: '1.0.0',
+    label: 'Apply US State Sales Tax on Product',
+    orderIndex: 80,
+    isActivatedFor: () => {
+        return true;
+    },
+    actions: (params) => {
+        const pricingAdapter = ProductPricingAdapter.actions(params);
+        const { context } = params;
+        return {
+            ...pricingAdapter,
+            calculate: async () => {
+                if (isProductExemptFromUsSalesTax(context.product)) {
+                    return pricingAdapter.calculate();
+                }
+                const orderDelivery = context.order?.deliveryId
+                    ? await context.modules.orders.deliveries.findDelivery({
+                        orderDeliveryId: context.order?.deliveryId,
+                    })
+                    : null;
+                const { countryCode, regionCode } = resolveDeliveryLocation({ ...context, orderDelivery });
+                if (countryCode !== US_COUNTRY_CODE)
+                    return pricingAdapter.calculate();
+                const taxRate = resolveUsSalesTaxRate({
+                    regionCode,
+                    referenceDate: context.order?.ordered,
+                });
+                if (taxRate === null) {
+                    ProductPricingAdapter.log(`ProductUsSalesTax -> unknown state '${regionCode}', no sales tax applied`);
+                    return pricingAdapter.calculate();
+                }
+                ProductPricingAdapter.log(`ProductUsSalesTax -> Tax Multiplicator: ${taxRate}`);
+                applyTaxRateToTaxableRows({
+                    calculationSheet: params.calculationSheet,
+                    resultSheet: pricingAdapter.resultSheet(),
+                    taxRate,
+                    baseCategory: ProductPricingRowCategory.Item,
+                    adapterKey: ProductUsSalesTax.key,
+                });
+                return pricingAdapter.calculate();
+            },
+        };
+    },
+};
+ProductPricingDirector.registerAdapter(ProductUsSalesTax);

package/lib/pricing/tax/applyTaxRateToTaxableRows.d.ts

@@ -0,0 +1,23 @@
+import type { PricingCalculation } from '@unchainedshop/utils';
+export interface TaxableCalculation extends PricingCalculation {
+    isTaxable?: boolean;
+    isNetPrice?: boolean;
+}
+export interface TaxResultSheet {
+    calculation: PricingCalculation[];
+    addTax: (row: {
+        amount: number;
+        rate: number;
+        baseCategory: string;
+        meta?: unknown;
+    }) => void;
+}
+export declare const applyTaxRateToTaxableRows: <Calculation extends TaxableCalculation>({ calculationSheet, resultSheet, taxRate, baseCategory, adapterKey, }: {
+    calculationSheet: {
+        filterBy: (filter?: Partial<Calculation>) => Calculation[];
+    };
+    resultSheet: TaxResultSheet;
+    taxRate: number;
+    baseCategory: string;
+    adapterKey: string;
+}) => void;

package/lib/pricing/tax/applyTaxRateToTaxableRows.js

@@ -0,0 +1,30 @@
+export const applyTaxRateToTaxableRows = ({ calculationSheet, resultSheet, taxRate, baseCategory, adapterKey, }) => {
+    calculationSheet
+        .filterBy({ isTaxable: true })
+        .forEach(({ isNetPrice, ...row }) => {
+        if (!isNetPrice) {
+            const taxAmount = row.amount - row.amount / (1 + taxRate);
+            resultSheet.calculation.push({
+                ...row,
+                amount: -taxAmount,
+                isTaxable: false,
+                isNetPrice: false,
+                meta: { adapter: adapterKey },
+            });
+            resultSheet.addTax({
+                amount: taxAmount,
+                rate: taxRate,
+                baseCategory,
+                meta: { adapter: adapterKey },
+            });
+        }
+        else {
+            resultSheet.addTax({
+                amount: row.amount * taxRate,
+                rate: taxRate,
+                baseCategory,
+                meta: { adapter: adapterKey },
+            });
+        }
+    });
+};

package/lib/pricing/tax/ch-tax-rates.json

@@ -0,0 +1,24 @@
+{
+    "source": "https://www.estv.admin.ch/estv/en/home/value-added-tax/vat-rates-switzerland.html",
+    "verifiedAt": "2026-08-20",
+    "timezone": "+01:00",
+    "categories": {
+        "default": [
+            { "validFrom": "2001-01-01", "rate": 0.076 },
+            { "validFrom": "2011-01-01", "rate": 0.08 },
+            { "validFrom": "2018-01-01", "rate": 0.077 },
+            { "validFrom": "2024-01-01", "rate": 0.081 }
+        ],
+        "reduced": [
+            { "validFrom": "2001-01-01", "rate": 0.024 },
+            { "validFrom": "2011-01-01", "rate": 0.025 },
+            { "validFrom": "2024-01-01", "rate": 0.026 }
+        ],
+        "special": [
+            { "validFrom": "2001-01-01", "rate": 0.036 },
+            { "validFrom": "2011-01-01", "rate": 0.038 },
+            { "validFrom": "2018-01-01", "rate": 0.037 },
+            { "validFrom": "2024-01-01", "rate": 0.038 }
+        ]
+    }
+}

package/lib/pricing/tax/ch.js

@@ -1,33 +1,9 @@
-const startOf2024 = new Date('2024-01-01T00:00:00.000+0100');
-export const SwissTaxCategories = {
-    DEFAULT: {
-        value: 'default',
-        rate: (referenceDate = new Date()) => {
-            if (referenceDate.getTime() < startOf2024.getTime()) {
-                return 0.077;
-            }
-            return 0.081;
-        },
-    },
-    REDUCED: {
-        value: 'reduced',
-        rate: (referenceDate = new Date()) => {
-            if (referenceDate.getTime() < startOf2024.getTime()) {
-                return 0.025;
-            }
-            return 0.026;
-        },
-    },
-    SPECIAL: {
-        value: 'special',
-        rate: (referenceDate = new Date()) => {
-            if (referenceDate.getTime() < startOf2024.getTime()) {
-                return 0.037;
-            }
-            return 0.038;
-        },
-    },
-};
+import swissTaxRates from './ch-tax-rates.json' with { type: 'json' };
+import { compileEraRates, rateForDate } from "./eraRates.js";
+export const SwissTaxCategories = Object.fromEntries(Object.entries(swissTaxRates.categories).map(([value, eras]) => [
+    value.toUpperCase(),
+    { value, rate: rateForDate(compileEraRates(eras, swissTaxRates.timezone)) },
+]));
 export const resolveTaxCategoryFromDeliveryProvider = (provider) => {
     const taxCategoryFromProvider = provider?.configuration
         ?.find(({ key }) => {

package/lib/pricing/tax/eraRates.d.ts

@@ -0,0 +1,10 @@
+export interface TaxRateEra {
+    validFrom: string;
+    rate: number;
+}
+export interface CompiledTaxRateEra {
+    validFrom: number;
+    rate: number;
+}
+export declare const compileEraRates: (eras: TaxRateEra[], utcOffset: string) => CompiledTaxRateEra[];
+export declare const rateForDate: (eras: CompiledTaxRateEra[]) => (referenceDate?: Date) => number;

package/lib/pricing/tax/eraRates.js

@@ -0,0 +1,15 @@
+export const compileEraRates = (eras, utcOffset) => eras
+    .map(({ validFrom, rate }) => ({
+    validFrom: new Date(`${validFrom}T00:00:00.000${utcOffset}`).getTime(),
+    rate,
+}))
+    .sort((left, right) => left.validFrom - right.validFrom);
+export const rateForDate = (eras) => (referenceDate = new Date()) => {
+    const time = referenceDate.getTime();
+    let applicable = eras[0];
+    for (const era of eras) {
+        if (era.validFrom <= time)
+            applicable = era;
+    }
+    return applicable.rate;
+};