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

package/README.md

@@ -13,120 +13,27 @@ npm install @unchainedshop/core-assortments
 
 ## Usage
 
-```typescript
-import { configureAssortmentsModule } from '@unchainedshop/core-assortments';
+The platform initializes this module as `platform.unchainedAPI.modules.assortments`. For startup and options, see [Platform Configuration](https://docs.unchained.shop/platform-configuration/).
 
-const assortmentsModule = await configureAssortmentsModule({ db });
+```typescript
+const { assortments } = platform.unchainedAPI.modules;
 
-// Create an assortment
-const assortmentId = await assortmentsModule.create({
-  slugs: ['electronics'],
+const assortment = await assortments.create({
   isRoot: true,
+  isActive: true,
+  sequence: 10,
+  tags: [],
 });
-
-// Find assortments
-const assortments = await assortmentsModule.findAssortments({
-  includeInactive: false,
-});
-
-// Add product to assortment
-await assortmentsModule.products.create({
-  assortmentId,
+await assortments.products.create({
+  assortmentId: assortment._id,
   productId: 'product-123',
 });
+const roots = await assortments.findAssortments({ includeLeaves: false, includeInactive: false });
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configureAssortmentsModule` | Configure and return the assortments module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findAssortment` | Find assortment by ID or slug |
-| `findAssortments` | Find assortments with filtering and pagination |
-| `count` | Count assortments matching query |
-| `assortmentExists` | Check if assortment exists |
-| `findProductIds` | Get all product IDs in an assortment tree |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a new assortment |
-| `update` | Update assortment data |
-| `delete` | Soft delete an assortment |
-| `setBase` | Set base assortment |
-| `invalidateCache` | Clear assortment cache |
-
-### Submodules
-
-#### Products (`assortments.products`)
-| Method | Description |
-|--------|-------------|
-| `findProducts` | Find products in assortment |
-| `create` | Add product to assortment |
-| `delete` | Remove product from assortment |
-| `reorder` | Reorder products |
-
-#### Links (`assortments.links`)
-| Method | Description |
-|--------|-------------|
-| `findLinks` | Find assortment links (parent-child) |
-| `create` | Create link between assortments |
-| `delete` | Remove link |
-| `reorder` | Reorder child assortments |
-
-#### Media (`assortments.media`)
-| Method | Description |
-|--------|-------------|
-| `findMedia` | Find assortment media |
-| `create` | Add media to assortment |
-| `delete` | Remove media |
-| `reorder` | Reorder media |
-
-#### Texts (`assortments.texts`)
-| Method | Description |
-|--------|-------------|
-| `findTexts` | Find localized texts |
-| `updateTexts` | Update assortment texts |
-
-#### Filters (`assortments.filters`)
-| Method | Description |
-|--------|-------------|
-| `findFilters` | Find filters for assortment |
-| `create` | Add filter to assortment |
-| `delete` | Remove filter |
-| `reorder` | Reorder filters |
-
-### Settings
-
-| Export | Description |
-|--------|-------------|
-| `assortmentsSettings` | Access assortment module settings |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `Assortment` | Assortment document type |
-| `AssortmentProduct` | Assortment-product link type |
-| `AssortmentLink` | Parent-child link type |
-| `AssortmentMedia` | Media attachment type |
-| `AssortmentsModule` | Module interface type |
-
-## Events
+Product links, child links, media, texts, and filters live in the `products`, `links`, `media`, `texts`, and `filters` submodules. Creation returns the assortment document; use its `_id` when linking products.
 
-| Event | Description |
-|-------|-------------|
-| `ASSORTMENT_CREATE` | Assortment created |
-| `ASSORTMENT_UPDATE` | Assortment updated |
-| `ASSORTMENT_REMOVE` | Assortment deleted |
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/assortments) for caching, tree ordering, options, and events. The [public exports](src/assortments-index.ts) and [module implementation](src/module/configureAssortmentsModule.ts) define the available types and methods.
 
 ## License
 

package/lib/module/configureAssortmentFiltersModule.js

@@ -18,7 +18,7 @@ export const configureAssortmentFiltersModule = ({ AssortmentFilters, }) => {
         },
         findFilterIds: async ({ assortmentId }) => {
             const filters = AssortmentFilters.find({ assortmentId }, {
-                sort: { sortKey: 1 },
+                sort: { sortKey: 1, _id: 1 },
                 projection: { filterId: 1 },
             }).map((filter) => filter.filterId);
             return filters.toArray();
@@ -41,7 +41,7 @@ export const configureAssortmentFiltersModule = ({ AssortmentFilters, }) => {
                 created: new Date(),
             };
             if (sortKey === undefined || sortKey === null) {
-                const lastAssortmentFilter = (await AssortmentFilters.findOne({ assortmentId }, { sort: { sortKey: -1 } })) || { sortKey: 0 };
+                const lastAssortmentFilter = (await AssortmentFilters.findOne({ assortmentId }, { sort: { sortKey: -1, _id: -1 } })) || { sortKey: 0 };
                 $setOnInsert.sortKey = lastAssortmentFilter.sortKey + 1;
             }
             else {

package/lib/module/configureAssortmentLinksModule.js

@@ -31,7 +31,7 @@ export const configureAssortmentLinksModule = ({ AssortmentLinks, invalidateCach
                 return [];
             const selector = selectors.length > 1 ? { $or: selectors } : selectors[0];
             const links = AssortmentLinks.find(selector, options || {
-                sort: { sortKey: 1 },
+                sort: { sortKey: 1, _id: 1 },
             });
             return links.toArray();
         },
@@ -41,7 +41,7 @@ export const configureAssortmentLinksModule = ({ AssortmentLinks, invalidateCach
                 resolveAssortmentLinks: async (id) => {
                     return AssortmentLinks.find({ childAssortmentId: id }, {
                         projection: { _id: 1, childAssortmentId: 1, parentAssortmentId: 1 },
-                        sort: { sortKey: 1, parentAssortmentId: 1 },
+                        sort: { sortKey: 1, parentAssortmentId: 1, _id: 1 },
                     }).toArray();
                 },
                 assortmentId: parentAssortmentId,
@@ -60,7 +60,7 @@ export const configureAssortmentLinksModule = ({ AssortmentLinks, invalidateCach
                 created: new Date(),
             };
             if (sortKey === undefined || sortKey === null) {
-                const lastAssortmentLink = (await AssortmentLinks.findOne({ parentAssortmentId }, { sort: { sortKey: -1 } })) || { sortKey: 0 };
+                const lastAssortmentLink = (await AssortmentLinks.findOne({ parentAssortmentId }, { sort: { sortKey: -1, _id: -1 } })) || { sortKey: 0 };
                 $setOnInsert.sortKey = lastAssortmentLink.sortKey + 1;
             }
             else {

package/lib/module/configureAssortmentMediaModule.js

@@ -54,7 +54,7 @@ export const configureAssortmentMediaModule = async ({ db }) => {
             const mediaList = AssortmentMedia.find(selector, {
                 skip: offset,
                 limit,
-                sort: { sortKey: 1 },
+                sort: { sortKey: 1, _id: 1 },
                 ...options,
             });
             return mediaList.toArray();
@@ -64,7 +64,7 @@ export const configureAssortmentMediaModule = async ({ db }) => {
                 const lastAssortmentMedia = (await AssortmentMedia.findOne({
                     assortmentId: doc.assortmentId,
                 }, {
-                    sort: { sortKey: -1 },
+                    sort: { sortKey: -1, _id: -1 },
                 })) || { sortKey: 0 };
                 sortKey = lastAssortmentMedia.sortKey + 1;
             }

package/lib/module/configureAssortmentProductsModule.d.ts

@@ -25,7 +25,7 @@ export declare const configureAssortmentProductsModule: ({ AssortmentProducts, i
         productId: string;
         assortmentIds: string[];
     }) => Promise<string[]>;
-    create: (doc: Omit<AssortmentProduct, "_id" | "created" | "sortKey"> & Partial<Pick<AssortmentProduct, "_id" | "created" | "sortKey">>, options?: {
+    create: (doc: Omit<AssortmentProduct, "_id" | "created" | "sortKey" | "tags"> & Partial<Pick<AssortmentProduct, "_id" | "created" | "sortKey" | "tags">>, options?: {
         skipInvalidation?: boolean;
     }) => Promise<mongodb.WithId<AssortmentProduct> | null>;
     delete: (assortmentProductId: string, options?: {

package/lib/module/configureAssortmentProductsModule.js

@@ -46,7 +46,7 @@ export const configureAssortmentProductsModule = ({ AssortmentProducts, invalida
                 assortmentId: { $in: assortmentIds },
                 productId: { $ne: productId },
             }, {
-                sort: { sortKey: 1 },
+                sort: { sortKey: 1, _id: 1 },
                 projection: { productId: 1 },
             }).toArray();
             return assortmentProducts.map((product) => product.productId);
@@ -69,7 +69,7 @@ export const configureAssortmentProductsModule = ({ AssortmentProducts, invalida
                 created: new Date(),
             };
             if (sortKey === undefined || sortKey === null) {
-                const lastAssortmentProduct = (await AssortmentProducts.findOne({ assortmentId }, { sort: { sortKey: -1 } })) || { sortKey: 0 };
+                const lastAssortmentProduct = (await AssortmentProducts.findOne({ assortmentId }, { sort: { sortKey: -1, _id: -1 } })) || { sortKey: 0 };
                 $setOnInsert.sortKey = lastAssortmentProduct.sortKey + 1;
             }
             else {

package/lib/module/configureAssortmentsModule.d.ts

@@ -52,6 +52,21 @@ export declare const configureAssortmentsModule: (moduleInput: ModuleInput<Assor
         skipInvalidation?: boolean;
     }) => Promise<mongodb.WithId<Assortment> | null>;
     invalidateCache: InvalidateCacheFn;
+    bulkDelete: (assortmentIds: string[]) => Promise<{
+        successIds: string[];
+        failedIds: string[];
+    }>;
+    bulkSetActive: (assortmentIds: string[], isActive: boolean) => Promise<{
+        successIds: string[];
+        failedIds: string[];
+    }>;
+    bulkUpdateTags: (assortmentIds: string[], { add, remove }: {
+        add?: string[];
+        remove?: string[];
+    }) => Promise<{
+        successIds: string[];
+        failedIds: string[];
+    }>;
     search: {
         findFilteredAssortments: ({ limit, offset, assortmentIds, assortmentSelector, sort, }: {
             assortmentIds: string[];
@@ -184,7 +199,7 @@ export declare const configureAssortmentsModule: (moduleInput: ModuleInput<Assor
             productId: string;
             assortmentIds: string[];
         }) => Promise<string[]>;
-        create: (doc: Omit<AssortmentProduct, "_id" | "created" | "sortKey"> & Partial<Pick<AssortmentProduct, "_id" | "created" | "sortKey">>, options?: {
+        create: (doc: Omit<AssortmentProduct, "_id" | "created" | "sortKey" | "tags"> & Partial<Pick<AssortmentProduct, "_id" | "created" | "sortKey" | "tags">>, options?: {
             skipInvalidation?: boolean;
         }) => Promise<mongodb.WithId<AssortmentProduct> | null>;
         delete: (assortmentProductId: string, options?: {

package/lib/module/configureAssortmentsModule.js

@@ -1,4 +1,4 @@
-import { SortDirection } from '@unchainedshop/utils';
+import { executeBulkOperation, SortDirection } from '@unchainedshop/utils';
 import { emit, registerEvents } from '@unchainedshop/events';
 import { generateDbFilterById, findPreservingIds, buildSortOptions, mongodb, generateDbObjectId, } from '@unchainedshop/mongodb';
 import { createLogger } from '@unchainedshop/logger';
@@ -10,7 +10,7 @@ import { configureAssortmentProductsModule } from "./configureAssortmentProducts
 import { configureAssortmentTextsModule } from "./configureAssortmentTextsModule.js";
 import { configureAssortmentMediaModule } from "./configureAssortmentMediaModule.js";
 import { makeAssortmentBreadcrumbsBuilder } from "../utils/breadcrumbs/makeAssortmentBreadcrumbsBuilder.js";
-const logger = createLogger('unchained:core');
+const logger = createLogger('unchained:core-assortments');
 const ASSORTMENT_EVENTS = ['ASSORTMENT_CREATE', 'ASSORTMENT_REMOVE', 'ASSORTMENT_UPDATE'];
 export const buildFindSelector = ({ assortmentIds, assortmentSelector, slugs, tags, includeLeaves = false, includeInactive = false, queryString, }) => {
     const selector = assortmentSelector || {};
@@ -49,12 +49,12 @@ export const configureAssortmentsModule = async (moduleInput) => {
         return AssortmentLinks.find({
             $or: [{ parentAssortmentId: assortment._id }, { childAssortmentId: assortment._id }],
         }, {
-            sort: { sortKey: 1 },
+            sort: { sortKey: 1, _id: 1 },
         }).toArray();
     };
     const findProductAssignments = async (assortmentId) => {
         return AssortmentProducts.find({ assortmentId }, {
-            sort: { sortKey: 1 },
+            sort: { sortKey: 1, _id: 1 },
         }).toArray();
     };
     const collectProductIdCacheTree = async (assortment) => {
@@ -123,6 +123,42 @@ export const configureAssortmentsModule = async (moduleInput) => {
         AssortmentTexts,
     });
     const assortmentMedia = await configureAssortmentMediaModule(moduleInput);
+    const updateAssortment = async (assortmentId, doc, options) => {
+        const assortment = await Assortments.findOneAndUpdate(generateDbFilterById(assortmentId), {
+            $set: {
+                updated: new Date(),
+                ...doc,
+            },
+        }, { returnDocument: 'after' });
+        if (!assortment)
+            return null;
+        await emit('ASSORTMENT_UPDATE', { assortmentId });
+        if (!options?.skipInvalidation) {
+            await invalidateCache({ assortmentIds: [assortmentId] });
+        }
+        return assortment;
+    };
+    const deleteAssortment = async (assortmentId, options) => {
+        await assortmentLinks.deleteMany({
+            $or: [{ parentAssortmentId: assortmentId }, { childAssortmentId: assortmentId }],
+        }, { skipInvalidation: true });
+        await assortmentProducts.deleteMany({ assortmentId }, { skipInvalidation: true });
+        await assortmentFilters.deleteMany({ assortmentId });
+        await assortmentTexts.deleteMany({ assortmentId });
+        await assortmentMedia.deleteMediaFiles({ assortmentId });
+        const deletedAssortment = await Assortments.findOneAndUpdate(generateDbFilterById(assortmentId), {
+            $set: {
+                deleted: new Date(),
+            },
+        }, { returnDocument: 'after' });
+        if (!deletedAssortment)
+            return null;
+        if (!options?.skipInvalidation) {
+            await invalidateCache({}, { skipUpstreamTraversal: true });
+        }
+        await emit('ASSORTMENT_REMOVE', { assortmentId });
+        return deletedAssortment;
+    };
     return {
         findAssortment: async ({ assortmentId, slug }) => {
             let selector = {};
@@ -166,7 +202,7 @@ export const configureAssortmentsModule = async (moduleInput) => {
         children: async ({ assortmentId, includeInactive, }) => {
             const links = await AssortmentLinks.find({ parentAssortmentId: assortmentId }, {
                 projection: { childAssortmentId: 1 },
-                sort: { sortKey: 1 },
+                sort: { sortKey: 1, _id: 1 },
             }).toArray();
             const assortmentIds = links.map(({ childAssortmentId }) => childAssortmentId);
             const selector = !includeInactive ? { isActive: true } : {};
@@ -182,12 +218,12 @@ export const configureAssortmentsModule = async (moduleInput) => {
         breadcrumbs: async (params, { resolveAssortmentLinks = async (id) => {
             return AssortmentLinks.find({ childAssortmentId: id }, {
                 projection: { _id: 1, childAssortmentId: 1, parentAssortmentId: 1 },
-                sort: { sortKey: 1, parentAssortmentId: 1 },
+                sort: { sortKey: 1, parentAssortmentId: 1, _id: 1 },
             }).toArray();
         }, resolveAssortmentProducts = async (id) => {
             return AssortmentProducts.find({ productId: id }, {
                 projection: { _id: true, assortmentId: true, productId: true },
-                sort: { sortKey: 1, productId: 1 },
+                sort: { sortKey: 1, productId: 1, _id: 1 },
             }).toArray();
         }, }) => {
             const buildBreadcrumbs = makeAssortmentBreadcrumbsBuilder({
@@ -212,43 +248,39 @@ export const configureAssortmentsModule = async (moduleInput) => {
             await emit('ASSORTMENT_CREATE', { assortment });
             return assortment;
         },
-        update: async (assortmentId, doc, options) => {
-            const assortment = await Assortments.findOneAndUpdate(generateDbFilterById(assortmentId), {
-                $set: {
-                    updated: new Date(),
-                    ...doc,
-                },
-            }, { returnDocument: 'after' });
-            if (!assortment)
-                return null;
-            await emit('ASSORTMENT_UPDATE', { assortmentId });
-            if (!options?.skipInvalidation) {
-                await invalidateCache({ assortmentIds: [assortmentId] });
-            }
-            return assortment;
+        update: updateAssortment,
+        delete: deleteAssortment,
+        invalidateCache,
+        bulkDelete: async (assortmentIds) => {
+            return executeBulkOperation(assortmentIds, async (assortmentId) => {
+                const assortment = await Assortments.findOne({ _id: assortmentId, deleted: null }, {});
+                if (!assortment)
+                    throw new Error('not-found');
+                if (!(await deleteAssortment(assortmentId))) {
+                    throw new Error('delete-failed');
+                }
+            });
         },
-        delete: async (assortmentId, options) => {
-            await assortmentLinks.deleteMany({
-                $or: [{ parentAssortmentId: assortmentId }, { childAssortmentId: assortmentId }],
-            }, { skipInvalidation: true });
-            await assortmentProducts.deleteMany({ assortmentId }, { skipInvalidation: true });
-            await assortmentFilters.deleteMany({ assortmentId });
-            await assortmentTexts.deleteMany({ assortmentId });
-            await assortmentMedia.deleteMediaFiles({ assortmentId });
-            const deletedAssortment = await Assortments.findOneAndUpdate(generateDbFilterById(assortmentId), {
-                $set: {
-                    deleted: new Date(),
-                },
-            }, { returnDocument: 'after' });
-            if (!deletedAssortment)
-                return null;
-            if (!options?.skipInvalidation) {
-                await invalidateCache({}, { skipUpstreamTraversal: true });
-            }
-            await emit('ASSORTMENT_REMOVE', { assortmentId });
-            return deletedAssortment;
+        bulkSetActive: async (assortmentIds, isActive) => executeBulkOperation(assortmentIds, async (assortmentId) => {
+            const assortment = await Assortments.findOne({ _id: assortmentId, deleted: null }, {});
+            if (!assortment)
+                throw new Error('not-found');
+            await updateAssortment(assortmentId, { isActive });
+        }),
+        bulkUpdateTags: async (assortmentIds, { add = [], remove = [] }) => {
+            const tagsToRemove = new Set(remove);
+            return executeBulkOperation(assortmentIds, async (assortmentId) => {
+                const assortment = await Assortments.findOne({ _id: assortmentId, deleted: null }, {});
+                if (!assortment)
+                    throw new Error('not-found');
+                const tags = (assortment.tags || []).filter((tag) => !tagsToRemove.has(tag));
+                for (const tag of add) {
+                    if (!tags.includes(tag))
+                        tags.push(tag);
+                }
+                await updateAssortment(assortmentId, { tags });
+            });
         },
-        invalidateCache,
         search: {
             findFilteredAssortments: async ({ limit, offset, assortmentIds, assortmentSelector, sort, }) => {
                 const assortments = await findPreservingIds(Assortments)(assortmentSelector, assortmentIds, {

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@unchainedshop/core-assortments",
   "description": "Assortment and category management module for the Unchained Engine",
-  "version": "4.8.29",
+  "version": "5.0.0-alpha.10",
+  "files": [
+    "lib"
+  ],
   "main": "lib/assortments-index.js",
   "types": "lib/assortments-index.d.ts",
   "type": "module",
@@ -35,13 +38,13 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^4.8.27",
-    "@unchainedshop/logger": "^4.8.27",
-    "@unchainedshop/mongodb": "^4.8.27",
-    "@unchainedshop/utils": "^4.8.27"
+    "@unchainedshop/events": "^5.0.0-alpha.10",
+    "@unchainedshop/logger": "^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"
   }
 }