@unchainedshop/core-delivery 4.3.4 → 4.5.0

package/README.md

@@ -1,3 +1,89 @@
-# Delivery (Unchained Engine)
+[![npm version](https://img.shields.io/npm/v/@unchainedshop/core-delivery.svg)](https://npmjs.com/package/@unchainedshop/core-delivery)
+[![License: EUPL-1.2](https://img.shields.io/badge/License-EUPL--1.2-blue.svg)](https://opensource.org/licenses/EUPL-1.2)
 
-This package contains business logic and database abstraction for delivery in Unchained.
+# @unchainedshop/core-delivery
+
+Delivery provider module for the Unchained Engine. Manages delivery providers, shipping methods, and delivery processing.
+
+## Installation
+
+```bash
+npm install @unchainedshop/core-delivery
+```
+
+## Usage
+
+```typescript
+import { configureDeliveryModule, DeliveryProviderType } from '@unchainedshop/core-delivery';
+
+const deliveryModule = await configureDeliveryModule({ db });
+
+// Create a delivery provider
+const providerId = await deliveryModule.create({
+  type: DeliveryProviderType.SHIPPING,
+  adapterKey: 'shop.unchained.delivery.post',
+});
+
+// Find providers for a context
+const providers = await deliveryModule.findSupported({
+  order: orderObject,
+});
+```
+
+## API Overview
+
+### Module Configuration
+
+| Export | Description |
+|--------|-------------|
+| `configureDeliveryModule` | Configure and return the delivery module |
+
+### Queries
+
+| Method | Description |
+|--------|-------------|
+| `findProvider` | Find provider by ID |
+| `findProviders` | Find providers with filtering |
+| `count` | Count providers |
+| `providerExists` | Check if provider exists |
+| `findSupported` | Find providers supported for context |
+| `findInterface` | Get provider interface definition |
+
+### Mutations
+
+| Method | Description |
+|--------|-------------|
+| `create` | Create a new delivery provider |
+| `update` | Update provider configuration |
+| `delete` | Soft delete a provider |
+
+### Constants
+
+| Export | Description |
+|--------|-------------|
+| `DeliveryProviderType` | Provider types (SHIPPING, PICKUP) |
+
+### Settings
+
+| Export | Description |
+|--------|-------------|
+| `deliverySettings` | Access delivery module settings |
+
+### Types
+
+| Export | Description |
+|--------|-------------|
+| `DeliveryProvider` | Provider document type |
+| `DeliveryModule` | Module interface type |
+
+## Events
+
+| Event | Description |
+|-------|-------------|
+| `DELIVERY_PROVIDER_CREATE` | Provider created |
+| `DELIVERY_PROVIDER_UPDATE` | Provider updated |
+| `DELIVERY_PROVIDER_REMOVE` | Provider deleted |
+
+## License
+
+EUPL-1.2

package/lib/db/DeliveryProvidersCollection.d.ts

@@ -1,8 +1,9 @@
-import { mongodb, TimestampFields } from '@unchainedshop/mongodb';
-export declare enum DeliveryProviderType {
-    SHIPPING = "SHIPPING",
-    PICKUP = "PICKUP"
-}
+import { mongodb, type TimestampFields } from '@unchainedshop/mongodb';
+export declare const DeliveryProviderType: {
+    readonly SHIPPING: "SHIPPING";
+    readonly PICKUP: "PICKUP";
+};
+export type DeliveryProviderType = (typeof DeliveryProviderType)[keyof typeof DeliveryProviderType];
 export type DeliveryConfiguration = {
     key: string;
     value: string;
@@ -29,4 +30,3 @@ export interface DeliveryLocation {
     };
 }
 export declare const DeliveryProvidersCollection: (db: mongodb.Db) => Promise<mongodb.Collection<DeliveryProvider>>;
-//# sourceMappingURL=DeliveryProvidersCollection.d.ts.map

package/lib/db/DeliveryProvidersCollection.js

@@ -1,9 +1,8 @@
-import { buildDbIndexes } from '@unchainedshop/mongodb';
-export var DeliveryProviderType;
-(function (DeliveryProviderType) {
-    DeliveryProviderType["SHIPPING"] = "SHIPPING";
-    DeliveryProviderType["PICKUP"] = "PICKUP";
-})(DeliveryProviderType || (DeliveryProviderType = {}));
+import { mongodb, buildDbIndexes } from '@unchainedshop/mongodb';
+export const DeliveryProviderType = {
+    SHIPPING: 'SHIPPING',
+    PICKUP: 'PICKUP',
+};
 export const DeliveryProvidersCollection = async (db) => {
     const DeliveryProviders = db.collection('delivery-providers');
     await buildDbIndexes(DeliveryProviders, [
@@ -17,4 +16,3 @@ export const DeliveryProvidersCollection = async (db) => {
     ]);
     return DeliveryProviders;
 };
-//# sourceMappingURL=DeliveryProvidersCollection.js.map

package/lib/delivery-index.d.ts

@@ -1,4 +1,3 @@
-export * from './module/configureDeliveryModule.js';
-export * from './db/DeliveryProvidersCollection.js';
-export * from './delivery-settings.js';
-//# sourceMappingURL=delivery-index.d.ts.map
+export * from './module/configureDeliveryModule.ts';
+export * from './db/DeliveryProvidersCollection.ts';
+export * from './delivery-settings.ts';

package/lib/delivery-index.js

@@ -1,4 +1,3 @@
-export * from './module/configureDeliveryModule.js';
-export * from './db/DeliveryProvidersCollection.js';
-export * from './delivery-settings.js';
-//# sourceMappingURL=delivery-index.js.map
+export * from "./module/configureDeliveryModule.js";
+export * from "./db/DeliveryProvidersCollection.js";
+export * from "./delivery-settings.js";

package/lib/delivery-settings.d.ts

@@ -1,4 +1,4 @@
-import { DeliveryProvider } from './db/DeliveryProvidersCollection.js';
+import type { DeliveryProvider } from './db/DeliveryProvidersCollection.ts';
 export type FilterProviders<Order = unknown, UnchainedAPI = unknown> = (params: {
     providers: DeliveryProvider[];
     order: Order;
@@ -14,4 +14,3 @@ export interface DeliverySettings {
     configureSettings: (options?: DeliverySettingsOptions) => void;
 }
 export declare const deliverySettings: DeliverySettings;
-//# sourceMappingURL=delivery-settings.d.ts.map

package/lib/delivery-settings.js

@@ -15,4 +15,3 @@ export const deliverySettings = {
         deliverySettings.determineDefaultProvider = determineDefaultProvider;
     },
 };
-//# sourceMappingURL=delivery-settings.js.map

package/lib/module/configureDeliveryModule.d.ts

@@ -1,41 +1,24 @@
-import { mongodb, ModuleInput } from '@unchainedshop/mongodb';
-import { DeliveryProvider } from '../db/DeliveryProvidersCollection.js';
-import { DeliverySettingsOptions } from '../delivery-settings.js';
+import { mongodb, type ModuleInput } from '@unchainedshop/mongodb';
+import { type DeliveryProvider, type DeliveryProviderType } from '../db/DeliveryProvidersCollection.ts';
+import { type DeliverySettingsOptions } from '../delivery-settings.ts';
 export interface DeliveryInterface {
     _id: string;
     label: string;
     version: string;
 }
-export declare const buildFindSelector: ({ includeDeleted, ...rest }?: mongodb.Filter<DeliveryProvider> & {
+export interface DeliveryProviderQuery {
+    deliveryProviderIds?: string[];
+    type?: DeliveryProviderType;
     includeDeleted?: boolean;
-}) => {
-    type?: mongodb.Condition<import("../db/DeliveryProvidersCollection.js").DeliveryProviderType> | undefined;
-    created?: mongodb.Condition<Date> | undefined;
-    deleted?: Date | mongodb.FilterOperators<Date | null | undefined> | null | undefined;
-    adapterKey?: mongodb.Condition<string> | undefined;
-    configuration?: mongodb.Condition<import("../db/DeliveryProvidersCollection.js").DeliveryConfiguration> | undefined;
-    updated?: mongodb.Condition<Date | undefined>;
-    _id?: mongodb.Condition<string> | undefined;
-    $and?: mongodb.Filter<mongodb.WithId<DeliveryProvider>>[] | undefined;
-    $nor?: mongodb.Filter<mongodb.WithId<DeliveryProvider>>[] | undefined;
-    $or?: mongodb.Filter<mongodb.WithId<DeliveryProvider>>[] | undefined;
-    $text?: {
-        $search: string;
-        $language?: string;
-        $caseSensitive?: boolean;
-        $diacriticSensitive?: boolean;
-    };
-    $where?: string | ((this: mongodb.WithId<DeliveryProvider>) => boolean) | undefined;
-    $comment?: string | mongodb.BSON.Document;
-};
+    queryString?: string;
+}
+export declare const buildFindSelector: ({ includeDeleted, queryString, deliveryProviderIds, type, }?: DeliveryProviderQuery) => mongodb.Filter<DeliveryProvider>;
 export declare const configureDeliveryModule: ({ db, options: deliveryOptions, }: ModuleInput<DeliverySettingsOptions>) => Promise<{
-    count: (query: mongodb.Filter<DeliveryProvider>) => Promise<number>;
+    count: (query?: DeliveryProviderQuery) => Promise<number>;
     findProvider: ({ deliveryProviderId, ...query }: {
         deliveryProviderId: string;
     } & mongodb.Filter<DeliveryProvider>, options?: mongodb.FindOptions) => Promise<DeliveryProvider | null>;
-    findProviders: (query: mongodb.Filter<DeliveryProvider> & {
-        includeDeleted?: boolean;
-    }, options?: mongodb.FindOptions) => Promise<DeliveryProvider[]>;
+    findProviders: (query?: DeliveryProviderQuery, options?: mongodb.FindOptions) => Promise<DeliveryProvider[]>;
     allProviders: () => Promise<mongodb.WithId<DeliveryProvider>[]>;
     providerExists: ({ deliveryProviderId }: {
         deliveryProviderId: string;
@@ -45,4 +28,3 @@ export declare const configureDeliveryModule: ({ db, options: deliveryOptions, }
     delete: (_id: string) => Promise<mongodb.WithId<DeliveryProvider> | null>;
 }>;
 export type DeliveryModule = Awaited<ReturnType<typeof configureDeliveryModule>>;
-//# sourceMappingURL=configureDeliveryModule.d.ts.map

package/lib/module/configureDeliveryModule.js

@@ -1,7 +1,7 @@
 import { emit, registerEvents } from '@unchainedshop/events';
-import { generateDbFilterById, generateDbObjectId } from '@unchainedshop/mongodb';
-import { DeliveryProvidersCollection } from '../db/DeliveryProvidersCollection.js';
-import { deliverySettings } from '../delivery-settings.js';
+import { mongodb, generateDbFilterById, generateDbObjectId, } from '@unchainedshop/mongodb';
+import { DeliveryProvidersCollection, } from "../db/DeliveryProvidersCollection.js";
+import { deliverySettings } from "../delivery-settings.js";
 import pMemoize from 'p-memoize';
 import ExpiryMap from 'expiry-map';
 const DELIVERY_PROVIDER_EVENTS = [
@@ -9,8 +9,19 @@ const DELIVERY_PROVIDER_EVENTS = [
     'DELIVERY_PROVIDER_UPDATE',
     'DELIVERY_PROVIDER_REMOVE',
 ];
-export const buildFindSelector = ({ includeDeleted = false, ...rest } = {}) => {
-    return { ...(includeDeleted ? {} : { deleted: null }), ...rest };
+export const buildFindSelector = ({ includeDeleted = false, queryString, deliveryProviderIds, type, } = {}) => {
+    const selector = includeDeleted ? {} : { deleted: null };
+    if (deliveryProviderIds) {
+        selector._id = { $in: deliveryProviderIds };
+    }
+    if (type) {
+        selector.type = type;
+    }
+    if (queryString) {
+        const regex = new RegExp(queryString, 'i');
+        selector.$or = [{ _id: regex }, { adapterKey: regex }];
+    }
+    return selector;
 };
 const allProvidersCache = new ExpiryMap(process.env.NODE_ENV === 'production' ? 60000 : 1);
 export const configureDeliveryModule = async ({ db, options: deliveryOptions = {}, }) => {
@@ -18,15 +29,14 @@ export const configureDeliveryModule = async ({ db, options: deliveryOptions = {
     deliverySettings.configureSettings(deliveryOptions);
     const DeliveryProviders = await DeliveryProvidersCollection(db);
     return {
-        // Queries
-        count: async (query) => {
+        count: async (query = {}) => {
             const providerCount = await DeliveryProviders.countDocuments(buildFindSelector(query));
             return providerCount;
         },
         findProvider: async ({ deliveryProviderId, ...query }, options) => {
             return DeliveryProviders.findOne(deliveryProviderId ? generateDbFilterById(deliveryProviderId) : query, options);
         },
-        findProviders: async (query, options = { sort: { created: 1 } }) => {
+        findProviders: async (query = {}, options = { sort: { created: 1 } }) => {
             const providers = DeliveryProviders.find(buildFindSelector(query), options);
             return providers.toArray();
         },
@@ -39,7 +49,6 @@ export const configureDeliveryModule = async ({ db, options: deliveryOptions = {
             const providerCount = await DeliveryProviders.countDocuments(generateDbFilterById(deliveryProviderId, { deleted: null }), { limit: 1 });
             return !!providerCount;
         },
-        // Mutations
         create: async (doc) => {
             const { insertedId: deliveryProviderId } = await DeliveryProviders.insertOne({
                 _id: generateDbObjectId(),
@@ -78,4 +87,3 @@ export const configureDeliveryModule = async ({ db, options: deliveryOptions = {
         },
     };
 };
-//# sourceMappingURL=configureDeliveryModule.js.map

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@unchainedshop/core-delivery",
-  "version": "4.3.4",
+  "version": "4.5.0",
   "main": "lib/delivery-index.js",
   "types": "lib/delivery-index.d.ts",
   "type": "module",
+  "sideEffects": false,
   "scripts": {
     "clean": "tsc -b --clean",
     "build": "tsc -b",
     "prepublishOnly": "npm run clean && npm run build",
     "watch": "tsc -w",
-    "test": "tsx --test",
-    "test:watch": "tsx --test --watch"
+    "test": "node --test",
+    "test:watch": "node --test --watch"
   },
   "repository": {
     "type": "git",
@@ -22,8 +23,10 @@
     "core"
   ],
   "authors": [
-    "Joël Meiller",
-    "Pascal Kaufmann"
+    "Pascal Kaufmann",
+    "Mikael Araya",
+    "Vedran Rudelj",
+    "Joël Meiller"
   ],
   "license": "EUPL-1.2",
   "bugs": {
@@ -31,16 +34,15 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^4.3.0",
-    "@unchainedshop/logger": "^4.3.0",
-    "@unchainedshop/mongodb": "^4.3.0",
-    "@unchainedshop/utils": "^4.3.0",
+    "@unchainedshop/events": "^4.5.0",
+    "@unchainedshop/logger": "^4.5.0",
+    "@unchainedshop/mongodb": "^4.5.0",
+    "@unchainedshop/utils": "^4.5.0",
     "expiry-map": "^2.0.0",
     "p-memoize": "^8.0.0"
   },
   "devDependencies": {
-    "@types/node": "^24.0.13",
-    "tsx": "^4.20.3",
+    "@types/node": "^25.0.0",
     "typescript": "^5.8.3"
   }
 }

package/lib/db/DeliveryProvidersCollection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DeliveryProvidersCollection.d.ts","sourceRoot":"","sources":["../../src/db/DeliveryProvidersCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAkB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAElF,oBAAY,oBAAoB;IAC9B,QAAQ,aAAa;IACrB,MAAM,WAAW;CAClB;AACD,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf,EAAE,CAAC;AAEJ,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,oBAAoB,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,qBAAqB,CAAC;CACtC,GAAG,eAAe,CAAC;AAEpB,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,QAAQ,EAAE;QACR,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AACD,eAAO,MAAM,2BAA2B,GAAU,IAAI,OAAO,CAAC,EAAE,kDAc/D,CAAC"}

package/lib/db/DeliveryProvidersCollection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DeliveryProvidersCollection.js","sourceRoot":"","sources":["../../src/db/DeliveryProvidersCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,cAAc,EAAmB,MAAM,wBAAwB,CAAC;AAElF,MAAM,CAAN,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,6CAAqB,CAAA;IACrB,yCAAiB,CAAA;AACnB,CAAC,EAHW,oBAAoB,KAApB,oBAAoB,QAG/B;AA4BD,MAAM,CAAC,MAAM,2BAA2B,GAAG,KAAK,EAAE,EAAc,EAAE,EAAE;IAClE,MAAM,iBAAiB,GAAG,EAAE,CAAC,UAAU,CAAmB,oBAAoB,CAAC,CAAC;IAEhF,MAAM,cAAc,CAAmB,iBAAiB,EAAE;QACxD,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE;QACtB,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE;QACzB;YACE,KAAK,EAAE;gBACL,OAAO,EAAE,CAAC;aACX;SACF;KACF,CAAC,CAAC;IAEH,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC"}

package/lib/delivery-index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"delivery-index.d.ts","sourceRoot":"","sources":["../src/delivery-index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wBAAwB,CAAC"}

package/lib/delivery-index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"delivery-index.js","sourceRoot":"","sources":["../src/delivery-index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wBAAwB,CAAC"}

package/lib/delivery-settings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"delivery-settings.d.ts","sourceRoot":"","sources":["../src/delivery-settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEvE,MAAM,MAAM,eAAe,CAAC,KAAK,GAAG,OAAO,EAAE,YAAY,GAAG,OAAO,IAAI,CACrE,MAAM,EAAE;IACN,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,EACD,YAAY,EAAE,YAAY,KACvB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;AAEjC,MAAM,MAAM,wBAAwB,CAAC,KAAK,GAAG,OAAO,EAAE,YAAY,GAAG,OAAO,IAAI,CAC9E,MAAM,EAAE;IACN,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,EACD,YAAY,EAAE,YAAY,KACvB,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;AACtC,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,CAAC;AAE3F,MAAM,WAAW,gBAAgB;IAC/B,wBAAwB,EAAE,eAAe,CAAC;IAC1C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,iBAAiB,EAAE,CAAC,OAAO,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;CAChE;AAcD,eAAO,MAAM,gBAAgB,EAAE,gBAU9B,CAAC"}

package/lib/delivery-settings.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"delivery-settings.js","sourceRoot":"","sources":["../src/delivery-settings.ts"],"names":[],"mappings":"AAyBA,MAAM,kBAAkB,GAAG,CAAC,IAAsB,EAAE,KAAuB,EAAE,EAAE;IAC7E,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,YAAY,GAAoB,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC5D,OAAO,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAA6B,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC/E,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAqB;IAChD,wBAAwB,EAAE,YAAY;IACtC,wBAAwB,EAAE,sBAAsB;IAChD,iBAAiB,CAAC,EAChB,wBAAwB,GAAG,YAAY,EACvC,wBAAwB,GAAG,sBAAsB,GAClD,GAAG,EAAE;QACJ,gBAAgB,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;QACrE,gBAAgB,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;IACvE,CAAC;CACF,CAAC"}

package/lib/module/configureDeliveryModule.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"configureDeliveryModule.d.ts","sourceRoot":"","sources":["../../src/module/configureDeliveryModule.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAA4C,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACxG,OAAO,EAA+B,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACrG,OAAO,EAAoB,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAUpF,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,iBAAiB,GAAI,8BAG/B,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG;IAAE,cAAc,CAAC,EAAE,OAAO,CAAA;CAAO;;;;;;;;;;;;;iBAqHm22S,CAAC;sBAAgC,CAAC;2BAAsC,CAAC;;;;CAnHl/2S,CAAC;AAIF,eAAO,MAAM,uBAAuB,GAAU,mCAG3C,WAAW,CAAC,uBAAuB,CAAC;mBASd,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAG,OAAO,CAAC,MAAM,CAAC;qDASlE;QACD,kBAAkB,EAAE,MAAM,CAAC;KAC5B,GAAG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,YAC1B,OAAO,CAAC,WAAW;2BAStB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG;QAAE,cAAc,CAAC,EAAE,OAAO,CAAA;KAAE,YAC7D,OAAO,CAAC,WAAW,KAC3B,OAAO,CAAC,gBAAgB,EAAE,CAAC;;6CAciB;QAAE,kBAAkB,EAAE,MAAM,CAAA;KAAE,KAAG,OAAO,CAAC,OAAO,CAAC;kBAUzF,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,KAAK,CAAC;kBAgBrE,MAAM,OAAO,gBAAgB;kBAiB7B,MAAM;EAgB7B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC"}

package/lib/module/configureDeliveryModule.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"configureDeliveryModule.js","sourceRoot":"","sources":["../../src/module/configureDeliveryModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAW,oBAAoB,EAAE,kBAAkB,EAAe,MAAM,wBAAwB,CAAC;AACxG,OAAO,EAAE,2BAA2B,EAAoB,MAAM,sCAAsC,CAAC;AACrG,OAAO,EAAE,gBAAgB,EAA2B,MAAM,yBAAyB,CAAC;AACpF,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,MAAM,wBAAwB,GAAa;IACzC,0BAA0B;IAC1B,0BAA0B;IAC1B,0BAA0B;CAC3B,CAAC;AAQF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAChC,cAAc,GAAG,KAAK,EACtB,GAAG,IAAI,KAC4D,EAAE,EAAE,EAAE;IACzE,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE3F,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAE,EAC5C,EAAE,EACF,OAAO,EAAE,eAAe,GAAG,EAAE,GACQ,EAAE,EAAE;IACzC,cAAc,CAAC,wBAAwB,CAAC,CAAC;IAEzC,gBAAgB,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAEpD,MAAM,iBAAiB,GAAG,MAAM,2BAA2B,CAAC,EAAE,CAAC,CAAC;IAEhE,OAAO;QACL,UAAU;QACV,KAAK,EAAE,KAAK,EAAE,KAAuC,EAAmB,EAAE;YACxE,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;YACvF,OAAO,aAAa,CAAC;QACvB,CAAC;QAED,YAAY,EAAE,KAAK,EACjB,EACE,kBAAkB,EAClB,GAAG,KAAK,EAG0B,EACpC,OAA6B,EAC7B,EAAE;YACF,OAAO,iBAAiB,CAAC,OAAO,CAC9B,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,KAAK,EACrE,OAAO,CACR,CAAC;QACJ,CAAC;QAED,aAAa,EAAE,KAAK,EAClB,KAAsE,EACtE,UAA+B,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAC1B,EAAE;YAC/B,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5E,OAAO,SAAS,CAAC,OAAO,EAAE,CAAC;QAC7B,CAAC;QAED,YAAY,EAAE,QAAQ,CACpB,KAAK;YACH,OAAO,iBAAiB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACvF,CAAC,EACD;YACE,KAAK,EAAE,iBAAiB;SACzB,CACF;QAED,cAAc,EAAE,KAAK,EAAE,EAAE,kBAAkB,EAAkC,EAAoB,EAAE;YACjG,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAAC,cAAc,CAC1D,oBAAoB,CAAC,kBAAkB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAC3D,EAAE,KAAK,EAAE,CAAC,EAAE,CACb,CAAC;YACF,OAAO,CAAC,CAAC,aAAa,CAAC;QACzB,CAAC;QAED,YAAY;QACZ,MAAM,EAAE,KAAK,EACX,GAAuF,EACvF,EAAE;YACF,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,MAAM,iBAAiB,CAAC,SAAS,CAAC;gBAC3E,GAAG,EAAE,kBAAkB,EAAE;gBACzB,OAAO,EAAE,IAAI,IAAI,EAAE;gBACnB,GAAG,GAAG;aACP,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,CAAC,MAAM,iBAAiB,CAAC,OAAO,CACvD,EAAE,GAAG,EAAE,kBAAkB,EAAE,EAC3B,EAAE,CACH,CAAqB,CAAC;YACvB,iBAAiB,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,IAAI,CAAC,0BAA0B,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;YAC7D,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAW,EAAE,GAAqB,EAAE,EAAE;YACnD,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,gBAAgB,CAC/D,oBAAoB,CAAC,GAAG,CAAC,EACzB;gBACE,IAAI,EAAE;oBACJ,OAAO,EAAE,IAAI,IAAI,EAAE;oBACnB,GAAG,GAAG;iBACP;aACF,EACD,EAAE,cAAc,EAAE,OAAO,EAAE,CAC5B,CAAC;YACF,IAAI,CAAC,gBAAgB;gBAAE,OAAO,IAAI,CAAC;YACnC,iBAAiB,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,IAAI,CAAC,0BAA0B,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;YAC7D,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE;YAC5B,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,gBAAgB,CAC/D,oBAAoB,CAAC,GAAG,CAAC,EACzB;gBACE,IAAI,EAAE;oBACJ,OAAO,EAAE,IAAI,IAAI,EAAE;iBACpB;aACF,EACD,EAAE,cAAc,EAAE,OAAO,EAAE,CAC5B,CAAC;YACF,IAAI,CAAC,gBAAgB;gBAAE,OAAO,IAAI,CAAC;YACnC,iBAAiB,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,IAAI,CAAC,0BAA0B,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;YAC7D,OAAO,gBAAgB,CAAC;QAC1B,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/src/db/DeliveryProvidersCollection.ts

@@ -1,48 +0,0 @@
-import { mongodb, buildDbIndexes, TimestampFields } from '@unchainedshop/mongodb';
-
-export enum DeliveryProviderType {
-  SHIPPING = 'SHIPPING',
-  PICKUP = 'PICKUP',
-}
-export type DeliveryConfiguration = {
-  key: string;
-  value: string;
-}[];
-
-export type DeliveryProvider = {
-  _id: string;
-  type: DeliveryProviderType;
-  adapterKey: string;
-  configuration: DeliveryConfiguration;
-} & TimestampFields;
-
-export interface DeliveryLocation {
-  _id: string;
-  name: string;
-  address: {
-    addressLine: string;
-    addressLine2?: string;
-    postalCode: string;
-    countryCode: string;
-    city: string;
-  };
-  geoPoint: {
-    latitude: number;
-    longitude: number;
-  };
-}
-export const DeliveryProvidersCollection = async (db: mongodb.Db) => {
-  const DeliveryProviders = db.collection<DeliveryProvider>('delivery-providers');
-
-  await buildDbIndexes<DeliveryProvider>(DeliveryProviders, [
-    { index: { type: 1 } },
-    { index: { created: 1 } },
-    {
-      index: {
-        deleted: 1,
-      },
-    },
-  ]);
-
-  return DeliveryProviders;
-};

package/src/delivery-index.ts

@@ -1,3 +0,0 @@
-export * from './module/configureDeliveryModule.js';
-export * from './db/DeliveryProvidersCollection.js';
-export * from './delivery-settings.js';

package/src/delivery-settings.ts

@@ -1,48 +0,0 @@
-import { DeliveryProvider } from './db/DeliveryProvidersCollection.js';
-
-export type FilterProviders<Order = unknown, UnchainedAPI = unknown> = (
-  params: {
-    providers: DeliveryProvider[];
-    order: Order;
-  },
-  unchainedAPI: UnchainedAPI,
-) => Promise<DeliveryProvider[]>;
-
-export type DetermineDefaultProvider<Order = unknown, UnchainedAPI = unknown> = (
-  params: {
-    providers: DeliveryProvider[];
-    order: Order;
-  },
-  unchainedAPI: UnchainedAPI,
-) => Promise<DeliveryProvider | null>;
-export type DeliverySettingsOptions = Omit<Partial<DeliverySettings>, 'configureSettings'>;
-
-export interface DeliverySettings {
-  filterSupportedProviders: FilterProviders;
-  determineDefaultProvider: DetermineDefaultProvider;
-  configureSettings: (options?: DeliverySettingsOptions) => void;
-}
-
-const sortByCreationDate = (left: DeliveryProvider, right: DeliveryProvider) => {
-  return new Date(left.created).getTime() - new Date(right.created).getTime();
-};
-
-const allProviders: FilterProviders = async ({ providers }) => {
-  return providers.toSorted(sortByCreationDate);
-};
-
-const firstProviderIsDefault: DetermineDefaultProvider = async ({ providers }) => {
-  return (providers?.length > 0 && providers[0]) || null;
-};
-
-export const deliverySettings: DeliverySettings = {
-  filterSupportedProviders: allProviders,
-  determineDefaultProvider: firstProviderIsDefault,
-  configureSettings({
-    filterSupportedProviders = allProviders,
-    determineDefaultProvider = firstProviderIsDefault,
-  } = {}) {
-    deliverySettings.filterSupportedProviders = filterSupportedProviders;
-    deliverySettings.determineDefaultProvider = determineDefaultProvider;
-  },
-};

package/src/module/buildFindSelector.test.ts

@@ -1,19 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
-import { DeliveryProviderType } from '../delivery-index.js';
-import { buildFindSelector } from './configureDeliveryModule.js';
-
-describe('Delivery', () => {
-  describe('buildFindSelector', () => {
-    it('Return correct filter object when passed no argument', () => {
-      assert.deepStrictEqual(buildFindSelector({}), { deleted: null });
-    });
-
-    it('Return correct filter object when passed type', () => {
-      assert.deepStrictEqual(buildFindSelector({ type: DeliveryProviderType.PICKUP }), {
-        type: 'PICKUP',
-        deleted: null,
-      });
-    });
-  });
-});

package/src/module/configureDeliveryModule.ts

@@ -1,139 +0,0 @@
-import { emit, registerEvents } from '@unchainedshop/events';
-import { mongodb, generateDbFilterById, generateDbObjectId, ModuleInput } from '@unchainedshop/mongodb';
-import { DeliveryProvidersCollection, DeliveryProvider } from '../db/DeliveryProvidersCollection.js';
-import { deliverySettings, DeliverySettingsOptions } from '../delivery-settings.js';
-import pMemoize from 'p-memoize';
-import ExpiryMap from 'expiry-map';
-
-const DELIVERY_PROVIDER_EVENTS: string[] = [
-  'DELIVERY_PROVIDER_CREATE',
-  'DELIVERY_PROVIDER_UPDATE',
-  'DELIVERY_PROVIDER_REMOVE',
-];
-
-export interface DeliveryInterface {
-  _id: string;
-  label: string;
-  version: string;
-}
-
-export const buildFindSelector = ({
-  includeDeleted = false,
-  ...rest
-}: mongodb.Filter<DeliveryProvider> & { includeDeleted?: boolean } = {}) => {
-  return { ...(includeDeleted ? {} : { deleted: null }), ...rest };
-};
-
-const allProvidersCache = new ExpiryMap(process.env.NODE_ENV === 'production' ? 60000 : 1);
-
-export const configureDeliveryModule = async ({
-  db,
-  options: deliveryOptions = {},
-}: ModuleInput<DeliverySettingsOptions>) => {
-  registerEvents(DELIVERY_PROVIDER_EVENTS);
-
-  deliverySettings.configureSettings(deliveryOptions);
-
-  const DeliveryProviders = await DeliveryProvidersCollection(db);
-
-  return {
-    // Queries
-    count: async (query: mongodb.Filter<DeliveryProvider>): Promise<number> => {
-      const providerCount = await DeliveryProviders.countDocuments(buildFindSelector(query));
-      return providerCount;
-    },
-
-    findProvider: async (
-      {
-        deliveryProviderId,
-        ...query
-      }: {
-        deliveryProviderId: string;
-      } & mongodb.Filter<DeliveryProvider>,
-      options?: mongodb.FindOptions,
-    ) => {
-      return DeliveryProviders.findOne(
-        deliveryProviderId ? generateDbFilterById(deliveryProviderId) : query,
-        options,
-      );
-    },
-
-    findProviders: async (
-      query: mongodb.Filter<DeliveryProvider> & { includeDeleted?: boolean },
-      options: mongodb.FindOptions = { sort: { created: 1 } },
-    ): Promise<DeliveryProvider[]> => {
-      const providers = DeliveryProviders.find(buildFindSelector(query), options);
-      return providers.toArray();
-    },
-
-    allProviders: pMemoize(
-      async function () {
-        return DeliveryProviders.find({ deleted: null }, { sort: { created: 1 } }).toArray();
-      },
-      {
-        cache: allProvidersCache,
-      },
-    ),
-
-    providerExists: async ({ deliveryProviderId }: { deliveryProviderId: string }): Promise<boolean> => {
-      const providerCount = await DeliveryProviders.countDocuments(
-        generateDbFilterById(deliveryProviderId, { deleted: null }),
-        { limit: 1 },
-      );
-      return !!providerCount;
-    },
-
-    // Mutations
-    create: async (
-      doc: Omit<DeliveryProvider, '_id' | 'created'> & Pick<Partial<DeliveryProvider>, '_id'>,
-    ) => {
-      const { insertedId: deliveryProviderId } = await DeliveryProviders.insertOne({
-        _id: generateDbObjectId(),
-        created: new Date(),
-        ...doc,
-      });
-      const deliveryProvider = (await DeliveryProviders.findOne(
-        { _id: deliveryProviderId },
-        {},
-      )) as DeliveryProvider;
-      allProvidersCache.clear();
-      await emit('DELIVERY_PROVIDER_CREATE', { deliveryProvider });
-      return deliveryProvider;
-    },
-
-    update: async (_id: string, doc: DeliveryProvider) => {
-      const deliveryProvider = await DeliveryProviders.findOneAndUpdate(
-        generateDbFilterById(_id),
-        {
-          $set: {
-            updated: new Date(),
-            ...doc,
-          },
-        },
-        { returnDocument: 'after' },
-      );
-      if (!deliveryProvider) return null;
-      allProvidersCache.clear();
-      await emit('DELIVERY_PROVIDER_UPDATE', { deliveryProvider });
-      return deliveryProvider;
-    },
-
-    delete: async (_id: string) => {
-      const deliveryProvider = await DeliveryProviders.findOneAndUpdate(
-        generateDbFilterById(_id),
-        {
-          $set: {
-            deleted: new Date(),
-          },
-        },
-        { returnDocument: 'after' },
-      );
-      if (!deliveryProvider) return null;
-      allProvidersCache.clear();
-      await emit('DELIVERY_PROVIDER_REMOVE', { deliveryProvider });
-      return deliveryProvider;
-    },
-  };
-};
-
-export type DeliveryModule = Awaited<ReturnType<typeof configureDeliveryModule>>;

package/tsconfig.json

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