@unchainedshop/core-orders 4.8.29 → 5.0.0-alpha.10

package/README.md

@@ -13,126 +13,18 @@ npm install @unchainedshop/core-orders
 
 ## Usage
 
-```typescript
-import { configureOrdersModule, OrderStatus } from '@unchainedshop/core-orders';
-
-const ordersModule = await configureOrdersModule({ db });
-
-// Create an order
-const orderId = await ordersModule.create({
-  userId: 'user-123',
-  currency: 'CHF',
-  countryCode: 'CH',
-});
+The platform initializes this module as `platform.unchainedAPI.modules.orders`.
 
-// Add position to order
-await ordersModule.positions.create({
-  orderId,
-  productId: 'product-456',
-  quantity: 2,
-});
+```typescript
+const { orders } = platform.unchainedAPI.modules;
 
-// Checkout order
-await ordersModule.checkout(orderId, { paymentContext: {} });
+const order = await orders.findOrder({ orderId: 'order-123' });
+const userOrders = await orders.findOrders({ userId: 'user-123', limit: 20 });
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configureOrdersModule` | Configure and return the orders module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findOrder` | Find order by ID or number |
-| `findOrders` | Find orders with filtering and pagination |
-| `count` | Count orders matching query |
-| `orderExists` | Check if order exists |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a new order |
-| `update` | Update order data |
-| `delete` | Delete an order |
-| `checkout` | Process order checkout |
-| `confirm` | Confirm an order |
-| `reject` | Reject an order |
-| `setPaymentProvider` | Set payment provider |
-| `setDeliveryProvider` | Set delivery provider |
-
-### Submodules
-
-#### Positions (`orders.positions`)
-| Method | Description |
-|--------|-------------|
-| `findPositions` | Find order positions |
-| `create` | Add position to order |
-| `update` | Update position |
-| `delete` | Remove position |
-
-#### Payments (`orders.payments`)
-| Method | Description |
-|--------|-------------|
-| `findPayment` | Find order payment |
-| `create` | Create payment for order |
-| `markPaid` | Mark payment as paid |
-| `charge` | Charge the payment |
-
-#### Deliveries (`orders.deliveries`)
-| Method | Description |
-|--------|-------------|
-| `findDelivery` | Find order delivery |
-| `create` | Create delivery for order |
-| `markDelivered` | Mark as delivered |
-| `send` | Trigger delivery |
-
-#### Discounts (`orders.discounts`)
-| Method | Description |
-|--------|-------------|
-| `findDiscounts` | Find order discounts |
-| `create` | Add discount to order |
-| `delete` | Remove discount |
-
-### Constants
-
-| Export | Description |
-|--------|-------------|
-| `OrderStatus` | Order status values (OPEN, PENDING, CONFIRMED, FULFILLED, REJECTED) |
-
-### Settings
-
-| Export | Description |
-|--------|-------------|
-| `ordersSettings` | Access order module settings |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `Order` | Order document type |
-| `OrderPosition` | Position document type |
-| `OrderPayment` | Payment document type |
-| `OrderDelivery` | Delivery document type |
-| `OrderDiscount` | Discount document type |
-| `OrdersModule` | Module interface type |
-
-## Events
+Order positions, payments, deliveries, discounts, and statistics are exposed through the corresponding submodules. Use `unchainedAPI.services.orders` or the GraphQL API for cart operations and checkout so pricing, validation, payment, and delivery are coordinated.
 
