@unchainedshop/core-products 5.0.0-alpha.4 → 5.0.0-alpha.7

package/README.md

@@ -13,121 +13,26 @@ npm install @unchainedshop/core-products
 
 ## Usage
 
-```typescript
-import { configureProductsModule, ProductType } from '@unchainedshop/core-products';
+The platform initializes this module as `platform.unchainedAPI.modules.products`.
 
-const productsModule = await configureProductsModule({ db });
+```typescript
+import { ProductType } from '@unchainedshop/core-products';
 
-// Create a product
-const productId = await productsModule.create({
-  type: ProductType.SimpleProduct,
-  slugs: ['my-product'],
+const { products } = platform.unchainedAPI.modules;
+const product = await products.create({
+  type: ProductType.SIMPLE_PRODUCT,
+  tags: ['featured'],
 });
-
-// Find products
-const products = await productsModule.findProducts({
+await products.publish(product);
+const publishedProducts = await products.findProducts({
   tags: ['featured'],
   includeDrafts: false,
 });
-
-// Publish a product
-await productsModule.publish(productId);
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configureProductsModule` | Configure and return the products module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findProduct` | Find product by ID or slug |
-| `findProducts` | Find products with filtering and pagination |
-| `count` | Count products matching query |
-| `productExists` | Check if product exists |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a new product |
-| `update` | Update product data |
-| `delete` | Soft delete a product |
-| `publish` | Publish a draft product |
-| `unpublish` | Unpublish a product |
-| `addAssignment` | Add product proxy assignment |
-| `removeAssignment` | Remove product assignment |
-
-### Submodules
-
-#### Media (`products.media`)
-| Method | Description |
-|--------|-------------|
-| `findProductMedia` | Find media for a product |
-| `createMedia` | Add media to product |
-| `updateMedia` | Update media metadata |
-| `deleteMedia` | Remove media from product |
-| `reorderMedia` | Reorder product media |
-
-#### Prices (`products.prices`)
-| Method | Description |
-|--------|-------------|
-| `findProductPrices` | Get product prices |
-| `createPrice` | Add a price |
-| `updatePrice` | Update a price |
-| `deletePrice` | Remove a price |
-
-#### Reviews (`products.reviews`)
-| Method | Description |
-|--------|-------------|
-| `findProductReviews` | Find reviews for product |
-| `createReview` | Add a review |
-| `updateReview` | Update a review |
-| `deleteReview` | Remove a review |
-
-#### Texts (`products.texts`)
-| Method | Description |
-|--------|-------------|
-| `findProductTexts` | Find localized texts |
-| `updateTexts` | Update product texts |
-
-#### Variations (`products.variations`)
-| Method | Description |
-|--------|-------------|
-| `findProductVariations` | Find product variations |
-| `createVariation` | Add a variation |
-| `updateVariation` | Update a variation |
-| `deleteVariation` | Remove a variation |
-
-### Constants
-
-| Export | Description |
-|--------|-------------|
-| `ProductType` | Product types (SimpleProduct, ConfigurableProduct, BundleProduct, PlanProduct, TokenizedProduct) |
-| `ProductStatus` | Product status values (ACTIVE, DRAFT) |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `Product` | Product document type |
-| `ProductQuery` | Query parameters type |
-| `ProductsModule` | Module interface type |
-
-## Events
+`create` returns the product document, and `publish` accepts that document. The module exposes `media`, `prices`, `reviews`, `texts`, `variations`, `assignments`, and `bundleItems` submodules. Catalog prices are written as `commerce.pricing` entries with `minQuantity` tiers; computed pricing is coordinated by the core pricing services and plugins.
 
-| Event | Description |
-|-------|-------------|
-| `PRODUCT_CREATE` | Product created |
-| `PRODUCT_UPDATE` | Product updated |
-| `PRODUCT_REMOVE` | Product deleted |
-| `PRODUCT_PUBLISH` | Product published |
-| `PRODUCT_UNPUBLISH` | Product unpublished |
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/products), [pricing guide](https://docs.unchained.shop/concepts/pricing-system), [public exports](src/products-index.ts), and [module implementation](src/module/configureProductsModule.ts).
 
 ## License
 

package/lib/module/configureProductsModule.d.ts

@@ -119,6 +119,21 @@ export declare const configureProductsModule: (moduleInput: ModuleInput<Products
     }) => Promise<number>;
     publish: (product: Product) => Promise<boolean>;
     unpublish: (product: Product) => Promise<boolean>;
+    bulkPublish: (productIds: string[]) => Promise<{
+        successIds: string[];
+        failedIds: string[];
+    }>;
+    bulkUnpublish: (productIds: string[]) => Promise<{
+        successIds: string[];
+        failedIds: string[];
+    }>;
+    bulkUpdateTags: (productIds: string[], { add, remove }: {
+        add?: string[];
+        remove?: string[];
+    }) => Promise<{
+        successIds: string[];
+        failedIds: string[];
+    }>;
     assignments: {
         addProxyAssignment: ({ productId, proxyId, vectors, }: {
             productId: string;

package/lib/module/configureProductsModule.js

@@ -1,6 +1,6 @@
 import { emit, registerEvents } from '@unchainedshop/events';
 import { findPreservingIds, generateDbFilterById, buildSortOptions, mongodb, generateDbObjectId, } from '@unchainedshop/mongodb';
-import { SortDirection } from '@unchainedshop/utils';
+import { executeBulkOperation, SortDirection } from '@unchainedshop/utils';
 import { ProductsCollection, ProductStatus, ProductType, } from "../db/ProductsCollection.js";
 import { configureProductMediaModule } from "./configureProductMediaModule.js";
 import { configureProductPricesModule } from "./configureProductPrices.js";
@@ -126,6 +126,16 @@ export const configureProductsModule = async (moduleInput) => {
         }
         return false;
     };
+    const updateProduct = async (productId, doc) => {
+        const product = await Products.findOneAndUpdate(generateDbFilterById(productId), {
+            $set: {
+                updated: new Date(),
+                ...doc,
+            },
+        }, { returnDocument: 'after' });
+        await emit('PRODUCT_UPDATE', { productId, ...doc, product });
+        return productId;
+    };
     const proxyProducts = async (product, vectors = [], { includeInactive = false } = {}) => {
         const { proxy } = product;
         let filtered = [...(proxy?.assignments || [])];
@@ -260,17 +270,7 @@ export const configureProductsModule = async (moduleInput) => {
             await emit('PRODUCT_CREATE', { product });
             return product;
         },
-        update: async (productId, doc) => {
-            const updateDoc = doc;
-            const product = await Products.findOneAndUpdate(generateDbFilterById(productId), {
-                $set: {
-                    updated: new Date(),
-                    ...updateDoc,
-                },
-            }, { returnDocument: 'after' });
-            await emit('PRODUCT_UPDATE', { productId, ...updateDoc, product });
-            return productId;
-        },
+        update: updateProduct,
         firstActiveProductProxy: async (productId) => {
             return Products.findOne({ 'proxy.assignments.productId': productId });
         },
@@ -292,6 +292,31 @@ export const configureProductsModule = async (moduleInput) => {
         deleteProductPermanently,
         publish: publishProduct,
         unpublish: unpublishProduct,
+        bulkPublish: async (productIds) => executeBulkOperation(productIds, async (productId) => {
+            const product = await Products.findOne(generateDbFilterById(productId), {});
+            if (!product || !(await publishProduct(product)))
+                throw new Error('publish-failed');
+        }),
+        bulkUnpublish: async (productIds) => executeBulkOperation(productIds, async (productId) => {
+            const product = await Products.findOne(generateDbFilterById(productId), {});
+            if (!product || !(await unpublishProduct(product)))
+                throw new Error('unpublish-failed');
+        }),
+        bulkUpdateTags: async (productIds, { add = [], remove = [] }) => {
+            const tagsToRemove = new Set(remove);
+            return executeBulkOperation(productIds, async (productId) => {
+                const product = await Products.findOne(generateDbFilterById(productId), {});
+                if (!product || (product.status !== ProductStatus.ACTIVE && !isDraftStatus(product.status))) {
+                    throw new Error('not-found');
+                }
+                const tags = (product.tags || []).filter((tag) => !tagsToRemove.has(tag));
+                for (const tag of add) {
+                    if (!tags.includes(tag))
+                        tags.push(tag);
+                }
+                await updateProduct(productId, { tags });
+            });
+        },
         assignments: {
             addProxyAssignment: async ({ productId, proxyId, vectors, }) => {
                 const assignment = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unchainedshop/core-products",
   "description": "Product catalog management module for the Unchained Engine",
-  "version": "5.0.0-alpha.4",
+  "version": "5.0.0-alpha.7",
   "main": "lib/products-index.js",
   "types": "lib/products-index.d.ts",
   "type": "module",
@@ -35,10 +35,10 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^5.0.0-alpha.1",
-    "@unchainedshop/logger": "^5.0.0-alpha.1",
-    "@unchainedshop/mongodb": "^5.0.0-alpha.1",
-    "@unchainedshop/utils": "^5.0.0-alpha.1"
+    "@unchainedshop/events": "^5.0.0-alpha.7",
+    "@unchainedshop/logger": "^5.0.0-alpha.7",
+    "@unchainedshop/mongodb": "^5.0.0-alpha.7",
+    "@unchainedshop/utils": "^5.0.0-alpha.7"
   },
   "devDependencies": {
     "@types/node": "^26.2.0",