@unchainedshop/core 4.3.6 → 4.4.0

package/src/directors/WorkerDirector.ts

@@ -1,149 +0,0 @@
-import { Work, WorkData, WorkResult } from '@unchainedshop/core-worker';
-import { BaseDirector, IBaseDirector } from '@unchainedshop/utils';
-import { ScheduleData } from '@breejs/later';
-import { IWorkerAdapter } from './WorkerAdapter.js';
-import { Modules } from '../modules.js';
-import { createLogger } from '@unchainedshop/logger';
-
-const logger = createLogger('unchained:core');
-
-export type WorkScheduleConfiguration = Pick<
-  WorkData,
-  'timeout' | 'retries' | 'priority' | 'worker' | 'scheduleId'
-> & {
-  type: string;
-  input?: (workData: Omit<WorkData, 'input'>) => Promise<Record<string, any> | null>;
-  schedule?: ScheduleData;
-  scheduleId?: string;
-};
-
-export type IWorkerDirector = IBaseDirector<IWorkerAdapter<any, any>> & {
-  getActivePluginTypes: (options?: { external?: boolean }) => string[];
-  getAdapterByType: (type: string) => IWorkerAdapter<any, any>;
-  disableAutoscheduling: (scheduleId: string) => void;
-  configureAutoscheduling: (workScheduleConfiguration: WorkScheduleConfiguration) => void;
-  getAutoSchedules: () => [string, WorkScheduleConfiguration][];
-  doWork: (work: Work, unchainedAPI) => Promise<WorkResult>;
-  processNextWork: (unchainedAPI: { modules: Modules }, workerId?: string) => Promise<Work | null>;
-};
-
-const AutoScheduleMap = new Map<string, WorkScheduleConfiguration>();
-
-const baseDirector = BaseDirector<IWorkerAdapter<any, any>>('WorkerDirector', {
-  adapterKeyField: 'key',
-});
-
-export const WorkerDirector: IWorkerDirector = {
-  ...baseDirector,
-
-  getActivePluginTypes: ({ external } = {}) => {
-    return WorkerDirector.getAdapters()
-      .filter((adapter) => {
-        if (external === null || external === undefined) return true;
-        return Boolean(adapter.external) === external;
-      })
-      .map((adapter) => adapter.type);
-  },
-
-  registerAdapter: (Adapter) => {
-    if (WorkerDirector.getAdapterByType(Adapter.type))
-      throw new Error(
-        `WorkerDirector: There is already a adapter registered with type: ${Adapter.type}`,
-      );
-
-    baseDirector.registerAdapter(Adapter);
-  },
-
-  disableAutoscheduling: (type) => {
-    AutoScheduleMap.delete(type);
-  },
-
-  unregisterAdapter: (key) => {
-    const adapter = WorkerDirector.getAdapter(key);
-    const result = baseDirector.unregisterAdapter(key);
-    if (adapter) {
-      AutoScheduleMap.forEach((workItemConfiguration, scheduleId) => {
-        if (workItemConfiguration.type === adapter.type) {
-          AutoScheduleMap.delete(scheduleId);
-        }
-      });
-    }
-    return result;
-  },
-
-  configureAutoscheduling: (workItemConfiguration) => {
-    AutoScheduleMap.set(
-      workItemConfiguration.scheduleId || workItemConfiguration.type,
-      workItemConfiguration,
-    );
-  },
-
-  getAutoSchedules: () => Array.from(AutoScheduleMap),
-
-  getAdapterByType: (type: string) => {
-    const adapters = WorkerDirector.getAdapters({
-      adapterFilter: (Adapter) => {
-        return type === Adapter.type;
-      },
-    });
-    return adapters?.[0];
-  },
-
-  doWork: async ({ type, input, _id: workId }, unchainedAPI) => {
-    const adapter = WorkerDirector.getAdapterByType(type);
-
-    if (!adapter) {
-      logger.warn(`WorkerDirector: No registered adapter for type: ${type}`);
-    }
-
-    try {
-      const output = await adapter.doWork(input, unchainedAPI, workId);
-      return output;
-    } catch (error) {
-      // DO not use this as flow control. The adapter should catch expected errors and return status: FAILED
-      logger.debug('DO not use this as flow control.');
-      logger.error(`WorkerDirector -> Error doing work ${type}: ${error.message}`);
-
-      const errorOutput = { error, success: false };
-      return errorOutput;
-    }
-  },
-
-  processNextWork: async (unchainedAPI: { modules: Modules }, workerId?: string) => {
-    const adapters = WorkerDirector.getAdapters();
-
-    const allocationMap = await unchainedAPI.modules.worker.allocationMap();
-
-    const types = adapters
-      .filter((adapter) => {
-        // Filter out the external
-        if (adapter.external) return false;
-        if (
-          adapter.maxParallelAllocations &&
-          adapter.maxParallelAllocations <= allocationMap[adapter.type]
-        )
-          return false;
-        return true;
-      })
-      .map((adapter) => adapter.type);
-
-    const worker = workerId ?? unchainedAPI.modules.worker.workerId;
-    const work = await unchainedAPI.modules.worker.allocateWork({
-      types,
-      worker,
-    });
-
-    if (work) {
-      const output = await WorkerDirector.doWork(work, unchainedAPI);
-
-      return await unchainedAPI.modules.worker.finishWork(work._id, {
-        ...output,
-        finished: work.finished || new Date(),
-        started: work.started,
-        worker,
-      });
-    }
-
-    return null;
-  },
-};

