@unchainedshop/core-quotations 5.0.0-alpha.1 → 5.0.0-alpha.10

package/README.md

@@ -13,89 +13,21 @@ npm install @unchainedshop/core-quotations
 
 ## Usage
 
-```typescript
-import { configureQuotationsModule, QuotationStatus } from '@unchainedshop/core-quotations';
-
-const quotationsModule = await configureQuotationsModule({ db });
-
-// Create a quotation request
-const quotationId = await quotationsModule.create({
-  userId: 'user-123',
-  productId: 'custom-product-456',
-  configuration: [{ key: 'quantity', value: '1000' }],
-});
+The platform initializes this module as `platform.unchainedAPI.modules.quotations`.
 
-// Propose a quote
-await quotationsModule.propose(quotationId, {
-  price: { amount: 5000, currency: 'CHF' },
-  expiresAt: new Date('2024-12-31'),
-});
+```typescript
+import { QuotationStatus } from '@unchainedshop/core-quotations';
 
-// Find quotations
-const quotations = await quotationsModule.findQuotations({
-  status: QuotationStatus.PROPOSED,
-});
+const { quotations } = platform.unchainedAPI.modules;
+const userQuotations = await quotations.findQuotations({ userId: 'user-123' });
+const proposals = userQuotations.filter(
+  (quotation) => quotations.normalizedStatus(quotation) === QuotationStatus.PROPOSED,
+);
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configureQuotationsModule` | Configure and return the quotations module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findQuotation` | Find quotation by ID |
-| `findQuotations` | Find quotations with filtering and pagination |
-| `count` | Count quotations matching query |
-| `quotationExists` | Check if quotation exists |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a quotation request |
-| `update` | Update quotation data |
-| `delete` | Delete a quotation |
-| `propose` | Propose a quote |
-| `verify` | Verify a quotation |
-| `reject` | Reject a quotation |
-| `fulfill` | Mark quotation as fulfilled |
-
-### Constants
-
-| Export | Description |
-|--------|-------------|
-| `QuotationStatus` | Status values (REQUESTED, PROCESSING, PROPOSED, FULFILLED, REJECTED) |
-
-### Settings
-
-| Export | Description |
-|--------|-------------|
-| `quotationsSettings` | Access quotation module settings |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `Quotation` | Quotation document type |
-| `QuotationConfiguration` | Configuration item type |
-| `QuotationsModule` | Module interface type |
-
-## Events
+Use the GraphQL quotation mutations or `unchainedAPI.services.quotations` to request, propose, and verify quotations through the configured adapter. A proposal's `price` is an integer amount in the quotation currency's minor units, and its expiration field is `expires`.
 
