@unchainedshop/core-payment 3.0.0-alpha7 → 3.0.0-rc10

package/lib/types.js

@@ -1,17 +0,0 @@
-export var PaymentProviderType;
-(function (PaymentProviderType) {
-    PaymentProviderType["CARD"] = "CARD";
-    PaymentProviderType["INVOICE"] = "INVOICE";
-    PaymentProviderType["GENERIC"] = "GENERIC";
-})(PaymentProviderType || (PaymentProviderType = {}));
-export var PaymentError;
-(function (PaymentError) {
-    PaymentError["ADAPTER_NOT_FOUND"] = "ADAPTER_NOT_FOUND";
-    PaymentError["NOT_IMPLEMENTED"] = "NOT_IMPLEMENTED";
-    PaymentError["INCOMPLETE_CONFIGURATION"] = "INCOMPLETE_CONFIGURATION";
-    PaymentError["WRONG_CREDENTIALS"] = "WRONG_CREDENTIALS";
-})(PaymentError || (PaymentError = {}));
-/*
- * Settings
- */
-//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;AACrB,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AAuBD,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uDAAuC,CAAA;IACvC,mDAAmC,CAAA;IACnC,qEAAqD,CAAA;IACrD,uDAAuC,CAAA;AACzC,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAmED;;GAEG"}

package/src/director/PaymentAdapter.ts

@@ -1,63 +0,0 @@
-import { IPaymentAdapter } from '@unchainedshop/core-payment';
-import { log, LogLevel } from '@unchainedshop/logger';
-import { PaymentError } from './PaymentError.js';
-
-export const PaymentAdapter: Omit<IPaymentAdapter, 'key' | 'label' | 'version'> = {
-  initialConfiguration: [],
-
-  typeSupported: () => {
-    return false;
-  },
-
-  actions: () => {
-    return {
-      configurationError: () => {
-        return PaymentError.NOT_IMPLEMENTED;
-      },
-
-      isActive: () => {
-        return false;
-      },
-
-      isPayLaterAllowed: () => {
-        return false;
-      },
-
-      charge: async () => {
-        // if you return true, the status will be changed to PAID
-
-        // if you return false, the order payment status stays the
-        // same but the order status might change
-
-        // if you throw an error, you cancel the checkout process
-        return false;
-      },
-
-      register: async () => {
-        return {
-          token: '',
-        };
-      },
-
-      sign: async () => {
-        return null;
-      },
-
-      validate: async () => {
-        return false;
-      },
-
-      cancel: async () => {
-        return false;
-      },
-
-      confirm: async () => {
-        return false;
-      },
-    };
-  },
-
-  log(message: string, { level = LogLevel.Debug, ...options } = {}) {
-    return log(message, { level, ...options });
-  },
-};

package/src/director/PaymentDirector.ts

@@ -1,99 +0,0 @@
-import { IPaymentAdapter, IPaymentDirector, PaymentContext } from '@unchainedshop/core-payment';
-import { BaseDirector } from '@unchainedshop/utils';
-import { createLogger } from '@unchainedshop/logger';
-import { PaymentError } from './PaymentError.js';
-
-const logger = createLogger('unchained:core-payment');
-const baseDirector = BaseDirector<IPaymentAdapter>('PaymentDirector');
-
-export const PaymentDirector: IPaymentDirector = {
-  ...baseDirector,
-
-  actions: async (paymentProvider, paymentContext, unchainedAPI) => {
-    const Adapter = baseDirector.getAdapter(paymentProvider.adapterKey) as IPaymentAdapter;
-
-    if (!Adapter) {
-      throw new Error(`Payment Plugin ${paymentProvider.adapterKey} not available`);
-    }
-
-    const newPaymentContext: PaymentContext = {
-      ...paymentContext,
-    };
-
-    if (paymentContext?.orderPayment) {
-      const { modules } = unchainedAPI;
-      const { orderId } = paymentContext.orderPayment;
-      const order =
-        paymentContext?.order ||
-        (await modules.orders.findOrder({
-          orderId,
-        }));
-
-      newPaymentContext.order = order;
-    }
-
-    const adapter = Adapter.actions({
-      config: paymentProvider.configuration,
-      paymentContext: {
-        paymentProvider,
-        paymentProviderId: paymentProvider._id,
-        ...newPaymentContext,
-      },
-      context: unchainedAPI,
-    });
-
-    return {
-      configurationError: () => {
-        try {
-          const error = adapter.configurationError();
-          return error;
-        } catch {
-          return PaymentError.ADAPTER_NOT_FOUND;
-        }
-      },
-
-      isActive: () => {
-        try {
-          return adapter.isActive(paymentContext.transactionContext);
-        } catch (error) {
-          logger.error(error.message);
-          return false;
-        }
-      },
-
-      isPayLaterAllowed: () => {
-        try {
-          return adapter.isPayLaterAllowed(paymentContext.transactionContext);
-        } catch (error) {
-          logger.error(error.message);
-          return false;
-        }
-      },
-
-      charge: async () => {
-        return adapter.charge(paymentContext.transactionContext);
-      },
-
-      register: async () => {
-        return adapter.register(paymentContext.transactionContext);
-      },
-
-      sign: async () => {
-        return adapter.sign(paymentContext.transactionContext);
-      },
-
-      validate: async () => {
-        const validated = await adapter.validate(paymentContext.token);
-        return !!validated;
-      },
-
-      cancel: async () => {
-        return adapter.cancel(paymentContext.transactionContext);
-      },
-
-      confirm: async () => {
-        return adapter.confirm(paymentContext.transactionContext);
-      },
-    };
-  },
-};