package/src/directors/index.ts

@@ -1,53 +0,0 @@
-export * from './BasePricingAdapter.js';
-export * from './BasePricingDirector.js';
-export * from './BasePricingSheet.js';
-
-export * from './BaseDiscountAdapter.js';
-export * from './BaseDiscountDirector.js';
-
-export * from './DeliveryAdapter.js';
-export * from './DeliveryDirector.js';
-export * from './DeliveryPricingAdapter.js';
-export * from './DeliveryPricingDirector.js';
-export * from './DeliveryPricingSheet.js';
-
-export * from './PaymentAdapter.js';
-export * from './PaymentDirector.js';
-export * from './PaymentPricingAdapter.js';
-export * from './PaymentPricingDirector.js';
-export * from './PaymentPricingSheet.js';
-
-export * from './EnrollmentAdapter.js';
-export * from './EnrollmentDirector.js';
-
-export * from './FilterAdapter.js';
-export * from './FilterDirector.js';
-
-export * from './ProductDiscountAdapter.js';
-export * from './ProductDiscountDirector.js';
-export * from './ProductDiscountConfiguration.js';
-export * from './ProductPricingAdapter.js';
-export * from './ProductPricingDirector.js';
-export * from './ProductPricingSheet.js';
-
-export * from './OrderDiscountConfiguration.js';
-export * from './OrderDiscountAdapter.js';
-export * from './OrderDiscountDirector.js';
-export * from './OrderPricingAdapter.js';
-export * from './OrderPricingDirector.js';
-export * from './OrderPricingSheet.js';
-
-export * from './WarehousingDirector.js';
-export * from './WarehousingAdapter.js';
-
-export * from './WorkerAdapter.js';
-export * from './WorkerDirector.js';
-export * from './EventListenerWorker.js';
-export * from './IntervalWorker.js';
-export * from './FailedRescheduler.js';
-export * from './BaseWorker.js';
-
-export * from './QuotationAdapter.js';
-export * from './QuotationDirector.js';
-
-export * from './MessagingDirector.js';

package/src/directors/periodForReferenceDate.test.ts