-| Event | Description |
-|-------|-------------|
-| `QUOTATION_CREATE` | Quotation requested |
-| `QUOTATION_UPDATE` | Quotation updated |
-| `QUOTATION_REMOVE` | Quotation deleted |
-| `QUOTATION_PROPOSE` | Quote proposed |
-| `QUOTATION_REJECT` | Quotation rejected |
-| `QUOTATION_FULLFILL` | Quotation fulfilled |
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/quotations), [quotation extension guide](https://docs.unchained.shop/extend/quotation), [public exports](src/quotations-index.ts), and [module implementation](src/module/configureQuotationsModule.ts).
 
 ## License
 

package/lib/db/QuotationsCollection.js

@@ -1,4 +1,4 @@
-import { mongodb, buildDbIndexes, isDocumentDBCompatModeEnabled, } from '@unchainedshop/mongodb';
+import { mongodb, buildDbIndexes } from '@unchainedshop/mongodb';
 export const QuotationStatus = {
     REQUESTED: 'REQUESTED',
     PROCESSING: 'PROCESSING',
@@ -8,30 +8,28 @@ export const QuotationStatus = {
 };
 export const QuotationsCollection = async (db) => {
     const Quotations = db.collection('quotations');
-    if (!isDocumentDBCompatModeEnabled()) {
-        await buildDbIndexes(Quotations, [
-            {
-                index: {
-                    _id: 'text',
-                    userId: 'text',
-                    quotationNumber: 'text',
-                    status: 'text',
-                },
-                options: {
-                    weights: {
-                        _id: 8,
-                        userId: 3,
-                        quotationNumber: 6,
-                        status: 1,
-                    },
-                    name: 'quotation_fulltext_search',
+    await buildDbIndexes(Quotations, [
+        {
+            index: {
+                _id: 'text',
+                userId: 'text',
+                quotationNumber: 'text',
+                status: 'text',
+            },
+            options: {
+                weights: {
+                    _id: 8,
+                    userId: 3,
+                    quotationNumber: 6,
+                    status: 1,
                 },
+                name: 'quotation_fulltext_search',
             },
-        ]);
-    }
+        },
+    ]);
     await buildDbIndexes(Quotations, [
-        { index: { userId: 1 } },
-        { index: { productId: 1 } },
+        { index: { userId: 1, status: 1 } },
+        { index: { productId: 1, status: 1 } },
         { index: { status: 1 } },
     ]);
     return Quotations;

package/lib/module/configureQuotationsModule.d.ts

@@ -31,8 +31,8 @@ export declare const configureQuotationsModule: ({ db, migrationRepository, opti
         sort?: SortOption[];
     }, options?: mongodb.FindOptions) => Promise<Quotation[]>;
     normalizedStatus: (quotation: Quotation) => QuotationStatus;
-    isExpired(quotation: Quotation, { referenceDate }: {
-        referenceDate: Date;
+    isExpired(quotation: Quotation, { referenceDate }?: {
+        referenceDate?: Date;
     }): boolean;
     isProposalValid(quotation: Quotation): boolean;
     create: ({ countryCode, currencyCode, ...quotationData }: QuotationData & {

package/lib/module/configureQuotationsModule.js

@@ -1,7 +1,7 @@
 import { SortDirection } from '@unchainedshop/utils';
 import { QuotationStatus } from "../db/QuotationsCollection.js";
 import { emit, registerEvents } from '@unchainedshop/events';
-import { generateDbFilterById, buildSortOptions, mongodb, generateDbObjectId, assertDocumentDBCompatMode, } from '@unchainedshop/mongodb';
+import { generateDbFilterById, buildSortOptions, mongodb, generateDbObjectId, } from '@unchainedshop/mongodb';
 import { QuotationsCollection } from "../db/QuotationsCollection.js";
 import { quotationsSettings } from "../quotations-settings.js";
 import renameCurrencyCode from "../migrations/20250502111800-currency-code.js";
@@ -15,7 +15,6 @@ export const buildFindSelector = ({ userId, queryString, quotationIds } = {}) =>
         selector._id = { $in: quotationIds };
     }
     if (queryString) {
-        assertDocumentDBCompatMode();
         selector.$text = { $search: queryString };
     }
     return selector;
@@ -84,7 +83,7 @@ export const configureQuotationsModule = async ({ db, migrationRepository, optio
                 updated: new Date(),
                 ...fieldKeys.reduce((set, key) => ({ ...set, [key]: values[key] }), {}),
             },
-        });
+        }, { returnDocument: 'after' });
         if (!quotation)
             return null;
         await emit('QUOTATION_UPDATE', { quotation, fields: fieldKeys });
@@ -119,7 +118,7 @@ export const configureQuotationsModule = async ({ db, migrationRepository, optio
                 ? QuotationStatus.REQUESTED
                 : quotation.status;
         },
-        isExpired(quotation, { referenceDate }) {
+        isExpired(quotation, { referenceDate } = {}) {
             const relevantDate = referenceDate ? new Date(referenceDate) : new Date();
             if (!quotation.expires)
                 return false;
@@ -146,10 +145,13 @@ export const configureQuotationsModule = async ({ db, migrationRepository, optio
             return quotation;
         },
         deleteRequestedUserQuotations: async (userId) => {
-            const { deletedCount } = await Quotations.deleteMany({
+            const selector = {
                 userId,
                 status: { $in: [QuotationStatus.REQUESTED, null] },
-            });
+            };
+            const quotations = await Quotations.find(selector, { projection: { _id: 1 } }).toArray();
+            const { deletedCount } = await Quotations.deleteMany(selector);
+            await Promise.all(quotations.map((quotation) => emit('QUOTATION_REMOVE', { quotationId: quotation._id })));
             return deletedCount;
         },
         updateContext: updateQuotationFields(['context']),

package/package.json

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