feat(medusa): batch remove products from a category (#3141)

* chore: added batch endpoint to remove products from categories * chore: remove consoles * Apply suggestions from code review Co-authored-by: Patrick <116003638+patrick-medusajs@users.noreply.github.com> * chore: added oas changes --------- Co-authored-by: Patrick <116003638+patrick-medusajs@users.noreply.github.com>
2023-01-31 10:23:03 +01:00
parent e3dcf4fd75
commit 5ec6d438fb
8 changed files with 354 additions and 7 deletions
@@ -50,10 +50,7 @@ import { FindParams } from "../../../../types/common"
 *     content:
 *       application/json:
 *         schema:
- *           type: object
- *           properties:
- *             product_category:
- *               $ref: "#/components/schemas/ProductCategory"
+ *           $ref: "#/components/schemas/AdminProductCategoriesRes"
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -0,0 +1,119 @@
+import { IsArray, ValidateNested } from "class-validator"
+import { Request, Response } from "express"
+
+import { EntityManager } from "typeorm"
+import { ProductBatchProductCategory } from "../../../../types/product-category"
+import { ProductCategoryService } from "../../../../services"
+import { Type } from "class-transformer"
+import { FindParams } from "../../../../types/common"
+
+/**
+ * @oas [delete] /product-categories/{id}/products/batch
+ * operationId: "DeleteProductCategoriesCategoryProductsBatch"
+ * summary: "Delete Products"
+ * description: "Remove a list of products from a product category."
+ * x-authenticated: true
+ * parameters:
+ *   - (path) id=* {string} The ID of the Product Category.
+ *   - (query) expand {string} (Comma separated) Category fields to be expanded in the response.
+ *   - (query) fields {string} (Comma separated) Category fields to be retrieved in the response.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq"
+ * x-codegen:
+ *   method: removeProducts
+ *   queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |
+ *       curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}/products/batch' \
+ *       --header 'Authorization: Bearer {api_token}' \
+ *       --header 'Content-Type: application/json' \
+ *       --data-raw '{
+ *           "product_ids": [
+ *             {
+ *               "id": "{product_id}"
+ *             }
+ *           ]
+ *       }'
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ * tags:
+ *   - Product Category
+ * responses:
+ *   200:
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           $ref: "#/components/schemas/AdminProductCategoriesRes"
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ */
+
+export default async (req: Request, res: Response) => {
+  const { id } = req.params
+  const validatedBody =
+    req.validatedBody as AdminDeleteProductCategoriesCategoryProductsBatchReq
+
+  const productCategoryService: ProductCategoryService = req.scope.resolve(
+    "productCategoryService"
+  )
+
+  const manager: EntityManager = req.scope.resolve("manager")
+  await manager.transaction(async (manager) => {
+    return await productCategoryService.withTransaction(manager).removeProducts(
+      id,
+      validatedBody.product_ids.map((p) => p.id)
+    )
+  })
+
+  const productCategory = await productCategoryService.retrieve(
+    id,
+    req.retrieveConfig
+  )
+
+  res.status(200).json({ product_category: productCategory })
+}
+
+/**
+ * @schema AdminDeleteProductCategoriesCategoryProductsBatchReq
+ * type: object
+ * required:
+ *   - product_ids
+ * properties:
+ *   product_ids:
+ *     description: The IDs of the products to delete from the Product Category.
+ *     type: array
+ *     items:
+ *       type: object
+ *       required:
+ *         - id
+ *       properties:
+ *         id:
+ *           description: The ID of a product
+ *           type: string
+ */
+export class AdminDeleteProductCategoriesCategoryProductsBatchReq {
+  @IsArray()
+  @ValidateNested({ each: true })
+  @Type(() => ProductBatchProductCategory)
+  product_ids: ProductBatchProductCategory[]
+}
+
+// eslint-disable-next-line max-len
+export class AdminDeleteProductCategoriesCategoryProductsBatchParams extends FindParams {}
@@ -32,6 +32,13 @@ import addProductsBatch, {
  AdminPostProductCategoriesCategoryProductsBatchParams,
 } from "./add-products-batch"

+import deleteProductsBatch, {
+  AdminDeleteProductCategoriesCategoryProductsBatchReq,
+  AdminDeleteProductCategoriesCategoryProductsBatchParams,
+} from "./delete-products-batch"
+
+import { ProductCategory } from "../../../../models"
+
 const route = Router()

 export default (app) => {
@@ -98,6 +105,17 @@ export default (app) => {
    middlewares.wrap(addProductsBatch)
  )

+  route.delete(
+    "/:id/products/batch",
+    transformQuery(
+      AdminDeleteProductCategoriesCategoryProductsBatchParams,
+      retrieveTransformQueryConfig
+    ),
+    transformBody(AdminDeleteProductCategoriesCategoryProductsBatchReq),
+    validateProductsExist((req) => req.body.product_ids),
+    middlewares.wrap(deleteProductsBatch)
+  )
+
  return app
 }

@@ -125,3 +143,14 @@ export const defaultProductCategoryFields = [
  "created_at",
  "updated_at",
 ]
+
+/**
+ * @schema AdminProductCategoriesRes
+ * type: object
+ * properties:
+ *   product_category:
+ *     $ref: "#/components/schemas/ProductCategory"
+ */
+export type AdminProductCategoriesRes = {
+  product_category: ProductCategory
+}