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

package/src/director/EnrollmentDirector.ts

@@ -1,60 +0,0 @@
-import { EnrollmentData, IEnrollmentAdapter, IEnrollmentDirector } from '../types.js';
-import { ProductPlan } from '@unchainedshop/core-products';
-import { log, LogLevel } from '@unchainedshop/logger';
-import { BaseDirector } from '@unchainedshop/utils';
-
-const baseDirector = BaseDirector<IEnrollmentAdapter>('EnrollmentDirector', {
-  adapterSortKey: 'orderIndex',
-});
-
-const findAppropriateAdapters = (productPlan?: ProductPlan) =>
-  baseDirector.getAdapters({
-    adapterFilter: (Adapter: IEnrollmentAdapter) => {
-      const activated = Adapter.isActivatedFor(productPlan);
-      if (!activated) {
-        log(`Enrollment Director -> ${Adapter.key} (${Adapter.version}) skipped`, {
-          level: LogLevel.Warning,
-        });
-      }
-      return activated;
-    },
-  });
-
-export const EnrollmentDirector: IEnrollmentDirector = {
-  ...baseDirector,
-
-  transformOrderItemToEnrollment: async ({ orderPosition, product }, doc, unchainedAPI) => {
-    const Adapter = findAppropriateAdapters(product.plan)?.[0];
-    if (!Adapter) {
-      throw new Error('No suitable enrollment plugin available for this item');
-    }
-
-    const enrollmentPlan = await Adapter.transformOrderItemToEnrollmentPlan(orderPosition, unchainedAPI);
-
-    const enrollmentData: EnrollmentData = {
-      ...doc,
-      ...enrollmentPlan,
-      configuration: [],
-    };
-
-    return enrollmentData;
-  },
-
-  actions: async (enrollmentContext, unchainedAPI) => {
-    const context = { ...enrollmentContext, ...unchainedAPI };
-
-    // Resolve adapter
-    const product = await context.modules.products.findProduct({
-      productId: context.enrollment.productId,
-    });
-
-    const Adapter = findAppropriateAdapters(product?.plan)?.[0];
-
-    if (!Adapter) {
-      throw new Error('No suitable enrollment plugin available for this plan configuration');
-    }
-    const adapter = Adapter.actions(context);
-
-    return adapter;
-  },
-};

package/src/director/EnrollmentError.ts

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

package/src/module/periodForReferenceDate.test.ts

@@ -1,23 +0,0 @@
-import { periodForReferenceDate } from '../director/EnrollmentAdapter.js';
-
-describe('periodForReferenceDate', () => {
-  it('Should return 1 week interval from When passed a given date', () => {
-    expect(periodForReferenceDate(new Date('2022-12-03T17:00:00.000Z'))).toEqual({
-      start: new Date('2022-12-03T17:00:00.000Z'),
-      end: new Date('2022-12-10T17:00:00.000Z'),
-    });
-  });
-  it('Should return 2 week interval from When passed 2 as interval', () => {
-    expect(periodForReferenceDate(new Date('2022-12-03T17:00:00.000Z'), 2)).toEqual({
-      start: new Date('2022-12-03T17:00:00.000Z'),
-      end: new Date('2022-12-17T17:00:00.000Z'),
-    });
-  });
-
-  it('Should return 2 HOURS when interval is set to HOURS', () => {
-    expect(periodForReferenceDate(new Date('2022-12-03T17:00:00.000Z'), 2, 'HOURS')).toEqual({
-      start: new Date('2022-12-03T17:00:00.000Z'),
-      end: new Date('2022-12-03T19:00:00.000Z'),
-    });
-  });
-});

package/src/types.ts

@@ -1,113 +0,0 @@
-import type { IBaseAdapter, IBaseDirector } from '@unchainedshop/utils';
-import type { TimestampFields, LogFields, Address, Contact } from '@unchainedshop/mongodb';
-import { Product, ProductPlan } from '@unchainedshop/core-products';
-import { OrderPosition } from '@unchainedshop/core-orders';
-import { UnchainedCore } from '@unchainedshop/core';
-
-export enum EnrollmentStatus {
-  INITIAL = 'INITIAL',
-  ACTIVE = 'ACTIVE',
-  PAUSED = 'PAUSED',
-  TERMINATED = 'TERMINATED',
-}
-
-export interface EnrollmentPeriod {
-  start: Date;
-  end: Date;
-  orderId?: string;
-  isTrial?: boolean;
-}
-
-export interface EnrollmentPlan {
-  configuration: Array<{ key: string; value: string }>;
-  productId: string;
-  quantity: number;
-}
-
-export type EnrollmentQuery = {
-  status?: Array<EnrollmentStatus>;
-  userId?: string;
-  queryString?: string;
-};
-
-export type Enrollment = {
-  _id?: string;
-  billingAddress: Address;
-  configuration: Array<{ key: string; value: string }>;
-  contact: Contact;
-  context?: any;
-  countryCode?: string;
-  currencyCode?: string;
-  delivery: {
-    deliveryProviderId?: string;
-    context?: any;
-  };
-  enrollmentNumber?: string;
-  expires?: Date;
-  meta?: any;
-  payment: {
-    paymentProviderId?: string;
-    context?: any;
-  };
-  periods: Array<EnrollmentPeriod>;
-  productId: string;
-  quantity?: number;
-  status: string;
-  userId: string;
-} & LogFields &
-  TimestampFields;
-
-// Director
-
-export type EnrollmentContext = {
-  enrollment: Enrollment;
-};
-
-export interface EnrollmentAdapterActions {
-  configurationForOrder: (params: {
-    period: EnrollmentPeriod;
-    products: Array<Product>;
-  }) => Promise<any>;
-  isOverdue: () => Promise<boolean>;
-  isValidForActivation: () => Promise<boolean>;
-  nextPeriod: () => Promise<EnrollmentPeriod>;
-}
-
-export type IEnrollmentAdapter = IBaseAdapter & {
-  isActivatedFor: (productPlan?: ProductPlan) => boolean;
-
-  transformOrderItemToEnrollmentPlan: (
-    orderPosition: OrderPosition,
-    unchainedAPI: UnchainedCore,
-  ) => Promise<EnrollmentPlan>;
-
-  actions: (params: EnrollmentContext & UnchainedCore) => EnrollmentAdapterActions;
-};
-
-export interface EnrollmentData {
-  billingAddress: Address;
-  configuration?: Array<{ key: string; value: string }>;
-  contact: Contact;
-  countryCode?: string;
-  currencyCode?: string;
-  delivery: Enrollment['delivery'];
-  meta?: any;
-  orderIdForFirstPeriod?: string;
-  payment: Enrollment['payment'];
-  productId: string;
-  quantity: number;
-  userId: string;
-}
-
-export type IEnrollmentDirector = IBaseDirector<IEnrollmentAdapter> & {
-  transformOrderItemToEnrollment: (
-    item: { orderPosition: OrderPosition; product: Product },
-    doc: Omit<EnrollmentData, 'configuration' | 'productId' | 'quantity'>,
-    unchainedAPI: UnchainedCore,
-  ) => Promise<EnrollmentData>;
-
-  actions: (
-    enrollmentContext: EnrollmentContext,
-    unchainedAPI: UnchainedCore,
-  ) => Promise<EnrollmentAdapterActions>;
-};