@@ -1,25 +0,0 @@
-import { describe, it } from 'node:test';
-import { periodForReferenceDate } from './EnrollmentAdapter.js';
-import assert from 'node:assert';
-
-describe('periodForReferenceDate', () => {
-  it('Should return 1 week interval from When passed a given date', () => {
-    assert.deepStrictEqual(periodForReferenceDate(new Date('2022-12-03T17:00:00.000Z')), {
-      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', () => {
-    assert.deepStrictEqual(periodForReferenceDate(new Date('2022-12-03T17:00:00.000Z'), 2), {
-      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', () => {
-    assert.deepStrictEqual(periodForReferenceDate(new Date('2022-12-03T17:00:00.000Z'), 2, 'HOURS'), {
-      start: new Date('2022-12-03T17:00:00.000Z'),
-      end: new Date('2022-12-03T19:00:00.000Z'),
-    });
-  });
-});

package/src/factory/index.ts

@@ -1,21 +0,0 @@
-import registerProductDiscoverabilityFilter from './registerProductDiscoverabilityFilter.js';
-import registerPickUpDelivery from './registerPickUpDelivery.js';
-import registerShippingDelivery from './registerShippingDelivery.js';
-import registerWorker from './registerWorker.js';
-import registerPhysicalWarehousing from './registerPhysicalWarehousing.js';
-import registerVirtualWarehousing from './registerVirtualWarehousing.js';
-import registerProductSearchFilter from './registerProductSearchFilter.js';
-import registerAssortmentSearchFilter from './registerAssortmentSearchFilter.js';
-import registerInvoicePayment from './registerInvoicePayment.js';
-
-export {
-  registerProductDiscoverabilityFilter,
-  registerPickUpDelivery,
-  registerShippingDelivery,
-  registerInvoicePayment,
-  registerWorker,
-  registerPhysicalWarehousing,
-  registerVirtualWarehousing,
-  registerProductSearchFilter,
-  registerAssortmentSearchFilter,
-};

package/src/factory/registerAssortmentSearchFilter.ts

@@ -1,36 +0,0 @@
-import { SearchQuery } from '@unchainedshop/core-filters';
-import { FilterAdapter, FilterDirector } from '../core-index.js';
-
-export default function registerAssortmentSearchFilter({
-  orderIndex = 0,
-  search,
-}: {
-  orderIndex?: number;
-  search: (params: SearchQuery & { queryString: string; locale: Intl.Locale }) => Promise<string[]>;
-}) {
-  FilterDirector.registerAdapter({
-    ...FilterAdapter,
-
-    key: `shop.unchained.filters.assortment-search-${crypto.randomUUID()}`,
-    label: 'Assortment Search Filter (auto-generated)',
-    version: '1.0.0',
-    orderIndex,
-
-    actions: (params) => {
-      return {
-        ...FilterAdapter.actions(params),
-
-        async searchAssortments({ assortmentIds }, { locale }) {
-          const { queryString, ...rest } = params.searchQuery;
-          if (!queryString) return assortmentIds;
-
-          const restrictedAssortmentIds = new Set(assortmentIds || []);
-          const foundAssortmentIds = await search({ ...rest, queryString, locale });
-          return foundAssortmentIds.filter(
-            restrictedAssortmentIds.size === 0 ? Boolean : (id) => restrictedAssortmentIds.has(id),
-          );
-        },
-      };
-    },
-  });
-}

package/src/factory/registerInvoicePayment.ts

@@ -1,61 +0,0 @@
-import { PaymentConfiguration } from '@unchainedshop/core-payment';
-import {
-  PaymentContext,
-  PaymentAdapter,
-  PaymentDirector,
-  PaymentChargeActionResult,
-} from '../core-index.js';
-import { PaymentProviderType } from '@unchainedshop/core-payment';
-
-export default function registerInvoicePayment({
-  adapterId,
-  active,
-  payLaterAllowed,
-  charge,
-}: {
-  adapterId: string;
-  active?: boolean;
-  payLaterAllowed?: boolean;
-  charge:
-    | false
-    | ((
-        configuration: PaymentConfiguration,
-        context: PaymentContext,
-      ) => Promise<PaymentChargeActionResult | false>);
-}) {
-  PaymentDirector.registerAdapter({
-    ...PaymentAdapter,
-
-    key: `shop.unchained.payment.invoice-${adapterId}`,
-    label: 'Invoice Payment: ' + adapterId,
-    version: '1.0.0',
-
-    initialConfiguration: [],
-
-    typeSupported: (type) => {
-      return type === PaymentProviderType.INVOICE;
-    },
-
-    actions: (config, context) => {
-      return {
-        ...PaymentAdapter.actions(config, context),
-
-        isActive: () => {
-          return active ?? true;
-        },
-
-        isPayLaterAllowed() {
-          return payLaterAllowed ?? false;
-        },
-
-        configurationError: () => {
-          return null;
-        },
-
-        charge: async () => {
-          return typeof charge === 'function' ? await charge(config, context) : charge;
-        },
-      };
-    },
-  });
-}

package/src/factory/registerPhysicalWarehousing.ts

@@ -1,92 +0,0 @@
-import { WarehousingConfiguration, WarehousingProviderType } from '@unchainedshop/core-warehousing';
-import { WarehousingAdapter, WarehousingContext, WarehousingDirector } from '../core-index.js';
-
-export default function registerPhysicalWarehousing({
-  adapterId,
-  orderIndex = 0,
-  stock,
-  productionTime,
-  commissioningTime,
-}: {
-  adapterId: string;
-  orderIndex?: number;
-  stock?:
-    | number
-    | ((
-        referenceDate: Date,
-        configuration: WarehousingConfiguration,
-        context: WarehousingContext,
-      ) => Promise<number>);
-
-  productionTime?:
-    | number
-    | ((
-        quantityToProduct: number,
-        configuration: WarehousingConfiguration,
-        context: WarehousingContext,
-      ) => Promise<number>);
-
-  commissioningTime?:
-    | number
-    | ((
-        quantity: number,
-        configuration: WarehousingConfiguration,
-        context: WarehousingContext,
-      ) => Promise<number>);
-}) {
-  WarehousingDirector.registerAdapter({
-    ...WarehousingAdapter,
-
-    key: 'shop.unchained.warehousing.physical.' + adapterId,
-    label: 'Physical Warehousing: ' + adapterId,
-    version: '1.0.0',
-    orderIndex,
-
-    initialConfiguration: [{ key: 'shipping-hub', value: 'Shipping Hub' }],
-
-    typeSupported: (type) => {
-      return type === WarehousingProviderType.PHYSICAL;
-    },
-
-    actions: (configuration, context) => {
-      return {
-        ...WarehousingAdapter.actions(configuration, context),
-
-        isActive() {
-          return true;
-        },
-
-        configurationError() {
-          return null;
-        },
-
-        stock: async (referenceDate) => {
-          if (typeof stock === 'number') {
-            return stock;
-          } else if (typeof stock === 'function') {
-            return stock(referenceDate, configuration, context);
-          }
-          return 99999;
-        },
-
-        productionTime: async (quantityToProduct: number) => {
-          if (typeof productionTime === 'number') {
-            return productionTime;
-          } else if (typeof productionTime === 'function') {
-            return productionTime(quantityToProduct, configuration, context);
-          }
-          return 0;
-        },
-
-        commissioningTime: async (quantity: number) => {
-          if (typeof commissioningTime === 'number') {
-            return commissioningTime;
-          } else if (typeof commissioningTime === 'function') {
-            return commissioningTime(quantity, configuration, context);
-          }
-          return 0;
-        },
-      };
-    },
-  });
-}

package/src/factory/registerPickUpDelivery.ts

@@ -1,81 +0,0 @@
-import {
-  DeliveryConfiguration,
-  DeliveryLocation,
-  DeliveryProviderType,
-} from '@unchainedshop/core-delivery';
-import { DeliveryAdapter, DeliveryContext, DeliveryDirector } from '../core-index.js';
-import { Work } from '@unchainedshop/core-worker';
-
-export default function registerPickUpDelivery({
-  adapterId,
-  locations,
-  active,
-  autoReleaseAllowed,
-  estimatedDeliveryThroughput,
-  send,
-}: {
-  adapterId: string;
-  active?: boolean;
-  autoReleaseAllowed?: boolean;
-  estimatedDeliveryThroughput?: (
-    warehousingThroughputTime: number,
-    context: DeliveryContext,
-  ) => Promise<number | null>;
-  send:
-    | boolean
-    | ((configuration: DeliveryConfiguration, context: DeliveryContext) => Promise<boolean | Work>);
-  locations: DeliveryLocation[] | ((context: DeliveryContext) => Promise<DeliveryLocation[]>);
-}) {
-  DeliveryDirector.registerAdapter({
-    ...DeliveryAdapter,
-
-    key: `shop.unchained.delivery.pickup-${adapterId}`,
-    label: 'PickUp Delivery: ' + adapterId,
-    version: '1.0.0',
-
-    initialConfiguration: [],
-
-    typeSupported: (type) => {
-      return type === DeliveryProviderType.PICKUP;
-    },
-
-    actions: (config, context) => {
-      return {
-        ...DeliveryAdapter.actions(config, context),
-
-        isActive: () => {
-          return active ?? true;
-        },
-
-        isAutoReleaseAllowed: () => {
-          return autoReleaseAllowed ?? true;
-        },
-
-        configurationError: () => {
-          return null;
-        },
-
-        pickUpLocationById: async (id) => {
-          const result = typeof locations === 'function' ? await locations(context) : locations;
-          return result.find((location) => location._id === id) || null;
-        },
-
-        pickUpLocations: async () => {
-          const result = typeof locations === 'function' ? await locations(context) : locations;
-          return result;
-        },
-
-        estimatedDeliveryThroughput: async (warehousingThroughputTime) => {
-          if (estimatedDeliveryThroughput) {
-            return estimatedDeliveryThroughput(warehousingThroughputTime, context);
-          }
-          return 0;
-        },
-
-        send: async () => {
-          return typeof send === 'function' ? await send(config, context) : send;
-        },
-      };
-    },
-  });
-}

package/src/factory/registerProductDiscoverabilityFilter.ts

@@ -1,36 +0,0 @@
-import { FilterAdapter, FilterDirector } from '../core-index.js';
-
-export default function registerProductDiscoverabilityFilter({
-  orderIndex = 0,
-  hiddenTagValue = 'hidden',
-}: {
-  orderIndex?: number;
-  hiddenTagValue?: string;
-}) {
-  FilterDirector.registerAdapter({
-    ...FilterAdapter,
-
-    key: `shop.unchained.filters.product-discoverability-${crypto.randomUUID()}`,
-    label: 'Product Discoverability Filter (auto-generated)',
-    version: '1.0.0',
-    orderIndex,
-
-    actions: (params) => {
-      return {
-        ...FilterAdapter.actions(params),
-
-        transformProductSelector: async (lastSelector, options) => {
-          const { key } = options || {};
-
-          if (!key) {
-            const newSelector = { ...lastSelector };
-            if (!newSelector.$and) newSelector.$and = [];
-            newSelector.$and.push({ tags: { $ne: hiddenTagValue } });
-            return newSelector;
-          }
-          return lastSelector;
-        },
-      };
-    },
-  });
-}

package/src/factory/registerProductSearchFilter.ts

@@ -1,36 +0,0 @@
-import { SearchQuery } from '@unchainedshop/core-filters';
-import { FilterAdapter, FilterDirector } from '../core-index.js';
-
-export default function registerProductSearchFilter({
-  orderIndex = 0,
-  search,
-}: {
-  orderIndex?: number;
-  search: (params: SearchQuery & { queryString: string; locale: Intl.Locale }) => Promise<string[]>;
-}) {
-  FilterDirector.registerAdapter({
-    ...FilterAdapter,
-
-    key: `shop.unchained.filters.product-search-${crypto.randomUUID()}`,
-    label: 'Product Search Filter (auto-generated)',
-    version: '1.0.0',
-    orderIndex,
-
-    actions: (params) => {
-      return {
-        ...FilterAdapter.actions(params),
-
-        async searchProducts({ productIds }, { locale }) {
-          const { queryString, ...rest } = params.searchQuery;
-          if (!queryString) return productIds;
-
-          const restrictedProductIds = new Set(productIds || []);
-          const foundProductIds = await search({ ...rest, queryString, locale });
-          return foundProductIds.filter(
-            restrictedProductIds.size === 0 ? Boolean : (id) => restrictedProductIds.has(id),
-          );
-        },
-      };
-    },
-  });
-}

package/src/factory/registerShippingDelivery.ts

@@ -1,65 +0,0 @@
-import { DeliveryConfiguration, DeliveryProviderType } from '@unchainedshop/core-delivery';
-import { DeliveryAdapter, DeliveryContext, DeliveryDirector } from '../core-index.js';
-import { Work } from '@unchainedshop/core-worker';
-
-export default function registerShippingDelivery({
-  adapterId,
-  active,
-  autoReleaseAllowed,
-  estimatedDeliveryThroughput,
-  send,
-}: {
-  adapterId: string;
-  active?: boolean;
-  autoReleaseAllowed?: boolean;
-  estimatedDeliveryThroughput?: (
-    warehousingThroughputTime: number,
-    context: DeliveryContext,
-  ) => Promise<number | null>;
-  send:
-    | boolean
-    | ((configuration: DeliveryConfiguration, context: DeliveryContext) => Promise<boolean | Work>);
-}) {
-  DeliveryDirector.registerAdapter({
-    ...DeliveryAdapter,
-
-    key: `shop.unchained.delivery.shipping-${adapterId}`,
-    label: 'Shipping Delivery: ' + adapterId,
-    version: '1.0.0',
-
-    initialConfiguration: [],
-
-    typeSupported: (type) => {
-      return type === DeliveryProviderType.SHIPPING;
-    },
-
-    actions: (config, context) => {
-      return {
-        ...DeliveryAdapter.actions(config, context),
-
-        isActive: () => {
-          return active ?? true;
-        },
-
-        isAutoReleaseAllowed: () => {
-          return autoReleaseAllowed ?? true;
-        },
-
-        configurationError: () => {
-          return null;
-        },
-
-        estimatedDeliveryThroughput: async (warehousingThroughputTime) => {
-          if (estimatedDeliveryThroughput) {
-            return estimatedDeliveryThroughput(warehousingThroughputTime, context);
-          }
-          return 0;
-        },
-
-        send: async () => {
-          return typeof send === 'function' ? await send(config, context) : send;
-        },
-      };
-    },
-  });
-}