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

package/src/module/configureQuotationsModule.ts

@@ -1,6 +1,5 @@
 import { SortDirection, SortOption } from '@unchainedshop/utils';
-import { UnchainedCore } from '@unchainedshop/core';
-import { Quotation, QuotationItemConfiguration, QuotationProposal } from '../types.js';
+import { Quotation, QuotationStatus } from '../db/QuotationsCollection.js';
 import { emit, registerEvents } from '@unchainedshop/events';
 import {
   generateDbFilterById,
@@ -10,81 +9,18 @@ import {
   ModuleInput,
 } from '@unchainedshop/mongodb';
 import { QuotationsCollection } from '../db/QuotationsCollection.js';
-import { QuotationStatus } from '../db/QuotationStatus.js';
-import { QuotationDirector } from '../quotations-index.js';
 import { quotationsSettings, QuotationsSettingsOptions } from '../quotations-settings.js';
-import { resolveBestCurrency } from '@unchainedshop/utils';
 
 export type QuotationQuery = {
   userId?: string;
   queryString?: string;
 };
-export interface QuotationQueries {
-  findQuotation: (query: { quotationId: string }, options?: mongodb.FindOptions) => Promise<Quotation>;
-  findQuotations: (
-    query: QuotationQuery & {
-      limit?: number;
-      offset?: number;
-      sort?: Array<SortOption>;
-    },
-    options?: mongodb.FindOptions,
-  ) => Promise<Array<Quotation>>;
-  count: (query: QuotationQuery) => Promise<number>;
-  openQuotationWithProduct: (param: { productId: string }) => Promise<Quotation | null>;
-}
-
-// Transformations
-
-export interface QuotationTransformations {
-  isExpired: (quotation: Quotation, params?: { referenceDate: Date }) => boolean;
-  isProposalValid: (quotation: Quotation) => boolean;
-  normalizedStatus: (quotation: Quotation) => string;
-}
-
-// Processing
-
-export type QuotationContextParams = (
-  quotation: Quotation,
-  params: { quotationContext?: any },
-  unchainedAPI: UnchainedCore,
-) => Promise<Quotation>;
-
-// Mutations
 export interface QuotationData {
   configuration?: Array<{ key: string; value: string }>;
   countryCode?: string;
   productId: string;
   userId: string;
 }
-export interface QuotationMutations {
-  create: (doc: QuotationData, unchainedAPI: UnchainedCore) => Promise<Quotation>;
-
-  updateContext: (quotationId: string, context: any) => Promise<Quotation | null>;
-
-  updateProposal: (quotationId: string, proposal: QuotationProposal) => Promise<Quotation>;
-
-  updateStatus: (
-    quotationId: string,
-    params: { status: QuotationStatus; info?: string },
-  ) => Promise<Quotation>;
-}
-
-export interface QuotationProcessing {
-  fullfillQuotation: (quotationId: string, info: any, unchainedAPI: UnchainedCore) => Promise<Quotation>;
-  proposeQuotation: QuotationContextParams;
-  rejectQuotation: QuotationContextParams;
-  verifyQuotation: QuotationContextParams;
-  transformItemConfiguration: (
-    quotation: Quotation,
-    configuration: QuotationItemConfiguration,
-    unchainedAPI: UnchainedCore,
-  ) => Promise<QuotationItemConfiguration>;
-}
-
-export type QuotationsModule = QuotationQueries &
-  QuotationTransformations &
-  QuotationProcessing &
-  QuotationMutations;
 
 const QUOTATION_EVENTS: string[] = ['QUOTATION_REQUEST_CREATE', 'QUOTATION_REMOVE', 'QUOTATION_UPDATE'];
 
@@ -100,17 +36,10 @@ export const buildFindSelector = (query: QuotationQuery = {}) => {
   return selector;
 };
 
-const isExpired: QuotationsModule['isExpired'] = (quotation, { referenceDate }) => {
-  const relevantDate = referenceDate ? new Date(referenceDate) : new Date();
-  const expiryDate = new Date(quotation.expires);
-  const isQuotationExpired = relevantDate.getTime() > expiryDate.getTime();
-  return isQuotationExpired;
-};
-
 export const configureQuotationsModule = async ({
   db,
   options: quotationsOptions = {},
-}: ModuleInput<QuotationsSettingsOptions>): Promise<QuotationsModule> => {
+}: ModuleInput<QuotationsSettingsOptions>) => {
   registerEvents(QUOTATION_EVENTS);
 
   quotationsSettings.configureSettings(quotationsOptions);
@@ -125,27 +54,10 @@ export const configureQuotationsModule = async ({
     return findNewQuotationNumber(quotation, index + 1);
   };
 
-  const findNextStatus = async (
-    quotation: Quotation,
-    unchainedAPI: UnchainedCore,
-  ): Promise<QuotationStatus> => {
-    let status = quotation.status as QuotationStatus;
-    const director = await QuotationDirector.actions({ quotation }, unchainedAPI);
-
-    if (status === QuotationStatus.REQUESTED) {
-      if (!(await director.isManualRequestVerificationRequired())) {
-        status = QuotationStatus.PROCESSING;
-      }
-    }
-    if (status === QuotationStatus.PROCESSING) {
-      if (!(await director.isManualProposalRequired())) {
-        status = QuotationStatus.PROPOSED;
-      }
-    }
-    return status;
-  };
-
-  const updateStatus: QuotationsModule['updateStatus'] = async (quotationId, { status, info = '' }) => {
+  const updateStatus = async (
+    quotationId: string,
+    { status, info = '' }: { status: QuotationStatus; info?: string },
+  ): Promise<Quotation> => {
     const selector = generateDbFilterById(quotationId);
     const quotation = await Quotations.findOne(selector, {});
 
@@ -197,66 +109,9 @@ export const configureQuotationsModule = async ({
     return updatedQuotation;
   };
 
-  const processQuotation = async (
-    initialQuotation: Quotation,
-    params: { quotationContext?: any },
-    unchainedAPI: UnchainedCore,
-  ) => {
-    const { modules } = unchainedAPI;
-
-    const quotationId = initialQuotation._id;
-    let quotation = initialQuotation;
-    let nextStatus = await findNextStatus(quotation, unchainedAPI);
-    const director = await QuotationDirector.actions({ quotation }, unchainedAPI);
-
-    if (quotation.status === QuotationStatus.REQUESTED && nextStatus !== QuotationStatus.REQUESTED) {
-      await director.submitRequest(params.quotationContext);
-    }
-
-    quotation = await modules.quotations.findQuotation({ quotationId });
-    nextStatus = await findNextStatus(quotation, unchainedAPI);
-    if (nextStatus !== QuotationStatus.PROCESSING) {
-      await director.verifyRequest(params.quotationContext);
-    }
-
-    quotation = await modules.quotations.findQuotation({ quotationId });
-    nextStatus = await findNextStatus(quotation, unchainedAPI);
-    if (nextStatus === QuotationStatus.REJECTED) {
-      await director.rejectRequest(params.quotationContext);
-    }
-
-    quotation = await modules.quotations.findQuotation({ quotationId });
-    nextStatus = await findNextStatus(quotation, unchainedAPI);
-    if (nextStatus === QuotationStatus.PROPOSED) {
-      const proposal = await director.quote();
-      quotation = await modules.quotations.updateProposal(quotation._id, proposal);
-      nextStatus = await findNextStatus(quotation, unchainedAPI);
-    }
-
-    return updateStatus(quotation._id, { status: nextStatus, info: 'quotation processed' });
-  };
-
-  const sendStatusToCustomer = async (quotation: Quotation, unchainedAPI: UnchainedCore) => {
-    const { modules } = unchainedAPI;
-
-    const user = await modules.users.findUserById(quotation.userId);
-    const locale = modules.users.userLocale(user);
-
-    await modules.worker.addWork({
-      type: 'MESSAGE',
-      retries: 0,
-      input: {
-        locale,
-        template: 'QUOTATION_STATUS',
-        quotationId: quotation._id,
-      },
-    });
-
-    return quotation;
-  };
-
   const updateQuotationFields =
-    (fieldKeys: Array<string>) => async (quotationId: string, values: any) => {
+    (fieldKeys: Array<string>) =>
+    async (quotationId: string, values: any): Promise<Quotation> => {
       const quotation = await Quotations.findOneAndUpdate(generateDbFilterById(quotationId), {
         $set: {
           updated: new Date(),
@@ -271,23 +126,38 @@ export const configureQuotationsModule = async ({
 
   return {
     // Queries
-    count: async (query) => {
+    count: async (query: QuotationQuery): Promise<number> => {
       const quotationCount = await Quotations.countDocuments(buildFindSelector(query));
       return quotationCount;
     },
-    openQuotationWithProduct: async ({ productId }) => {
+    openQuotationWithProduct: async ({ productId }: { productId: string }): Promise<Quotation> => {
       const selector: mongodb.Filter<Quotation> = { productId };
       selector.status = { $in: [QuotationStatus.REQUESTED, QuotationStatus.PROPOSED] };
 
       return Quotations.findOne(selector);
     },
 
-    findQuotation: async ({ quotationId }, options) => {
+    findQuotation: async (
+      { quotationId }: { quotationId: string },
+      options?: mongodb.FindOptions<Quotation>,
+    ): Promise<Quotation> => {
       const selector = generateDbFilterById(quotationId);
       return Quotations.findOne(selector, options);
     },
 
-    findQuotations: async ({ limit, offset, sort, ...query }, options) => {
+    findQuotations: async (
+      {
+        limit,
+        offset,
+        sort,
+        ...query
+      }: QuotationQuery & {
+        limit?: number;
+        offset?: number;
+        sort?: Array<SortOption>;
+      },
+      options?: mongodb.FindOptions<Quotation>,
+    ): Promise<Array<Quotation>> => {
       const defaultSortOption: Array<SortOption> = [{ key: 'created', value: SortDirection.ASC }];
       const quotations = Quotations.find(buildFindSelector(query), {
         limit,
@@ -300,87 +170,29 @@ export const configureQuotationsModule = async ({
     },
 
     // Transformations
-    normalizedStatus: (quotation) => {
+    normalizedStatus: (quotation: Quotation): QuotationStatus => {
       return quotation.status === null
         ? QuotationStatus.REQUESTED
         : (quotation.status as QuotationStatus);
     },
 
-    isExpired,
-
-    isProposalValid: (quotation) => {
-      return quotation.status === QuotationStatus.PROPOSED && !isExpired(quotation);
-    },
-
-    // Processing
-    fullfillQuotation: async (quotationId, info, unchainedAPI) => {
-      const selector = generateDbFilterById(quotationId);
-      const quotation = await Quotations.findOne(selector, {});
-
-      if (quotation.status === QuotationStatus.FULLFILLED) return quotation;
-
-      let updatedQuotation = await updateStatus(quotation._id, {
-        status: QuotationStatus.FULLFILLED,
-        info: JSON.stringify(info),
-      });
-
-      updatedQuotation = await processQuotation(updatedQuotation, {}, unchainedAPI);
-
-      return sendStatusToCustomer(updatedQuotation, unchainedAPI);
+    isExpired(quotation: Quotation, { referenceDate }: { referenceDate: Date }) {
+      const relevantDate = referenceDate ? new Date(referenceDate) : new Date();
+      const expiryDate = new Date(quotation.expires);
+      const isQuotationExpired = relevantDate.getTime() > expiryDate.getTime();
+      return isQuotationExpired;
     },
 
-    proposeQuotation: async (quotation, { quotationContext }, unchainedAPI) => {
-      if (quotation.status !== QuotationStatus.PROCESSING) return quotation;
-
-      let updatedQuotation = await updateStatus(quotation._id, {
-        status: QuotationStatus.PROPOSED,
-        info: 'proposed manually',
-      });
-
-      updatedQuotation = await processQuotation(updatedQuotation, { quotationContext }, unchainedAPI);
-
-      return sendStatusToCustomer(updatedQuotation, unchainedAPI);
-    },
-
-    rejectQuotation: async (quotation, { quotationContext }, unchainedAPI) => {
-      if (quotation.status === QuotationStatus.FULLFILLED) return quotation;
-
-      let updatedQuotation = await updateStatus(quotation._id, {
-        status: QuotationStatus.REJECTED,
-        info: 'rejected manually',
-      });
-
-      updatedQuotation = await processQuotation(updatedQuotation, { quotationContext }, unchainedAPI);
-
-      return sendStatusToCustomer(updatedQuotation, unchainedAPI);
-    },
-
-    verifyQuotation: async (quotation, { quotationContext }, unchainedAPI) => {
-      if (quotation.status !== QuotationStatus.REQUESTED) return quotation;
-
-      let updatedQuotation = await updateStatus(quotation._id, {
-        status: QuotationStatus.PROCESSING,
-        info: 'verified elligibility manually',
-      });
-
-      updatedQuotation = await processQuotation(updatedQuotation, { quotationContext }, unchainedAPI);
-
-      return sendStatusToCustomer(updatedQuotation, unchainedAPI);
-    },
-
-    transformItemConfiguration: async (quotation, configuration, unchainedAPI) => {
-      const director = await QuotationDirector.actions({ quotation }, unchainedAPI);
-      return director.transformItemConfiguration(configuration);
+    isProposalValid(quotation: Quotation): boolean {
+      return quotation.status === QuotationStatus.PROPOSED && !this.isExpired(quotation);
     },
 
     // Mutations
-    create: async ({ countryCode, ...quotationData }, unchainedAPI) => {
-      const { modules } = unchainedAPI;
-
-      const countryObject = await modules.countries.findCountry({ isoCode: countryCode });
-      const currencies = await modules.currencies.findCurrencies({ includeInactive: false });
-      const currency = resolveBestCurrency(countryObject.defaultCurrencyCode, currencies);
-
+    create: async ({
+      countryCode,
+      currency,
+      ...quotationData
+    }: QuotationData & { currency: string }): Promise<Quotation> => {
       const { insertedId: quotationId } = await Quotations.insertOne({
         _id: generateDbObjectId(),
         created: new Date(),
@@ -392,20 +204,24 @@ export const configureQuotationsModule = async ({
         status: QuotationStatus.REQUESTED,
       });
 
-      const newQuotation = await Quotations.findOne(generateDbFilterById(quotationId), {});
-
-      let quotation = await processQuotation(newQuotation, {}, unchainedAPI);
-
-      quotation = await sendStatusToCustomer(quotation, unchainedAPI);
+      const quotation = await Quotations.findOne(generateDbFilterById(quotationId), {});
 
       await emit('QUOTATION_REQUEST_CREATE', { quotation });
 
       return quotation;
     },
-
+    deleteRequestedUserQuotations: async (userId: string) => {
+      const { deletedCount } = await Quotations.deleteMany({
+        userId,
+        status: { $in: [QuotationStatus.REQUESTED, null] },
+      });
+      return deletedCount;
+    },
     updateContext: updateQuotationFields(['context']),
     updateProposal: updateQuotationFields(['price', 'expires', 'meta']),
 
     updateStatus,
   };
 };
+
+export type QuotationsModule = Awaited<ReturnType<typeof configureQuotationsModule>>;

package/src/quotations-index.ts

@@ -1,10 +1,4 @@
-export * from './types.js';
+export * from './db/QuotationsCollection.js';
+
 export * from './module/configureQuotationsModule.js';
 export * from './quotations-settings.js';
-
-export { QuotationStatus } from './db/QuotationStatus.js';
-
-export { QuotationAdapter } from './director/QuotationAdapter.js';
-export { QuotationDirector } from './director/QuotationDirector.js';
-
-export { QuotationError } from './director/QuotationError.js';

package/src/quotations-settings.ts

@@ -1,5 +1,5 @@
 import { generateRandomHash } from '@unchainedshop/utils';
-import { Quotation } from './types.js';
+import { Quotation } from './db/QuotationsCollection.js';
 
 export interface QuotationsSettingsOptions {
   quotationNumberHashFn?: (quotation: Quotation, index: number) => string;

package/tsconfig.json

@@ -1,11 +1,9 @@
 {
   "extends": "../shared/base.tsconfig.json",
   "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "lib",
+    "declarationDir": "./lib",
+    "rootDir": "./src",
+    "outDir": "./lib"
   },
-  "exclude": ["**/*.test.ts", "**/*.test.js", "tests"],
-  "include": [
-    "./src"
-  ]
-}
+  "exclude": ["**/*.test.ts", "**/*.test.js", "tests", "lib"]
+}

package/src/db/QuotationStatus.ts

@@ -1,7 +0,0 @@
-export enum QuotationStatus {
-  REQUESTED = 'REQUESTED',
-  PROCESSING = 'PROCESSING',
-  PROPOSED = 'PROPOSED',
-  FULLFILLED = 'FULLFILLED',
-  REJECTED = 'REJECTED',
-}

package/src/director/QuotationAdapter.ts

@@ -1,51 +0,0 @@
-import { log, LogLevel } from '@unchainedshop/logger';
-import { IQuotationAdapter } from '../types.js';
-import { QuotationError } from './QuotationError.js';
-
-export const QuotationAdapter: Omit<IQuotationAdapter, 'key' | 'label' | 'version'> = {
-  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 };
-      },
-    };
-  },
-
-  log(message: string, { level = LogLevel.Debug, ...options } = {}) {
-    return log(message, { level, ...options });
-  },
-};

package/src/director/QuotationDirector.ts

@@ -1,99 +0,0 @@
-import { LogLevel, log } from '@unchainedshop/logger';
-import { IQuotationAdapter, IQuotationDirector, QuotationContext } from '../types.js';
-import { BaseDirector } from '@unchainedshop/utils';
-import { UnchainedCore } from '@unchainedshop/core';
-import { QuotationError } from './QuotationError.js';
-
-const baseDirector = BaseDirector<IQuotationAdapter>('QuotationDirector', {
-  adapterSortKey: 'orderIndex',
-});
-
-const findAppropriateAdapters = (quotationContext: QuotationContext, unchainedAPI: UnchainedCore) =>
-  baseDirector.getAdapters({
-    adapterFilter: (Adapter: IQuotationAdapter) => {
-      const activated = Adapter.isActivatedFor(quotationContext, unchainedAPI);
-      if (!activated) {
-        log(`Quotation Director -> ${Adapter.key} (${Adapter.version}) skipped`, {
-          level: LogLevel.Warning,
-        });
-      }
-      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) {
-          log('QuotationDirector -> Error while checking for configurationError', {
-            level: LogLevel.Warning,
-            ...error,
-          });
-          return QuotationError.ADAPTER_NOT_FOUND;
-        }
-      },
-
-      isManualRequestVerificationRequired: async () => {
-        try {
-          const isRequired = await adapter.isManualRequestVerificationRequired();
-          return isRequired;
-        } catch (error) {
-          log('QuotationDirector -> Error while checking if is manual request verification required', {
-            level: LogLevel.Error,
-            ...error,
-          });
-          return null;
-        }
-      },
-
-      isManualProposalRequired: async () => {
-        try {
-          const isRequired = await adapter.isManualProposalRequired();
-          return isRequired;
-        } catch (error) {
-          log('QuotationDirector -> Error while checking if is manual proposal required', {
-            level: LogLevel.Error,
-            ...error,
-          });
-          return null;
-        }
-      },
-
-      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) {
-          log('QuotationDirector -> Error while transforming item configuration', {
-            level: LogLevel.Error,
-            ...error,
-          });
-          return null;
-        }
-      },
-    };
-  },
-};

package/src/director/QuotationError.ts

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

package/src/types.ts

@@ -1,74 +0,0 @@
-import type { IBaseAdapter, IBaseDirector } from '@unchainedshop/utils';
-import type { TimestampFields, LogFields } from '@unchainedshop/mongodb';
-import type { UnchainedCore } from '@unchainedshop/core';
-
-export enum QuotationStatus {
-  REQUESTED = 'REQUESTED',
-  PROCESSING = 'PROCESSING',
-  PROPOSED = 'PROPOSED',
-  FULLFILLED = 'FULLFILLED',
-  REJECTED = 'REJECTED',
-}
-
-export enum QuotationError {
-  ADAPTER_NOT_FOUND = 'ADAPTER_NOT_FOUND',
-  NOT_IMPLEMENTED = 'NOT_IMPLEMENTED',
-  INCOMPLETE_CONFIGURATION = 'INCOMPLETE_CONFIGURATION',
-  WRONG_CREDENTIALS = 'WRONG_CREDENTIALS',
-}
-
-export type Quotation = {
-  _id?: string;
-  configuration?: Array<{ key: string; value: string }>;
-  context?: any;
-  countryCode?: string;
-  currency?: string;
-  expires?: Date;
-  fullfilled?: Date;
-  meta?: any;
-  price?: number;
-  productId: string;
-  quotationNumber?: string;
-  rejected?: Date;
-  status: string;
-  userId: string;
-} & LogFields &
-  TimestampFields;
-
-export type QuotationProposal = { price?: number; expires?: Date; meta?: any };
-
-export interface QuotationItemConfiguration {
-  quantity?: number;
-  configuration: Array<{ key: string; value: string }>;
-}
-
-export type QuotationContext = {
-  quotation?: Quotation;
-};
-
-export interface QuotationAdapterActions {
-  configurationError: () => QuotationError;
-  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>;
-}
-
-export type IQuotationAdapter = IBaseAdapter & {
-  orderIndex: number;
-  isActivatedFor: (quotationContext: QuotationContext, unchainedAPI: UnchainedCore) => boolean;
-  actions: (params: QuotationContext & UnchainedCore) => QuotationAdapterActions;
-};
-
-export type IQuotationDirector = IBaseDirector<IQuotationAdapter> & {
-  actions: (
-    quotationContext: QuotationContext,
-    unchainedAPI: UnchainedCore,
-  ) => Promise<QuotationAdapterActions>;
-};