feat(medusa, medusa-js, medusa-react): Implement Sales Channel deletion (#1804)

packages/medusa/src/api/routes/admin/sales-channels/__tests__/delete-sales-channel.js

@@ -0,0 +1,43 @@
+import { IdMap } from "medusa-test-utils"
+import { request } from "../../../../../helpers/test-request"
+import { SalesChannelServiceMock } from "../../../../../services/__mocks__/sales-channel"
+
+describe("DELETE /admin/sales-channels/:id", () => {
+  describe("successfully delete a sales channel", () => {
+    let subject
+
+    beforeAll(async () => {
+      subject = await request(
+        "DELETE",
+        `/admin/sales-channels/${IdMap.getId("sales_channel_1")}`,
+        {
+          adminSession: {
+            jwt: {
+              userId: IdMap.getId("admin_user"),
+            },
+          },
+          flags: ["sales_channels"],
+        }
+      )
+    })
+
+    afterAll(() => {
+      jest.clearAllMocks()
+    })
+
+    it("calls the delete method from the sales channel service", () => {
+      expect(SalesChannelServiceMock.delete).toHaveBeenCalledTimes(1)
+      expect(SalesChannelServiceMock.delete).toHaveBeenCalledWith(
+        IdMap.getId("sales_channel_1"),
+      )
+    })
+
+    it("returns the expected result", () => {
+      expect(subject.body).toEqual({
+        id: IdMap.getId("sales_channel_1"),
+        object: "sales-channel",
+        deleted: true,
+      })
+    })
+  })
+})

packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts

@@ -0,0 +1,42 @@
+import { Request, Response } from "express"
+import { SalesChannelService } from "../../../../services/"
+
+/**
+ * @oas [delete] /sales-channels/{id}
+ * operationId: "DeleteSalesChannelsSalesChannel"
+ * summary: "Delete a sales channel"
+ * description: "Deletes the sales channel."
+ * x-authenticated: true
+ * parameters:
+ *   - (path) id=* {string} The id of the Sales channel.
+ * tags:
+ *   - Sales Channel
+ * responses:
+ *   200:
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           properties:
+ *             id:
+ *               type: string
+ *               description: The id of the deleted Sales Channel.
+ *             object:
+ *               type: string
+ *               description: The type of the object that was deleted.
+ *             deleted:
+ *               type: boolean
+ */
+export default async (req: Request, res: Response): Promise<void> => {
+  const { id } = req.params
+
+  const salesChannelService: SalesChannelService = req.scope.resolve(
+    "salesChannelService"
+  )
+  await salesChannelService.delete(id)
+  res.json({
+    id,
+    object: "sales-channel",
+    deleted: true,
+  })
+}

packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from "express"
-import SalesChannelService from "../../../../services/sales-channel"
+import { SalesChannelService } from "../../../../services"
 
 /**
  * @oas [get] /sales-channels/{id}

packages/medusa/src/api/routes/admin/sales-channels/index.ts

@@ -19,6 +19,10 @@ export default (app) => {
     "/",
     middlewares.wrap(require("./get-sales-channel").default)
   )
+  salesChannelRouter.delete(
+    "/",
+    middlewares.wrap(require("./delete-sales-channel").default)
+  )
 
   route.get("/", (req, res) => {})
 
@@ -34,7 +38,7 @@ export default (app) => {
     middlewares.wrap(require("./update-sales-channel").default)
   )
 
-  route.delete("/:id", (req, res) => {})
+
 
   return app
 }
@@ -43,7 +47,7 @@ export type AdminSalesChannelsRes = {
   sales_channel: SalesChannel
 }
 
-export type AdminSalesChannelDeleteRes = DeleteResponse
+export type AdminSalesChannelsDeleteRes = DeleteResponse
 
 export type AdminSalesChannelListRes = PaginatedResponse & {
   sales_channels: SalesChannel[]

packages/medusa/src/services/__mocks__/sales-channel.js

@@ -17,14 +17,16 @@ export const SalesChannelServiceMock = {
 
   listAndCount: jest.fn().mockImplementation(() => {}),
 
-  delete: jest.fn().mockImplementation(() => {}),
-
   create: jest.fn().mockImplementation((data) => {
     return Promise.resolve({
       id: id,
       ...data,
     })
   }),
+
+  delete: jest.fn().mockImplementation((id, config) => {
+    return Promise.resolve()
+  }),
 }
 
 const mock = jest.fn().mockImplementation(() => {

packages/medusa/src/services/__tests__/sales-channel.ts

@@ -28,6 +28,9 @@ describe("SalesChannelService", () => {
         }
       ),
     save: (salesChannel) => Promise.resolve(salesChannel),
+    softRemove: jest.fn().mockImplementation((id: string): any => {
+      return Promise.resolve()
+    }),
   })
 
   describe("retrieve", () => {
@@ -37,7 +40,7 @@ describe("SalesChannelService", () => {
       salesChannelRepository: salesChannelRepositoryMock,
     })
 
-    afterEach(() => {
+    beforeEach(() => {
       jest.clearAllMocks()
     })
 
@@ -92,4 +95,40 @@ describe("SalesChannelService", () => {
       })
     })
   })
+
+  describe("delete", () => {
+    const salesChannelService = new SalesChannelService({
+      manager: MockManager,
+      eventBusService: EventBusServiceMock as unknown as EventBusService,
+      salesChannelRepository: salesChannelRepositoryMock
+    })
+
+    beforeEach(() => {
+      jest.clearAllMocks()
+    })
+
+    it('should soft remove a sales channel', async () => {
+      const res = await salesChannelService.delete(
+        IdMap.getId("sales_channel_1")
+      )
+
+      expect(res).toBeUndefined()
+
+      expect(salesChannelRepositoryMock.softRemove)
+        .toHaveBeenCalledTimes(1)
+      expect(salesChannelRepositoryMock.softRemove)
+        .toHaveBeenLastCalledWith({
+          id: IdMap.getId("sales_channel_1"),
+          ...salesChannelData
+        })
+
+      expect(EventBusServiceMock.emit)
+        .toHaveBeenCalledTimes(1)
+      expect(EventBusServiceMock.emit)
+        .toHaveBeenLastCalledWith(
+          SalesChannelService.Events.DELETED,
+          { "id": IdMap.getId("sales_channel_1") }
+        )
+    })
+  })
 })

packages/medusa/src/services/sales-channel.ts

@@ -23,6 +23,7 @@ class SalesChannelService extends TransactionBaseService<SalesChannelService> {
   static Events = {
     UPDATED: "sales_channel.updated",
     CREATED: "sales_channel.created",
+    DELETED: "sales_channel.deleted",
   }
 
   protected manager_: EntityManager
@@ -55,8 +56,8 @@ class SalesChannelService extends TransactionBaseService<SalesChannelService> {
     salesChannelId: string,
     config: FindConfig<SalesChannel> = {}
   ): Promise<SalesChannel | never> {
-    return await this.atomicPhase_(async (manager) => {
-      const salesChannelRepo = manager.getCustomRepository(
+    return await this.atomicPhase_(async (transactionManager) => {
+      const salesChannelRepo = transactionManager.getCustomRepository(
         this.salesChannelRepository_
       )
 
@@ -139,8 +140,35 @@ class SalesChannelService extends TransactionBaseService<SalesChannelService> {
     })
   }
 
-  async delete(id: string): Promise<void> {
-    throw new Error("Method not implemented.")
+  /**
+   * Deletes a sales channel from
+   * @experimental This feature is under development and may change in the future.
+   * To use this feature please enable the corresponding feature flag in your medusa backend project.
+   * @param salesChannelId - the id of the sales channel to delete
+   * @return Promise<void>
+   */
+  async delete(salesChannelId: string): Promise<void> {
+    return await this.atomicPhase_(async (transactionManager) => {
+      const salesChannelRepo = transactionManager.getCustomRepository(
+        this.salesChannelRepository_
+      )
+
+      const salesChannel = await this.retrieve(salesChannelId).catch(
+        () => void 0
+      )
+
+      if (!salesChannel) {
+        return
+      }
+
+      await salesChannelRepo.softRemove(salesChannel)
+
+      await this.eventBusService_
+        .withTransaction(transactionManager)
+        .emit(SalesChannelService.Events.DELETED, {
+          id: salesChannelId,
+        })
+    })
   }
 }