package/src/director/PaymentError.ts

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

package/src/director/PaymentPricingAdapter.ts

@@ -1,87 +0,0 @@
-import {
-  BasePricingAdapterContext,
-  IPricingAdapter,
-  IPricingSheet,
-  PricingCalculation,
-} from '@unchainedshop/utils';
-import { BasePricingAdapter } from '@unchainedshop/utils';
-import { PaymentPricingSheet } from './PaymentPricingSheet.js';
-import { User } from '@unchainedshop/core-users';
-import { OrderPayment } from '@unchainedshop/core-orders';
-import { Order } from '@unchainedshop/core-orders';
-import { PaymentProvider } from '../types.js';
-import { OrderDiscount } from '@unchainedshop/core-orders';
-
-export interface PaymentPricingCalculation extends PricingCalculation {
-  discountId?: string;
-  isTaxable: boolean;
-  isNetPrice: boolean;
-  rate?: number;
-}
-export interface PaymentPricingAdapterContext extends BasePricingAdapterContext {
-  country?: string;
-  currency?: string;
-  user: User;
-  orderPayment: OrderPayment;
-  order: Order;
-  provider: PaymentProvider;
-  discounts: Array<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,
-  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 { currency } = context.order;
-    const baseActions = basePricingAdapter.actions(params);
-    const resultSheet = PaymentPricingSheet({ currency });
-
-    return {
-      ...baseActions,
-      calculate: async () => {
-        const resultRaw = resultSheet.getRawPricingSheet();
-        resultRaw.forEach(({ amount, category }) =>
-          basePricingAdapter.log(`Payment Calculation -> ${category} ${amount}`),
-        );
-        return resultRaw;
-      },
-      resultSheet: () => resultSheet,
-    };
-  },
-};

package/src/director/PaymentPricingDirector.ts

@@ -1,101 +0,0 @@
-import {
-  IPaymentPricingAdapter,
-  IPaymentPricingSheet,
-  PaymentPricingAdapterContext,
-  PaymentPricingCalculation,
-} from './PaymentPricingAdapter.js';
-import { BasePricingDirector } from '@unchainedshop/utils';
-import { PaymentPricingSheet } from './PaymentPricingSheet.js';
-import { User } from '@unchainedshop/core-users';
-import { Order } from '@unchainedshop/core-orders';
-import { PaymentProvider } from '../types.js';
-import { OrderPayment } from '@unchainedshop/core-orders';
-import { IPricingDirector } from '@unchainedshop/utils';
-
-export type PaymentPricingContext =
-  | {
-      country?: string;
-      currency?: string;
-      user: User;
-      order: Order;
-      provider: PaymentProvider;
-      providerContext?: any;
-    }
-  | {
-      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 = {
-  ...baseDirector,
-
-  async buildPricingContext(context, unchainedAPI) {
-    const { modules } = unchainedAPI;
-
-    if ('item' in context) {
-      const { item } = 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,
-        country: order.countryCode,
-        currency: order.currency,
-        order,
-        provider,
-        user,
-        discounts,
-        orderPayment: item,
-        providerContext: null,
-      };
-    }
-
-    return {
-      ...unchainedAPI,
-      country: context.country,
-      currency: context.currency,
-      order: context.order,
-      provider: context.provider,
-      user: context.user,
-      discounts: [],
-      orderPayment: null,
-      providerContext: context.providerContext,
-    };
-  },
-
-  async actions(pricingContext, unchainedAPI) {
-    const actions = await baseDirector.actions(pricingContext, unchainedAPI, this.buildPricingContext);
-    return {
-      ...actions,
-      calculationSheet() {
-        const context = actions.getContext();
-        return PaymentPricingSheet({
-          calculation: actions.getCalculation(),
-          currency: context.currency,
-        });
-      },
-    };
-  },
-};

