@unchainedshop/core 4.3.5 → 4.4.0

package/src/directors/ProductPricingSheet.ts

@@ -1,125 +0,0 @@
-import { Price, PricingCalculation } from '@unchainedshop/utils';
-
-import { BasePricingSheet, IPricingSheet, PricingSheetParams } from '../directors/index.js';
-
-export interface ProductPricingCalculation extends PricingCalculation {
-  discountId?: string;
-  isTaxable: boolean;
-  isNetPrice: boolean;
-  rate?: number;
-}
-export enum ProductPricingRowCategory {
-  Item = 'ITEM',
-  Discount = 'DISCOUNT',
-  Tax = 'TAX',
-}
-
-export interface IProductPricingSheet extends IPricingSheet<ProductPricingCalculation> {
-  addItem: (params: Omit<ProductPricingCalculation, 'category' | 'discountId'>) => 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;
-
-  unitPrice: (params: { useNetPrice?: boolean }) => Price;
-}
-
-export const ProductPricingSheet = (
-  params: PricingSheetParams<ProductPricingCalculation>,
-): IProductPricingSheet => {
-  const basePricingSheet = BasePricingSheet<ProductPricingCalculation>(params);
-
-  const pricingSheet: IProductPricingSheet = {
-    ...basePricingSheet,
-
-    addDiscount({ amount, isTaxable, isNetPrice, discountId, meta }) {
-      basePricingSheet.calculation.push({
-        category: ProductPricingRowCategory.Discount,
-        amount,
-        isTaxable,
-        isNetPrice,
-        discountId,
-        meta,
-      });
-    },
-
-    addItem({ amount, isTaxable, isNetPrice, meta }) {
-      basePricingSheet.calculation.push({
-        category: ProductPricingRowCategory.Item,
-        amount,
-        isTaxable,
-        isNetPrice,
-        meta,
-      });
-    },
-
-    addTax({ amount, baseCategory, rate, meta, discountId }) {
-      basePricingSheet.calculation.push({
-        category: ProductPricingRowCategory.Tax,
-        baseCategory,
-        discountId,
-        amount,
-        isTaxable: false,
-        isNetPrice: false,
-        rate,
-        meta,
-      });
-    },
-
-    taxSum(filter) {
-      return basePricingSheet.sum({
-        category: ProductPricingRowCategory.Tax,
-        ...(filter || {}),
-      });
-    },
-
-    unitPrice(unitPriceParams) {
-      const amount = unitPriceParams?.useNetPrice ? this.net() : this.gross();
-      return {
-        amount: Math.round(amount / (this.quantity ?? 1)),
-        currencyCode: this.currencyCode,
-      };
-    },
-
-    discountPrices(explicitDiscountId) {
-      const discountIds = pricingSheet
-        .filterBy({
-          category: ProductPricingRowCategory.Discount,
-          discountId: explicitDiscountId,
-        })
-        .map(({ discountId }) => discountId)
-        .filter(Boolean) as string[];
-
-      return [...new Set(discountIds)]
-        .map((discountId) => {
-          const amount = basePricingSheet.sum({
-            category: ProductPricingRowCategory.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/QuotationAdapter.ts

@@ -1,82 +0,0 @@
-import {
-  Quotation,
-  QuotationItemConfiguration,
-  QuotationProposal,
-} from '@unchainedshop/core-quotations';
-import { BaseAdapter, IBaseAdapter } from '@unchainedshop/utils';
-
-export interface QuotationContext {
-  quotation?: Quotation;
-}
-
-export interface QuotationAdapterActions {
-  configurationError: () => QuotationError | null;
-  isManualProposalRequired: () => Promise<boolean>;
-  isManualRequestVerificationRequired: () => Promise<boolean>;
-  quote: () => Promise<QuotationProposal>;
-  rejectRequest: (unchainedAPI?: any) => Promise<boolean>;
-  submitRequest: (unchainedAPI?: any) => Promise<boolean>;
-  verifyRequest: (unchainedAPI?: any) => Promise<boolean>;
-
-  transformItemConfiguration: (
-    params: QuotationItemConfiguration,
-  ) => Promise<QuotationItemConfiguration | null>;
-}
-
-export type IQuotationAdapter = IBaseAdapter & {
-  orderIndex: number;
-  isActivatedFor: (quotationContext: QuotationContext, unchainedAPI) => boolean;
-  actions: (params: QuotationContext) => QuotationAdapterActions;
-};
-
-export enum QuotationError {
-  ADAPTER_NOT_FOUND = 'ADAPTER_NOT_FOUND',
-  NOT_IMPLEMENTED = 'NOT_IMPLEMENTED',
-  INCOMPLETE_CONFIGURATION = 'INCOMPLETE_CONFIGURATION',
-  WRONG_CREDENTIALS = 'WRONG_CREDENTIALS',
-}
-
-export const QuotationAdapter: Omit<IQuotationAdapter, 'key' | 'label' | 'version'> = {
-  ...BaseAdapter,
-  orderIndex: 0,
-
-  isActivatedFor: () => {
-    return false;
-  },
-
-  actions: () => {
-    return {
-      configurationError: () => {
-        return QuotationError.NOT_IMPLEMENTED;
-      },
-
-      isManualRequestVerificationRequired: async () => {
-        return true;
-      },
-
-      isManualProposalRequired: async () => {
-        return true;
-      },
-
-      quote: async () => {
-        return {};
-      },
-
-      rejectRequest: async () => {
-        return true;
-      },
-
-      submitRequest: async () => {
-        return true;
-      },
-
-      verifyRequest: async () => {
-        return true;
-      },
-
-      transformItemConfiguration: async ({ quantity, configuration }) => {
-        return { quantity, configuration };
-      },
-    };
-  },
-};

package/src/directors/QuotationDirector.ts

@@ -1,105 +0,0 @@
-import { BaseDirector, IBaseDirector } from '@unchainedshop/utils';
-import {
-  QuotationError,
-  IQuotationAdapter,
-  QuotationAdapterActions,
-  QuotationContext,
-} from './QuotationAdapter.js';
-import { createLogger } from '@unchainedshop/logger';
-
-const logger = createLogger('unchained:core');
-
-export type IQuotationDirector = IBaseDirector<IQuotationAdapter> & {
-  actions: (quotationContext: QuotationContext, unchainedAPI) => Promise<QuotationAdapterActions>;
-};
-
-const baseDirector = BaseDirector<IQuotationAdapter>('QuotationDirector', {
-  adapterSortKey: 'orderIndex',
-});
-
-const findAppropriateAdapters = (quotationContext: QuotationContext, unchainedAPI) =>
-  baseDirector.getAdapters({
-    adapterFilter: (Adapter: IQuotationAdapter) => {
-      const activated = Adapter.isActivatedFor(quotationContext, unchainedAPI);
-      if (!activated) {
-        logger.warn(`Quotation Director -> ${Adapter.key} (${Adapter.version}) skipped`);
-      }
-      return activated;
-    },
-  });
-
-export const QuotationDirector: IQuotationDirector = {
-  ...baseDirector,
-
-  actions: async (quotationContext, unchainedAPI) => {
-    const context = { ...quotationContext, ...unchainedAPI };
-
-    const Adapter = findAppropriateAdapters(quotationContext, unchainedAPI)?.shift();
-
-    if (!Adapter) {
-      throw new Error('No suitable quotation plugin available for this context');
-    }
-
-    const adapter = Adapter.actions(context);
-
-    return {
-      configurationError: () => {
-        try {
-          return adapter.configurationError();
-        } catch (error) {
-          logger.warn('QuotationDirector -> Error while checking for configurationError', {
-            ...error,
-          });
-          return QuotationError.ADAPTER_NOT_FOUND;
-        }
-      },
-
-      isManualRequestVerificationRequired: async () => {
-        try {
-          const isRequired = await adapter.isManualRequestVerificationRequired();
-          return isRequired;
-        } catch (error) {
-          logger.error(
-            'QuotationDirector -> Error while checking if is manual request verification required',
-            {
-              ...error,
-            },
-          );
-          return true;
-        }
-      },
-
-      isManualProposalRequired: async () => {
-        try {
-          const isRequired = await adapter.isManualProposalRequired();
-          return isRequired;
-        } catch (error) {
-          logger.error('QuotationDirector -> Error while checking if is manual proposal required', {
-            ...error,
-          });
-          return true;
-        }
-      },
-
-      quote: adapter.quote,
-      rejectRequest: adapter.rejectRequest,
-      submitRequest: adapter.submitRequest,
-      verifyRequest: adapter.verifyRequest,
-
-      transformItemConfiguration: async ({ quantity, configuration }) => {
-        try {
-          const itemConfiguration = await adapter.transformItemConfiguration({
-            quantity,
-            configuration,
-          });
-          return itemConfiguration;
-        } catch (error) {
-          logger.error('QuotationDirector -> Error while transforming item configuration', {
-            ...error,
-          });
-          return null;
-        }
-      },
-    };
-  },
-};

package/src/directors/WarehousingAdapter.ts

@@ -1,77 +0,0 @@
-import { BaseAdapter, IBaseAdapter } from '@unchainedshop/utils';
-import { DeliveryProvider } from '@unchainedshop/core-delivery';
-import { Product } from '@unchainedshop/core-products';
-import { Order, OrderPosition } from '@unchainedshop/core-orders';
-import {
-  TokenSurrogate,
-  WarehousingConfiguration,
-  WarehousingProviderType,
-} from '@unchainedshop/core-warehousing';
-
-export enum WarehousingError {
-  ADAPTER_NOT_FOUND = 'ADAPTER_NOT_FOUND',
-  NOT_IMPLEMENTED = 'NOT_IMPLEMENTED',
-  INCOMPLETE_CONFIGURATION = 'INCOMPLETE_CONFIGURATION',
-  WRONG_CREDENTIALS = 'WRONG_CREDENTIALS',
-}
-
-export interface WarehousingAdapterActions {
-  configurationError: () => WarehousingError | null;
-  isActive: () => boolean;
-  stock: (referenceDate: Date) => Promise<number>;
-  productionTime: (quantityToProduce: number) => Promise<number>;
-  commissioningTime: (quantity: number) => Promise<number>;
-  tokenize: () => Promise<Omit<TokenSurrogate, 'userId' | 'productId' | 'orderPositionId'>[]>;
-  tokenMetadata: (tokenSerialNumber: string, referenceDate: Date) => Promise<any>;
-  isInvalidateable: (tokenSerialNumber: string, referenceDate: Date) => Promise<boolean>;
-}
-
-export interface WarehousingContext {
-  deliveryProvider?: DeliveryProvider;
-  product?: Product;
-  token?: TokenSurrogate;
-  quantity?: number;
-  referenceDate?: Date;
-  locale?: Intl.Locale;
-  order?: Order;
-  orderPosition?: OrderPosition;
-}
-
-export type IWarehousingAdapter = IBaseAdapter & {
-  orderIndex: number;
-  initialConfiguration: WarehousingConfiguration;
-  typeSupported: (type: WarehousingProviderType) => boolean;
-
-  actions: (config: WarehousingConfiguration, context: WarehousingContext) => WarehousingAdapterActions;
-};
-
-export const WarehousingAdapter: Omit<IWarehousingAdapter, 'key' | 'label' | 'version'> = {
-  ...BaseAdapter,
-  orderIndex: 0,
-
-  typeSupported: () => {
-    return false;
-  },
-
-  initialConfiguration: [],
-
-  actions: () => {
-    return {
-      configurationError: () => WarehousingError.NOT_IMPLEMENTED,
-
-      isActive: () => false,
-
-      stock: async () => 0,
-
-      productionTime: async () => 0,
-
-      commissioningTime: async () => 0,
-
-      tokenize: async () => [],
-
-      tokenMetadata: async () => ({}),
-
-      isInvalidateable: async () => true,
-    };
-  },
-};

package/src/directors/WarehousingDirector.ts

@@ -1,233 +0,0 @@
-import { IBaseDirector, BaseDirector } from '@unchainedshop/utils';
-import { WarehousingProvider, TokenSurrogate } from '@unchainedshop/core-warehousing';
-import { createLogger } from '@unchainedshop/logger';
-
-const logger = createLogger('unchained:core');
-
-import {
-  DeliveryDirector,
-  IWarehousingAdapter,
-  WarehousingContext,
-  WarehousingError,
-} from '../directors/index.js';
-import { Modules } from '../modules.js';
-
-export interface EstimatedDispatch {
-  shipping?: Date;
-  earliestDelivery?: Date;
-}
-
-export type EstimatedStock = { quantity: number } | null;
-
-export interface WarehousingInterface {
-  _id: string;
-  label: string;
-  version: string;
-}
-
-export type IWarehousingDirector = IBaseDirector<IWarehousingAdapter> & {
-  tokenMetadata: (
-    virtualProviders: WarehousingProvider[],
-    warehousingContext: WarehousingContext & { token: { tokenSerialNumber: string } },
-    unchainedAPI,
-  ) => Promise<any>;
-
-  isInvalidateable: (
-    virtualProviders: WarehousingProvider[],
-    warehousingContext: WarehousingContext & { token: { tokenSerialNumber: string } },
-    unchainedAPI,
-  ) => Promise<any>;
-
-  actions: (
-    warehousingProvider: WarehousingProvider,
-    warehousingContext: WarehousingContext,
-    unchainedAPI: { modules: Modules },
-  ) => Promise<{
-    configurationError: () => WarehousingError | null;
-    isActive: () => boolean;
-    estimatedStock: () => Promise<EstimatedStock>;
-    estimatedDispatch: () => Promise<EstimatedDispatch>;
-    tokenize: () => Promise<TokenSurrogate[]>;
-    tokenMetadata: (tokenSerialNumber: string) => Promise<any>;
-    isInvalidateable: (tokenSerialNumber: string) => Promise<boolean>;
-  }>;
-};
-
-const getReferenceDate = (context: WarehousingContext) => {
-  return context && context.referenceDate ? context.referenceDate : new Date();
-};
-
-const baseDirector = BaseDirector<IWarehousingAdapter>('WarehousingDirector', {
-  adapterSortKey: 'orderIndex',
-});
-
-export const WarehousingDirector: IWarehousingDirector = {
-  ...baseDirector,
-
-  actions: async (warehousingProvider, warehousingContext, unchainedAPI) => {
-    const Adapter = baseDirector.getAdapter(warehousingProvider.adapterKey);
-
-    if (!Adapter) {
-      throw new Error(`Warehousing Plugin ${warehousingProvider.adapterKey} not available`);
-    }
-    const context = {
-      warehousingProviderId: warehousingProvider._id,
-      ...warehousingContext,
-      ...unchainedAPI,
-    };
-    const adapter = Adapter.actions(warehousingProvider.configuration, context);
-
-    const throughputTime = async (referenceDate) => {
-      try {
-        const { quantity } = context;
-        const stock = await adapter.stock(referenceDate);
-        const notInStockQuantity = Math.max((quantity || 1) - stock, 0);
-        const productionTime = await adapter.productionTime(notInStockQuantity);
-        const commissioningTime = await adapter.commissioningTime(quantity || 1);
-        return Math.max(commissioningTime + productionTime, 0);
-      } catch (error) {
-        logger.error(error);
-        return NaN;
-      }
-    };
-
-    return {
-      configurationError: () => {
-        try {
-          const error = adapter.configurationError();
-          return error;
-        } catch {
-          return WarehousingError.ADAPTER_NOT_FOUND;
-        }
-      },
-
-      isActive: () => {
-        try {
-          return adapter.isActive();
-        } catch (error) {
-          logger.error(error);
-          return false;
-        }
-      },
-
-      estimatedStock: async () => {
-        try {
-          const referenceDate = getReferenceDate(context);
-          const quantity = await adapter.stock(referenceDate);
-          return {
-            quantity,
-          };
-        } catch (error) {
-          logger.error(error);
-          return null;
-        }
-      },
-
-      estimatedDispatch: async () => {
-        try {
-          const { deliveryProvider } = context;
-          const referenceDate = getReferenceDate(context);
-
-          const warehousingThroughputTime = await throughputTime(referenceDate);
-          if (!Number.isFinite(warehousingThroughputTime)) {
-            return {};
-          }
-
-          // Calculate shipping date
-          const shippingTimestamp = referenceDate.getTime() + warehousingThroughputTime;
-          const shipping = new Date(shippingTimestamp);
-
-          // Calculate earliest delivery date
-          const actions = await DeliveryDirector.actions(deliveryProvider!, context, unchainedAPI);
-          const deliveryThroughputTime =
-            await actions.estimatedDeliveryThroughput(warehousingThroughputTime);
-          const earliestDelivery = Number.isFinite(deliveryThroughputTime)
-            ? new Date(shippingTimestamp + deliveryThroughputTime!)
-            : undefined;
-
-          return {
-            shipping,
-            earliestDelivery,
-          };
-        } catch (error) {
-          logger.error(error);
-          return {};
-        }
-      },
-
-      tokenMetadata: async (tokenSerialNumber) => {
-        try {
-          const referenceDate = getReferenceDate(context);
-          const tokenMetadata = await adapter.tokenMetadata(tokenSerialNumber, referenceDate);
-          return tokenMetadata;
-        } catch (error) {
-          logger.error(error);
-          return {};
-        }
-      },
-
-      isInvalidateable: async (tokenSerialNumber) => {
-        try {
-          const referenceDate = getReferenceDate(context);
-          const isInvalidateable = await adapter.isInvalidateable(tokenSerialNumber, referenceDate);
-          return isInvalidateable;
-        } catch (error) {
-          logger.error(error);
-          return false;
-        }
-      },
-
-      tokenize: async () => {
-        try {
-          const tokens = await adapter.tokenize();
-          const { order, orderPosition } = warehousingContext;
-          return tokens.map((token) => {
-            return {
-              ...token,
-              userId: order!.userId,
-              productId: orderPosition!.productId,
-              orderPositionId: orderPosition!._id,
-            };
-          });
-        } catch (error) {
-          logger.error(error);
-          return [];
-        }
-      },
-    };
-  },
-
-  async tokenMetadata(virtualProviders, warehousingContext, unchainedAPI) {
-    return virtualProviders.reduce(async (lastPromise, provider) => {
-      const last = await lastPromise;
-      if (last) return last;
-      const currentDirector = await WarehousingDirector.actions(
-        provider,
-        warehousingContext,
-        unchainedAPI,
-      );
-      const isActive = await currentDirector.isActive();
-      if (isActive) {
-        return currentDirector.tokenMetadata(warehousingContext.token.tokenSerialNumber);
-      }
-      return null;
-    }, Promise.resolve(null));
-  },
-
-  async isInvalidateable(virtualProviders, warehousingContext, unchainedAPI) {
-    return virtualProviders.reduce(async (lastPromise, provider) => {
-      const last = await lastPromise;
-      if (last) return last;
-      const currentDirector = await WarehousingDirector.actions(
-        provider,
-        warehousingContext,
-        unchainedAPI,
-      );
-      const isActive = await currentDirector.isActive();
-      if (isActive) {
-        return currentDirector.isInvalidateable(warehousingContext.token.tokenSerialNumber);
-      }
-      return null;
-    }, Promise.resolve(null));
-  },
-};

package/src/directors/WorkerAdapter.ts

@@ -1,31 +0,0 @@
-import { BaseAdapter, IBaseAdapter } from '@unchainedshop/utils';
-import { WorkResult } from '@unchainedshop/core-worker';
-import { ModuleOptions, Modules } from '../modules.js';
-import { Services } from '../services/index.js';
-import { BulkImporter } from '../bulk-importer/index.js';
-
-export type IWorkerAdapter<Input, Output> = IBaseAdapter & {
-  type: string;
-  external: boolean;
-  maxParallelAllocations?: number;
-
-  doWork: (
-    input: Input,
-    unchainedAPI: {
-      modules: Modules;
-      services: Services;
-      bulkImporter: BulkImporter;
-      options: ModuleOptions;
-    },
-    workId: string,
-  ) => Promise<WorkResult<Output>>;
-};
-
-export const WorkerAdapter: Omit<IWorkerAdapter<any, void>, 'key' | 'label' | 'type' | 'version'> = {
-  ...BaseAdapter,
-  external: false,
-
-  async doWork() {
-    return { success: false };
-  },
-};