-| Event | Description |
-|-------|-------------|
-| `ORDER_CREATE` | Order created |
-| `ORDER_UPDATE` | Order updated |
-| `ORDER_REMOVE` | Order deleted |
-| `ORDER_CHECKOUT` | Order checked out |
-| `ORDER_CONFIRMED` | Order confirmed |
-| `ORDER_REJECTED` | Order rejected |
-| `ORDER_FULFILLED` | Order fulfilled |
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/orders), [checkout guide](https://docs.unchained.shop/guides/checkout-implementation), [public exports](src/orders-index.ts), and [module implementation](src/module/configureOrdersModule.ts).
 
 ## License
 

package/lib/module/configureOrderDiscountsModule.js

@@ -14,12 +14,11 @@ export const configureOrderDiscountsModule = ({ OrderDiscounts, }) => {
             return OrderDiscounts.findOne(buildFindOrderDiscountByIdSelector(discountId), options);
         },
         findOrderDiscounts: async (query) => {
-            if ('orderIds' in query) {
-                if (!query.orderIds?.length)
-                    return [];
-                return OrderDiscounts.find({ orderId: { $in: query.orderIds } }, { sort: { created: 1 } }).toArray();
-            }
-            return OrderDiscounts.find({ orderId: query.orderId }, { sort: { created: 1 } }).toArray();
+            if ('orderIds' in query && !query.orderIds.length)
+                return [];
+            const orderId = 'orderIds' in query ? { $in: query.orderIds } : query.orderId;
+            const discounts = OrderDiscounts.find({ orderId }, { sort: { created: 1, _id: 1 } });
+            return discounts.toArray();
         },
         create: async (doc) => {
             const normalizedTrigger = doc.trigger || OrderDiscountTrigger.USER;

package/lib/module/configureOrderPaymentsModule.js

@@ -1,7 +1,7 @@
 import { emit, registerEvents } from '@unchainedshop/events';
 import { generateDbFilterById, generateDbObjectId, mongodb } from '@unchainedshop/mongodb';
 import { OrderPaymentStatus } from "../db/OrderPaymentsCollection.js";
-const ORDER_PAYMENT_EVENTS = ['ORDER_UPDATE_PAYMENT', 'ORDER_SIGN_PAYMENT', 'ORDER_PAY'];
+const ORDER_PAYMENT_EVENTS = ['ORDER_UPDATE_PAYMENT', 'ORDER_PAY'];
 export const buildFindOrderPaymentByIdSelector = (orderPaymentId) => generateDbFilterById(orderPaymentId);
 export const configureOrderPaymentsModule = ({ OrderPayments, }) => {
     registerEvents(ORDER_PAYMENT_EVENTS);

package/lib/module/configureOrderPositionsModule.js

@@ -14,15 +14,11 @@ export const configureOrderPositionsModule = ({ OrderPositions, }) => {
             return OrderPositions.findOne(buildFindOrderPositionByIdSelector(itemId), options);
         },
         findOrderPositions: async (query) => {
-            if ('orderIds' in query) {
-                if (!query.orderIds?.length)
-                    return [];
-                return OrderPositions.find({
-                    orderId: { $in: query.orderIds },
-                    quantity: { $gt: 0 },
-                }, { sort: { created: 1 } }).toArray();
-            }
-            return OrderPositions.find({ orderId: query.orderId, quantity: { $gt: 0 } }, { sort: { created: 1 } }).toArray();
+            if ('orderIds' in query && !query.orderIds.length)
+                return [];
+            const orderId = 'orderIds' in query ? { $in: query.orderIds } : query.orderId;
+            const positions = OrderPositions.find({ orderId, quantity: { $gt: 0 } }, { sort: { created: 1, _id: 1 } });
+            return positions.toArray();
         },
         delete: async (orderPositionId) => {
             const selector = buildFindOrderPositionByIdSelector(orderPositionId);

package/lib/module/configureOrdersModule-mutations.d.ts

@@ -5,7 +5,7 @@ export declare const configureOrderModuleMutations: ({ Orders, OrderPositions, }
     Orders: mongodb.Collection<Order>;
     OrderPositions: mongodb.Collection<OrderPosition>;
 }) => {
-    create: ({ userId, orderNumber, currencyCode, countryCode, billingAddress, contact, context, }: {
+    create: ({ userId, orderNumber, currencyCode, countryCode, billingAddress, contact, originEnrollmentId, context, }: {
         userId: string;
         billingAddress?: Address;
         contact?: Contact;

package/lib/module/configureOrdersModule-mutations.js

@@ -20,7 +20,7 @@ export const configureOrderModuleMutations = ({ Orders, OrderPositions, }) => {
         };
     };
     return {
-        create: async ({ userId, orderNumber, currencyCode, countryCode, billingAddress, contact, context, }) => {
+        create: async ({ userId, orderNumber, currencyCode, countryCode, billingAddress, contact, originEnrollmentId, context, }) => {
             const { insertedId: orderId } = await Orders.insertOne({
                 _id: generateDbObjectId(),
                 created: new Date(),
@@ -33,6 +33,7 @@ export const configureOrderModuleMutations = ({ Orders, OrderPositions, }) => {
                 calculation: [],
                 log: [],
                 orderNumber,
+                originEnrollmentId,
                 context: context || {},
             });
             const order = (await Orders.findOne(generateDbFilterById(orderId), {}));

package/lib/module/configureOrdersModule-queries.js

@@ -66,6 +66,7 @@ export const configureOrdersModuleQueries = ({ Orders }) => {
             const selector = buildFindSelector({ queryString, ...query });
             if (queryString) {
                 return Orders.find(selector, {
+                    ...findOptions,
                     ...options,
                     projection: { score: { $meta: 'textScore' } },
                     sort: { score: { $meta: 'textScore' } },
@@ -160,19 +161,26 @@ export const configureOrdersModuleQueries = ({ Orders }) => {
                             created: 1,
                             currencyCode: 1,
                             itemAmount: {
-                                $let: {
-                                    vars: {
-                                        item: {
-                                            $first: {
-                                                $filter: {
-                                                    input: '$calculation',
-                                                    as: 'c',
-                                                    cond: { $eq: ['$$c.category', 'ITEMS'] },
-                                                },
+                                $reduce: {
+                                    input: {
+                                        $filter: {
+                                            input: { $ifNull: ['$calculation', []] },
+                                            as: 'c',
+                                            cond: {
+                                                $or: [
+                                                    { $eq: ['$$c.category', 'ITEMS'] },
+                                                    {
+                                                        $and: [
+                                                            { $eq: ['$$c.category', 'TAXES'] },
+                                                            { $eq: ['$$c.baseCategory', 'ITEMS'] },
+                                                        ],
+                                                    },
+                                                ],
                                             },
                                         },
                                     },
-                                    in: '$$item.amount',
+                                    initialValue: 0,
+                                    in: { $add: ['$$value', { $ifNull: ['$$this.amount', 0] }] },
                                 },
                             },
                         },

package/lib/module/configureOrdersModule.d.ts

@@ -120,7 +120,7 @@ export declare const configureOrdersModule: ({ db, migrationRepository, options:
     }>;
     setDeliveryProvider: (orderId: string, deliveryProviderId: string) => Promise<mongodb.WithId<Order> | null>;
     setPaymentProvider: (orderId: string, paymentProviderId: string) => Promise<mongodb.WithId<Order> | null>;
-    create: ({ userId, orderNumber, currencyCode, countryCode, billingAddress, contact, context, }: {
+    create: ({ userId, orderNumber, currencyCode, countryCode, billingAddress, contact, originEnrollmentId, context, }: {
         userId: string;
         billingAddress?: import("@unchainedshop/mongodb").Address;
         contact?: import("@unchainedshop/mongodb").Contact;

package/lib/module/configureOrdersModule.js

@@ -15,6 +15,7 @@ import { configureOrdersModuleQueries } from "./configureOrdersModule-queries.js
 import { emit, registerEvents } from '@unchainedshop/events';
 import renameCurrencyCode from "../migrations/20250502111800-currency-code.js";
 import normalizeOrderContactPhone from "../migrations/20260625120000-normalize-contact-phone.js";
+import migrateOrderCalculationToNet from "../migrations/20260907120000-order-calculation-net.js";
 const ORDER_EVENTS = [
     'ORDER_CHECKOUT',
     'ORDER_CONFIRMED',
@@ -24,6 +25,7 @@ const ORDER_EVENTS = [
 export const configureOrdersModule = async ({ db, migrationRepository, options: orderOptions = {}, }) => {
     renameCurrencyCode(migrationRepository);
     normalizeOrderContactPhone(migrationRepository);
+    migrateOrderCalculationToNet(migrationRepository);
     registerEvents(ORDER_EVENTS);
     ordersSettings.configureSettings(orderOptions);
     const Orders = await OrdersCollection(db);

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@unchainedshop/core-orders",
   "description": "Order management module for the Unchained Engine",
-  "version": "4.8.29",
+  "version": "5.0.0-alpha.10",
+  "files": [
+    "lib"
+  ],
   "main": "lib/orders-index.js",
   "types": "lib/orders-index.d.ts",
   "type": "module",
@@ -35,12 +38,12 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^4.8.27",
-    "@unchainedshop/mongodb": "^4.8.27",
-    "@unchainedshop/utils": "^4.8.27"
+    "@unchainedshop/events": "^5.0.0-alpha.10",
+    "@unchainedshop/mongodb": "^5.0.0-alpha.10",
+    "@unchainedshop/utils": "^5.0.0-alpha.10"
   },
   "devDependencies": {
     "@types/node": "^26.2.0",
-    "typescript": "^5.8.3"
+    "typescript": "^6.0.3"
   }
 }