@unchainedshop/core-warehousing 3.0.0-alpha7 → 3.0.0-rc2

package/src/director/WarehousingDirector.ts

@@ -1,153 +0,0 @@
-import { IWarehousingAdapter, IWarehousingDirector, WarehousingContext } from '../types.js';
-import { DeliveryDirector } from '@unchainedshop/core-delivery';
-import { log, LogLevel } from '@unchainedshop/logger';
-import { BaseDirector } from '@unchainedshop/utils';
-import { WarehousingError } from './WarehousingError.js';
-
-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 - stock, 0);
-        const productionTime = await adapter.productionTime(notInStockQuantity);
-        const commissioningTime = await adapter.commissioningTime(quantity);
-        return Math.max(commissioningTime + productionTime, 0);
-      } catch (error) {
-        log(error.message, { level: LogLevel.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) {
-          log(error.message, { level: LogLevel.Error });
-          return false;
-        }
-      },
-
-      estimatedStock: async () => {
-        try {
-          const referenceDate = getReferenceDate(context);
-          const quantity = await adapter.stock(referenceDate);
-          return {
-            quantity,
-          };
-        } catch (error) {
-          log(error.message, { level: LogLevel.Error, ...error });
-          return null;
-        }
-      },
-
-      estimatedDispatch: async () => {
-        try {
-          const { deliveryProvider } = context;
-          const referenceDate = getReferenceDate(context);
-
-          const warehousingThroughputTime = await throughputTime(referenceDate);
-          if (!Number.isFinite(warehousingThroughputTime)) {
-            return {
-              shipping: null,
-              earliestDelivery: null,
-            };
-          }
-
-          // 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)
-            : null;
-
-          return {
-            shipping,
-            earliestDelivery,
-          };
-        } catch (error) {
-          log(error.message, { level: LogLevel.Error, ...error });
-          return {};
-        }
-      },
-
-      tokenMetadata: async (chainTokenId) => {
-        try {
-          const referenceDate = getReferenceDate(context);
-          const tokenMetadata = await adapter.tokenMetadata(chainTokenId, referenceDate);
-          return tokenMetadata;
-        } catch (error) {
-          log(error.message, { level: LogLevel.Error, ...error });
-          return {};
-        }
-      },
-
-      isInvalidateable: async (chainTokenId) => {
-        try {
-          const referenceDate = getReferenceDate(context);
-          const isInvalidateable = await adapter.isInvalidateable(chainTokenId, referenceDate);
-          return isInvalidateable;
-        } catch (error) {
-          log(error.message, { level: LogLevel.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) {
-          log(error.message, { level: LogLevel.Error, ...error });
-          return [];
-        }
-      },
-    };
-  },
-};

package/src/director/WarehousingError.ts

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

package/src/director/WarehousingProviderType.ts

@@ -1,4 +0,0 @@
-export enum WarehousingProviderType {
-  PHYSICAL = 'PHYSICAL',
-  VIRTUAL = 'VIRTUAL',
-}

package/src/types.ts

@@ -1,116 +0,0 @@
-import { IBaseAdapter, IBaseDirector } from '@unchainedshop/utils';
-import type { TimestampFields } from '@unchainedshop/mongodb';
-import { DeliveryProvider } from '@unchainedshop/core-delivery';
-import { Product } from '@unchainedshop/core-products';
-import { Order } from '@unchainedshop/core-orders';
-import { OrderPosition } from '@unchainedshop/core-orders';
-import { UnchainedCore } from '@unchainedshop/core';
-
-export enum WarehousingProviderType {
-  PHYSICAL = 'PHYSICAL',
-  VIRTUAL = 'VIRTUAL',
-}
-
-export type WarehousingConfiguration = Array<{ key: string; value: string }>;
-
-export type WarehousingProvider = {
-  _id?: string;
-  type: WarehousingProviderType;
-  adapterKey: string;
-  configuration: WarehousingConfiguration;
-} & TimestampFields;
-
-export type WarehousingProviderQuery = {
-  type?: WarehousingProviderType;
-};
-
-export enum WarehousingError {
-  ADAPTER_NOT_FOUND = 'ADAPTER_NOT_FOUND',
-  NOT_IMPLEMENTED = 'NOT_IMPLEMENTED',
-  INCOMPLETE_CONFIGURATION = 'INCOMPLETE_CONFIGURATION',
-  WRONG_CREDENTIALS = 'WRONG_CREDENTIALS',
-}
-
-export type TokenSurrogate = {
-  _id?: string;
-  userId?: string;
-  walletAddress?: string;
-  invalidatedDate?: Date;
-  expiryDate?: Date;
-  quantity: number;
-  contractAddress: string;
-  chainId: string;
-  chainTokenId: string;
-  productId: string;
-  orderPositionId: string;
-  meta: any;
-};
-
-export enum TokenStatus {
-  CENTRALIZED = 'CENTRALIZED',
-  EXPORTING = 'EXPORTING',
-  DECENTRALIZED = 'DECENTRALIZED',
-}
-
-export interface WarehousingContext {
-  deliveryProvider?: DeliveryProvider;
-  product?: Product;
-  token?: TokenSurrogate;
-  quantity?: number;
-  referenceDate?: Date;
-  locale?: Intl.Locale;
-  order?: Order;
-  warehousingProviderId?: string;
-  orderPosition?: OrderPosition;
-}
-
-export type EstimatedDispatch = {
-  shipping?: Date;
-  earliestDelivery?: Date;
-};
-
-export type EstimatedStock = { quantity: number } | null;
-
-export type WarehousingAdapterActions = {
-  configurationError: () => WarehousingError;
-  isActive: () => boolean;
-  stock: (referenceDate: Date) => Promise<number>;
-  productionTime: (quantityToProduce: number) => Promise<number>;
-  commissioningTime: (quantity: number) => Promise<number>;
-  tokenize: () => Promise<Array<Omit<TokenSurrogate, 'userId' | 'productId' | 'orderPositionId'>>>;
-  tokenMetadata: (chainTokenId: string, referenceDate: Date) => Promise<any>;
-  isInvalidateable: (chainTokenId: string, referenceDate: Date) => Promise<boolean>;
-};
-
-export type IWarehousingAdapter = IBaseAdapter & {
-  orderIndex: number;
-  initialConfiguration: WarehousingConfiguration;
-  typeSupported: (type: WarehousingProviderType) => boolean;
-
-  actions: (
-    config: WarehousingConfiguration,
-    context: WarehousingContext & UnchainedCore,
-  ) => WarehousingAdapterActions;
-};
-
-export type IWarehousingDirector = IBaseDirector<IWarehousingAdapter> & {
-  actions: (
-    warehousingProvider: WarehousingProvider,
-    warehousingContext: WarehousingContext,
-    unchainedAPI: UnchainedCore,
-  ) => Promise<{
-    configurationError: () => WarehousingError;
-    isActive: () => boolean;
-    estimatedStock: () => Promise<EstimatedStock>;
-    estimatedDispatch: () => Promise<EstimatedDispatch>;
-    tokenize: () => Promise<Array<TokenSurrogate>>;
-    tokenMetadata: (chainTokenId: string) => Promise<any>;
-    isInvalidateable: (chainTokenId: string) => Promise<boolean>;
-  }>;
-};
-
-export interface WarehousingInterface {
-  _id: string;
-  label: string;
-  version: string;
-}