package/src/director/PaymentPricingSheet.ts

@@ -1,87 +0,0 @@
-import { BasePricingSheet } from '@unchainedshop/utils';
-import { PaymentPricingCalculation, IPaymentPricingSheet } from './PaymentPricingAdapter.js';
-import { IBasePricingSheet, PricingSheetParams } from '@unchainedshop/utils';
-
-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);
-
-      return [...new Set(discountIds)]
-        .map((discountId) => {
-          const amount = basePricingSheet.sum({
-            category: PaymentPricingRowCategory.Discount,
-            discountId,
-          });
-          if (!amount) {
-            return null;
-          }
-          return {
-            discountId,
-            amount: Math.round(amount),
-            currency: basePricingSheet.currency,
-          };
-        })
-        .filter(Boolean);
-    },
-  };
-
-  return pricingSheet;
-};

package/src/director/PaymentProviderType.ts

@@ -1,5 +0,0 @@
-export enum PaymentProviderType {
-  CARD = 'CARD',
-  INVOICE = 'INVOICE',
-  GENERIC = 'GENERIC',
-}

package/src/types.ts

@@ -1,108 +0,0 @@
-import { IBaseAdapter, IBaseDirector } from '@unchainedshop/utils';
-import type { TimestampFields } from '@unchainedshop/mongodb';
-import { Order } from '@unchainedshop/core-orders';
-import { OrderPayment } from '@unchainedshop/core-orders';
-import { UnchainedCore } from '@unchainedshop/core';
-
-export enum PaymentProviderType {
-  CARD = 'CARD',
-  INVOICE = 'INVOICE',
-  GENERIC = 'GENERIC',
-}
-
-export type PaymentConfiguration = Array<{
-  key: string;
-  value: string | null;
-}>;
-
-export type PaymentProvider = {
-  _id?: string;
-  type: PaymentProviderType;
-  adapterKey: string;
-  configuration: PaymentConfiguration;
-} & TimestampFields;
-
-export type PaymentCredentials = {
-  _id?: string;
-  paymentProviderId: string;
-  userId: string;
-  token?: string;
-  isPreferred?: boolean;
-  meta: any;
-} & TimestampFields;
-
-export enum PaymentError {
-  ADAPTER_NOT_FOUND = 'ADAPTER_NOT_FOUND',
-  NOT_IMPLEMENTED = 'NOT_IMPLEMENTED',
-  INCOMPLETE_CONFIGURATION = 'INCOMPLETE_CONFIGURATION',
-  WRONG_CREDENTIALS = 'WRONG_CREDENTIALS',
-}
-
-export interface PaymentContext {
-  userId?: string;
-  order?: Order;
-  orderPayment?: OrderPayment;
-  transactionContext?: any; // User for singing and charging a payment
-  token?: any; // Used for validation
-  meta?: any;
-}
-
-export type ChargeResult = {
-  transactionId?: string;
-  [key: string]: any;
-};
-
-export type PaymentChargeActionResult = ChargeResult & {
-  credentials?: {
-    token: string;
-    [key: string]: any;
-  };
-};
-export interface IPaymentActions {
-  charge: (transactionContext?: any) => Promise<PaymentChargeActionResult | false>;
-  configurationError: (transactionContext?: any) => PaymentError;
-  isActive: (transactionContext?: any) => boolean;
-  isPayLaterAllowed: (transactionContext?: any) => boolean;
-  register: (transactionContext?: any) => Promise<any>;
-  sign: (transactionContext?: any) => Promise<string>;
-  validate: (token?: any) => Promise<boolean>;
-  cancel: (transactionContext?: any) => Promise<boolean>;
-  confirm: (transactionContext?: any) => Promise<boolean>;
-}
-
-export type IPaymentAdapter = IBaseAdapter & {
-  initialConfiguration: PaymentConfiguration;
-
-  typeSupported: (type: PaymentProviderType) => boolean;
-
-  actions: (params: {
-    config: PaymentConfiguration;
-    paymentContext: PaymentContext & {
-      paymentProviderId: string;
-      paymentProvider: PaymentProvider;
-    };
-    context: UnchainedCore;
-  }) => IPaymentActions;
-};
-
-export type IPaymentDirector = IBaseDirector<IPaymentAdapter> & {
-  actions: (
-    paymentProvider: PaymentProvider,
-    paymentContext: PaymentContext,
-    unchainedAPI: UnchainedCore,
-  ) => Promise<IPaymentActions>;
-};
-
-/*
- * Module
- */
-
-export interface PaymentInterface {
-  _id: string;
-  label: string;
-  version: string;
-}
-
-/*
- * Settings
- */