asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat(medusa, medusa-js, medusa-react): Start implementing remove batch products on a sales channel (#1842)

Browse Source 
What
Support sales channel remove product batch in medusa, medusa-js and medusa-react

How
By implementing a new endpoint and the associated service method as well as the repository methods.

Medusa-js new removeProductd method in the resource

Medusa-react new hook in the mutations

Tests

Endpoint test
Service test
Integration test
Hook tests

Fixes CORE-292
This commit is contained in:
Adrien de Peretti
2022-07-13 21:40:23 +02:00
committed by GitHub
parent 7162972318
commit cdd91974f9
19 changed files with 396 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
integration-tests/api/__tests__/admin/sales-channels.js
View File

@@ -1,6 +1,6 @@
const path = require("path")
const { SalesChannel } = require("@medusajs/medusa")
const { SalesChannel, Product } = require("@medusajs/medusa")
const { useApi } = require("../../../helpers/use-api")
const { useDb } = require("../../../helpers/use-db")
@@ -657,4 +657,91 @@ describe("sales channels", () => {
})
})
})
describe("DELETE /admin/sales-channels/:id/products/batch", () => {
let salesChannel
let product
beforeEach(async() => {
try {
await adminSeeder(dbConnection)
salesChannel = await simpleSalesChannelFactory(dbConnection, {
name: "test name",
description: "test description",
})
product = await simpleProductFactory(dbConnection, {
id: "product_1",
title: "test title",
})
await dbConnection.manager.query(`
INSERT INTO product_sales_channel VALUES ('${product.id}', '${salesChannel.id}')
`)
} catch (e) {
console.error(e)
}
})
afterEach(async () => {
const db = useDb()
await db.teardown()
})
it("should remove products from a sales channel", async() => {
const api = useApi()
let attachedProduct = await dbConnection.manager.findOne(Product, {
where: { id: product.id },
relations: ["sales_channels"]
})
expect(attachedProduct.sales_channels.length).toBe(1)
expect(attachedProduct.sales_channels).toEqual(
expect.arrayContaining([
expect.objectContaining({
id: expect.any(String),
name: "test name",
description: "test description",
is_disabled: false,
})
])
)
const payload = {
product_ids: [{ id: product.id }]
}
await api.delete(
`/admin/sales-channels/${salesChannel.id}/products/batch`,
{
...adminReqConfig,
data: payload,
},
)
// Validate idempotency
const response = await api.delete(
`/admin/sales-channels/${salesChannel.id}/products/batch`,
{
...adminReqConfig,
data: payload,
},
)
expect(response.status).toEqual(200)
expect(response.data.sales_channel).toEqual(
expect.objectContaining({
id: expect.any(String),
name: "test name",
description: "test description",
is_disabled: false,
})
)
attachedProduct = await dbConnection.manager.findOne(Product, {
where: { id: product.id },
relations: ["sales_channels"]
})
expect(attachedProduct.sales_channels.length).toBe(0)
})
})
})

6
integration-tests/api/package.json
View File

@@ -8,16 +8,16 @@
"build": "babel src -d dist --extensions \".ts,.js\""
},
"dependencies": {
"@medusajs/medusa": "1.3.4-dev-1657640917765",
"@medusajs/medusa": "1.3.4-dev-1657702785042",
"faker": "^5.5.3",
"medusa-interfaces": "1.3.1-dev-1657640917765",
"medusa-interfaces": "1.3.1-dev-1657702785042",
"typeorm": "^0.2.31"
},
"devDependencies": {
"@babel/cli": "^7.12.10",
"@babel/core": "^7.12.10",
"@babel/node": "^7.12.10",
"babel-preset-medusa-package": "1.1.19-dev-1657640917765",
"babel-preset-medusa-package": "1.1.19-dev-1657702785042",
"jest": "^26.6.3"
}
}

243
integration-tests/api/yarn.lock
View File

@@ -1,3 +1,6 @@
# This file is generated by running "yarn install" inside your project.
# Manual changes might be lost - proceed with caution!
__metadata:
version: 6
cacheKey: 8c0
@@ -1822,9 +1825,9 @@ __metadata:
languageName: node
linkType: hard
"@medusajs/medusa-cli@npm:1.3.1-dev-1657570841696":
version: 1.3.1-dev-1657570841696
resolution: "@medusajs/medusa-cli@npm:1.3.1-dev-1657570841696"
"@medusajs/medusa-cli@npm:1.3.1-dev-1657702785042":
version: 1.3.1-dev-1657702785042
resolution: "@medusajs/medusa-cli@npm:1.3.1-dev-1657702785042"
dependencies:
"@babel/polyfill": ^7.8.7
"@babel/runtime": ^7.9.6
@@ -1842,8 +1845,8 @@ __metadata:
is-valid-path: ^0.1.1
joi-objectid: ^3.0.1
meant: ^1.0.1
medusa-core-utils: 1.1.31-dev-1657570841696
medusa-telemetry: 0.0.11-dev-1657570841696
medusa-core-utils: 1.1.31-dev-1657702785042
medusa-telemetry: 0.0.11-dev-1657702785042
netrc-parser: ^3.1.6
open: ^8.0.6
ora: ^5.4.1
@@ -1858,56 +1861,16 @@ __metadata:
yargs: ^15.3.1
bin:
medusa: cli.js
checksum: 5053ef0c1637be0830bb02c410d3734d030e361b05e5af06ef1a981e8a320206f0d4e050504f9b5e976af95fbabcb346bb6abfe7ccfbe52ecf09afa47e9268d7
checksum: c673a45a6672ff4e6386f948d13b54e7c8f2336330c922b1949b4f09870a4c9a3ab87b46bbb5c66f4b49782ad64c06dd508e7c4f46f9bc6052c4fd1c6cae01fc
languageName: node
linkType: hard
"@medusajs/medusa-cli@npm:1.3.1-dev-1657640917765":
version: 1.3.1-dev-1657640917765
resolution: "@medusajs/medusa-cli@npm:1.3.1-dev-1657640917765"
dependencies:
"@babel/polyfill": ^7.8.7
"@babel/runtime": ^7.9.6
"@hapi/joi": ^16.1.8
axios: ^0.21.1
chalk: ^4.0.0
configstore: 5.0.1
core-js: ^3.6.5
dotenv: ^8.2.0
execa: ^5.1.1
fs-exists-cached: ^1.0.0
fs-extra: ^10.0.0
hosted-git-info: ^4.0.2
inquirer: ^8.0.0
is-valid-path: ^0.1.1
joi-objectid: ^3.0.1
meant: ^1.0.1
medusa-core-utils: 1.1.31-dev-1657640917765
medusa-telemetry: 0.0.11-dev-1657640917765
netrc-parser: ^3.1.6
open: ^8.0.6
ora: ^5.4.1
pg-god: ^1.0.11
prompts: ^2.4.1
regenerator-runtime: ^0.13.5
resolve-cwd: ^3.0.0
stack-trace: ^0.0.10
ulid: ^2.3.0
url: ^0.11.0
winston: ^3.3.3
yargs: ^15.3.1
bin:
medusa: cli.js
checksum: 5b4cced1f73e6ab2e2650153c916983bccf78a1c52047076825177b49fa0e359337082796091e8e91cd9ccb3f9a04453f57b927af482a3ae53df0f4c6c7b428f
languageName: node
linkType: hard
"@medusajs/medusa@npm:1.3.3-dev-1657570841696":
version: 1.3.3-dev-1657570841696
resolution: "@medusajs/medusa@npm:1.3.3-dev-1657570841696"
"@medusajs/medusa@npm:1.3.4-dev-1657702785042":
version: 1.3.4-dev-1657702785042
resolution: "@medusajs/medusa@npm:1.3.4-dev-1657702785042"
dependencies:
"@hapi/joi": ^16.1.8
"@medusajs/medusa-cli": 1.3.1-dev-1657570841696
"@medusajs/medusa-cli": 1.3.1-dev-1657702785042
"@types/lodash": ^4.14.168
awilix: ^4.2.3
body-parser: ^1.19.0
@@ -1930,8 +1893,8 @@ __metadata:
joi: ^17.3.0
joi-objectid: ^3.0.1
jsonwebtoken: ^8.5.1
medusa-core-utils: 1.1.31-dev-1657570841696
medusa-test-utils: 1.1.37-dev-1657570841696
medusa-core-utils: 1.1.31-dev-1657702785042
medusa-test-utils: 1.1.37-dev-1657702785042
morgan: ^1.9.1
multer: ^1.4.2
node-schedule: ^2.1.0
@@ -1956,65 +1919,7 @@ __metadata:
typeorm: 0.2.x
bin:
medusa: cli.js
checksum: b11b24ae6e83ea497777af333586f9989e7511140636e17a4d46612f56c7a6f33a7a6c7f6ae613d846c31882c74e30c05dc6b432e000956b22eac9fdeb1f63e1
languageName: node
linkType: hard
"@medusajs/medusa@npm:1.3.4-dev-1657640917765":
version: 1.3.4-dev-1657640917765
resolution: "@medusajs/medusa@npm:1.3.4-dev-1657640917765"
dependencies:
"@hapi/joi": ^16.1.8
"@medusajs/medusa-cli": 1.3.1-dev-1657640917765
"@types/lodash": ^4.14.168
awilix: ^4.2.3
body-parser: ^1.19.0
bull: ^3.12.1
chokidar: ^3.4.2
class-transformer: ^0.5.1
class-validator: ^0.13.1
connect-redis: ^5.0.0
cookie-parser: ^1.4.4
core-js: ^3.6.5
cors: ^2.8.5
cross-spawn: ^7.0.3
express: ^4.17.1
express-session: ^1.17.1
fs-exists-cached: ^1.0.0
glob: ^7.1.6
ioredis: ^4.17.3
ioredis-mock: ^5.6.0
iso8601-duration: ^1.3.0
joi: ^17.3.0
joi-objectid: ^3.0.1
jsonwebtoken: ^8.5.1
medusa-core-utils: 1.1.31-dev-1657640917765
medusa-test-utils: 1.1.37-dev-1657640917765
morgan: ^1.9.1
multer: ^1.4.2
node-schedule: ^2.1.0
papaparse: ^5.3.2
passport: ^0.4.0
passport-http-bearer: ^1.0.1
passport-jwt: ^4.0.0
passport-local: ^1.0.0
pg: ^8.5.1
randomatic: ^3.1.1
redis: ^3.0.2
reflect-metadata: ^0.1.13
request-ip: ^2.1.3
resolve-cwd: ^3.0.0
scrypt-kdf: ^2.0.1
sqlite3: ^5.0.2
ulid: ^2.3.0
uuid: ^8.3.1
winston: ^3.2.1
peerDependencies:
medusa-interfaces: 1.x
typeorm: 0.2.x
bin:
medusa: cli.js
checksum: b8dddae36fbd6bf131804f775bfcfbb208ae81526237647be3afbbb715666bb3b049476e5b2caea9ce010eef764e63f19ed96900f9d7e4d84e76d926a7097519
checksum: 92417fdb17c77f04feb07dd02a81041288dbdfabc03e4e945ba7a50c6df951f694ccf5282128df0b6832e4f9182f9e4eac642a75c4896057df7351cc52420a44
languageName: node
linkType: hard
@@ -2586,11 +2491,11 @@ __metadata:
"@babel/cli": ^7.12.10
"@babel/core": ^7.12.10
"@babel/node": ^7.12.10
"@medusajs/medusa": 1.3.3-dev-1657570841696
babel-preset-medusa-package: 1.1.19-dev-1657570841696
"@medusajs/medusa": 1.3.4-dev-1657702785042
babel-preset-medusa-package: 1.1.19-dev-1657702785042
faker: ^5.5.3
jest: ^26.6.3
medusa-interfaces: 1.3.1-dev-1657570841696
medusa-interfaces: 1.3.1-dev-1657702785042
typeorm: ^0.2.31
languageName: unknown
linkType: soft
@@ -2897,9 +2802,9 @@ __metadata:
languageName: node
linkType: hard
"babel-preset-medusa-package@npm:1.1.19-dev-1657570841696":
version: 1.1.19-dev-1657570841696
resolution: "babel-preset-medusa-package@npm:1.1.19-dev-1657570841696"
"babel-preset-medusa-package@npm:1.1.19-dev-1657702785042":
version: 1.1.19-dev-1657702785042
resolution: "babel-preset-medusa-package@npm:1.1.19-dev-1657702785042"
dependencies:
"@babel/plugin-proposal-class-properties": ^7.12.1
"@babel/plugin-proposal-decorators": ^7.12.1
@@ -2913,27 +2818,7 @@ __metadata:
core-js: ^3.7.0
peerDependencies:
"@babel/core": ^7.11.6
checksum: 60802948b9e278ea047f3c51d3a2aa903599408f2cd38f79dcf75219163055100475cb564ef11189afa3564ad3cdecea7a1bd571f26a4b4450e914772102cb06
languageName: node
linkType: hard
"babel-preset-medusa-package@npm:1.1.19-dev-1657640917765":
version: 1.1.19-dev-1657640917765
resolution: "babel-preset-medusa-package@npm:1.1.19-dev-1657640917765"
dependencies:
"@babel/plugin-proposal-class-properties": ^7.12.1
"@babel/plugin-proposal-decorators": ^7.12.1
"@babel/plugin-proposal-optional-chaining": ^7.14.2
"@babel/plugin-transform-classes": ^7.12.1
"@babel/plugin-transform-instanceof": ^7.12.1
"@babel/plugin-transform-runtime": ^7.12.1
"@babel/preset-env": ^7.12.7
"@babel/preset-typescript": ^7.16.0
babel-plugin-transform-typescript-metadata: ^0.3.1
core-js: ^3.7.0
peerDependencies:
"@babel/core": ^7.11.6
checksum: 90a06e48c635324eebd6f6570165a010831581e607febd315d3e6a8f53e031c2e038e7bc91481a56b3b777bd1ab8a5807f0e829d6105650425a6c97b1d7effb1
checksum: 25a1dce0c9e5ee943423b58ff9ce017e0a55d4df6f2254080cb6e6a19164c9b492469cabeef6a8bdb335c038b0a97072f4b734889a70a878c4fbe7aef9eff81f
languageName: node
linkType: hard
@@ -7066,49 +6951,29 @@ __metadata:
languageName: node
linkType: hard
"medusa-core-utils@npm:1.1.31-dev-1657570841696":
version: 1.1.31-dev-1657570841696
resolution: "medusa-core-utils@npm:1.1.31-dev-1657570841696"
"medusa-core-utils@npm:1.1.31-dev-1657702785042":
version: 1.1.31-dev-1657702785042
resolution: "medusa-core-utils@npm:1.1.31-dev-1657702785042"
dependencies:
joi: ^17.3.0
joi-objectid: ^3.0.1
checksum: 537715c197a15390a644f62db975391454aa56c5c9f41c070059dd167c84982256d1a1b37ecd4cc5abaae784ec0337ee1cab4694797d2946273b882e94d94c1c
checksum: 6b274a47d4f3c3f80e2f49dc890e5026410bec7667062da80bfa8120b5d8ea4220dac62a61954be1405dbb154145cc5dc0aea525bde70479f121f3b648968e95
languageName: node
linkType: hard
"medusa-core-utils@npm:1.1.31-dev-1657640917765":
version: 1.1.31-dev-1657640917765
resolution: "medusa-core-utils@npm:1.1.31-dev-1657640917765"
dependencies:
joi: ^17.3.0
joi-objectid: ^3.0.1
checksum: e1876edfc47fea693c4d1c2efdc30769d07f6a58359db5834e247933101276b0fbdd60303fd5dbec492788bc45759dcf3c8c8c4d0a5b086be9715e6ba016270c
languageName: node
linkType: hard
"medusa-interfaces@npm:1.3.1-dev-1657570841696":
version: 1.3.1-dev-1657570841696
resolution: "medusa-interfaces@npm:1.3.1-dev-1657570841696"
"medusa-interfaces@npm:1.3.1-dev-1657702785042":
version: 1.3.1-dev-1657702785042
resolution: "medusa-interfaces@npm:1.3.1-dev-1657702785042"
peerDependencies:
medusa-core-utils: ^1.1.31
typeorm: 0.x
checksum: e226125007cb40c7015c46d4d081efeaaea9ce96277093052af02c7c3603366c36e3bb06192d5fb164a4bf344f7e785201e5f063c00d966f878f8b2ccb12e183
checksum: 4974a170a5c6dc1b30456e3e0004865bd7f0b69c6ab31bc82f0130620e350f36a7b72f88a3fdce0796b0d6cb3cad88ee0e4d2f43107d0193f1a32b2abaadabfd
languageName: node
linkType: hard
"medusa-interfaces@npm:1.3.1-dev-1657640917765":
version: 1.3.1-dev-1657640917765
resolution: "medusa-interfaces@npm:1.3.1-dev-1657640917765"
peerDependencies:
medusa-core-utils: ^1.1.31
typeorm: 0.x
checksum: 92c905f39f813d2e8add30aa41e96cb65dcdc88de0aba5891c71f190428a93cfefbc358e73604d5b0f1ff7eb22d39ed45d79ad1caac1c86bfea4cec46018ffa5
languageName: node
linkType: hard
"medusa-telemetry@npm:0.0.11-dev-1657570841696":
version: 0.0.11-dev-1657570841696
resolution: "medusa-telemetry@npm:0.0.11-dev-1657570841696"
"medusa-telemetry@npm:0.0.11-dev-1657702785042":
version: 0.0.11-dev-1657702785042
resolution: "medusa-telemetry@npm:0.0.11-dev-1657702785042"
dependencies:
axios: ^0.21.1
axios-retry: ^3.1.9
@@ -7119,46 +6984,18 @@ __metadata:
is-docker: ^2.2.1
remove-trailing-slash: ^0.1.1
uuid: ^8.3.2
checksum: ee9223fbd54b4bf7a036710aa56de98afa6977877255dcee5f919575343c804efa6655cf69f5b68c876f16bba3bfe027bb556158542aa04bfa49ebe9179f4c6c
checksum: 4fd88357c8270318ecb7b7838735a43660e8c3b480af367f5be34b26e7bb97f974ac05decd602b75b16b98ac36bb2d43bb675a0db29107b387fd0aa1b22c4c12
languageName: node
linkType: hard
"medusa-telemetry@npm:0.0.11-dev-1657640917765":
version: 0.0.11-dev-1657640917765
resolution: "medusa-telemetry@npm:0.0.11-dev-1657640917765"
dependencies:
axios: ^0.21.1
axios-retry: ^3.1.9
boxen: ^5.0.1
ci-info: ^3.2.0
configstore: 5.0.1
global: ^4.4.0
is-docker: ^2.2.1
remove-trailing-slash: ^0.1.1
uuid: ^8.3.2
checksum: 3831eb0494456ed74cc8247ab4ec80967b9c5075325a49d789f740727ec459feec1ddd7e91381728919d13dd151a6384161531ee28c1fb4c78ee4dbb4167bf68
languageName: node
linkType: hard
"medusa-test-utils@npm:1.1.37-dev-1657570841696":
version: 1.1.37-dev-1657570841696
resolution: "medusa-test-utils@npm:1.1.37-dev-1657570841696"
"medusa-test-utils@npm:1.1.37-dev-1657702785042":
version: 1.1.37-dev-1657702785042
resolution: "medusa-test-utils@npm:1.1.37-dev-1657702785042"
dependencies:
"@babel/plugin-transform-classes": ^7.9.5
medusa-core-utils: 1.1.31-dev-1657570841696
medusa-core-utils: 1.1.31-dev-1657702785042
randomatic: ^3.1.1
checksum: adc49e171186b1850c8d5aea54913aad6f87eb8a7944da5bdf900582759864db5e93ad1afbfb75c920a900bdce9f3000878a39f72ad3cf3b8609e80b9f208ffd
languageName: node
linkType: hard
"medusa-test-utils@npm:1.1.37-dev-1657640917765":
version: 1.1.37-dev-1657640917765
resolution: "medusa-test-utils@npm:1.1.37-dev-1657640917765"
dependencies:
"@babel/plugin-transform-classes": ^7.9.5
medusa-core-utils: 1.1.31-dev-1657640917765
randomatic: ^3.1.1
checksum: c157e6ca31d73e209b59a8d692df1dcf3fcdf0178132969c93bc0097106c2a3958844884a201df7a3a7a8a76fb202b52257f8bb09f80dead6cf0bdf1ab723c83
checksum: 765a04eda78d974893f7186c9920f35691f3e9ec0d40b9a985b97b8b5fe9d6aa45b1bd3e305889616842ef1a1d6dcce1a4cea83fb91e6f38f1dda8dd4b0d9991
languageName: node
linkType: hard

17
packages/medusa-js/src/resources/admin/sales-channels.ts
View File

@@ -5,6 +5,7 @@ import {
AdminPostSalesChannelsSalesChannelReq,
AdminSalesChannelsDeleteRes,
AdminSalesChannelsListRes,
AdminDeleteSalesChannelsChannelProductsBatchReq,
} from "@medusajs/medusa"
import { ResponsePromise } from "../../typings"
import BaseResource from "../base"
@@ -87,6 +88,22 @@ class AdminSalesChannelsResource extends BaseResource {
const path = `/admin/sales-channels/${salesChannelId}`
return this.client.request("DELETE", path, {}, {}, customHeaders)
}
/**
* Remove products from a sales channel
* @experimental This feature is under development and may change in the future.
* To use this feature please enable featureflag `sales_channels` in your medusa backend project.
* @description Remove products from a sales channel
* @returns a medusa sales channel
*/
removeProducts(
salesChannelId: string,
payload: AdminDeleteSalesChannelsChannelProductsBatchReq,
customHeaders: Record<string, any> = {}
): ResponsePromise<AdminSalesChannelsRes> {
const path = `/admin/sales-channels/${salesChannelId}/products/batch`
return this.client.request("DELETE", path, payload, {}, customHeaders)
}
}
export default AdminSalesChannelsResource

9
packages/medusa-react/mocks/handlers/admin.ts
View File

@@ -1726,4 +1726,13 @@ export const adminHandlers = [
})
)
}),
rest.delete("/admin/sales-channels/:id/products/batch", (req, res, ctx) => {
return res(
ctx.status(200),
ctx.json({
sales_channel: fixtures.get("sales_channel"),
})
)
}),
]

31
packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts
View File

@@ -3,6 +3,7 @@ import {
AdminSalesChannelsRes,
AdminPostSalesChannelsSalesChannelReq,
AdminSalesChannelsDeleteRes,
AdminDeleteSalesChannelsChannelProductsBatchReq
} from "@medusajs/medusa"
import { Response } from "@medusajs/medusa-js"
import { useMutation, UseMutationOptions, useQueryClient } from "react-query"
@@ -87,3 +88,33 @@ export const useAdminDeleteSalesChannel = (
)
)
}
/**
* Remove products from a sales channel
* @experimental This feature is under development and may change in the future.
* To use this feature please enable featureflag `sales_channels` in your medusa backend project.
* @description remove products from a sales channel
* @param id
* @param options
*/
export const useAdminDeleteProductsFromSalesChannel = (
id: string,
options?: UseMutationOptions<
Response<AdminSalesChannelsRes>,
Error,
AdminDeleteSalesChannelsChannelProductsBatchReq
>
) => {
const { client } = useMedusa()
const queryClient = useQueryClient()
return useMutation(
(payload: AdminDeleteSalesChannelsChannelProductsBatchReq) => {
return client.admin.salesChannels.removeProducts(id, payload)
},
buildOptions(
queryClient,
[adminSalesChannelsKeys.lists(), adminSalesChannelsKeys.detail(id)],
options
)
)
}

23
packages/medusa-react/test/hooks/admin/sales-channels/mutations.test.ts
View File

@@ -4,6 +4,7 @@ import {
useAdminDeleteSalesChannel,
useAdminCreateSalesChannel,
useAdminUpdateSalesChannel,
useAdminDeleteProductsFromSalesChannel,
} from "../../../../src"
import { fixtures } from "../../../../mocks/data"
import { createWrapper } from "../../../utils"
@@ -84,3 +85,25 @@ describe("useAdminDeleteSalesChannel hook", () => {
)
})
})
describe("useAdminDeleteProductsFromSalesChannel hook", () => {
test("remove products from a sales channel", async () => {
const id = fixtures.get("sales_channel").id
const productId = fixtures.get("product").id
const { result, waitFor } = renderHook(
() => useAdminDeleteProductsFromSalesChannel(id),
{ wrapper: createWrapper() }
)
result.current.mutate({ product_ids: [
{ id: productId }
]})
await waitFor(() => result.current.isSuccess)
expect(result.current.data).toEqual(expect.objectContaining({
sales_channel: fixtures.get("sales_channel"),
}))
})
})

0
packages/medusa/src/api/routes/admin/sales-channels/__tests__/create-sales-channel.js → packages/medusa/src/api/routes/admin/sales-channels/__tests__/create-sales-channel.ts
View File

39
packages/medusa/src/api/routes/admin/sales-channels/__tests__/delete-products-batch.ts Normal file
View File

@@ -0,0 +1,39 @@
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/products/batch", () => {
describe("remove product from a sales channel", () => {
let subject
beforeAll(async () => {
subject = await request(
"DELETE",
`/admin/sales-channels/${IdMap.getId("sales_channel_1")}/products/batch`,
{
adminSession: {
jwt: {
userId: IdMap.getId("admin_user"),
},
},
payload: {
product_ids: [{ id: IdMap.getId("sales_channel_1_product_1") }]
},
flags: ["sales_channels"],
}
)
})
afterAll(() => {
jest.clearAllMocks()
})
it("calls the retrieve method from the sales channel service", () => {
expect(SalesChannelServiceMock.removeProducts).toHaveBeenCalledTimes(1)
expect(SalesChannelServiceMock.removeProducts).toHaveBeenCalledWith(
IdMap.getId("sales_channel_1"),
[IdMap.getId("sales_channel_1_product_1")]
)
})
})
})

0
packages/medusa/src/api/routes/admin/sales-channels/__tests__/delete-sales-channel.js → packages/medusa/src/api/routes/admin/sales-channels/__tests__/delete-sales-channel.ts
View File

0
packages/medusa/src/api/routes/admin/sales-channels/__tests__/get-sales-channel.js → packages/medusa/src/api/routes/admin/sales-channels/__tests__/get-sales-channel.ts
View File

0
packages/medusa/src/api/routes/admin/sales-channels/__tests__/update-sales-channel.js → packages/medusa/src/api/routes/admin/sales-channels/__tests__/update-sales-channel.ts
View File

50
packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts Normal file
View File

@@ -0,0 +1,50 @@
import { Type } from "class-transformer"
import { IsArray, ValidateNested } from "class-validator"
import { SalesChannelService } from "../../../../services"
import { Request, Response } from "express"
import { ProductBatchSalesChannel } from "../../../../types/sales-channels"
/**
* @oas [delete] /sales-channels/{id}/products/batch
* operationId: "DeleteSalesChannelsChannelProductsBatch"
* summary: "Remove a list of products from a sales channel"
* description: "Remove a list of products from a sales channel."
* x-authenticated: true
* parameters:
* - (path) id=* {string} The id of the customer group.
* - (body) product_ids=* {ProductBatchSalesChannel[]} ids of the product to remove
* tags:
* - Sales Channel
* responses:
* 200:
* description: OK
* content:
* application/json:
* schema:
* properties:
* sales_channel:
* $ref: "#/components/schemas/sales_channel"
*/
export default async (req: Request, res: Response) => {
const { id } = req.params
const salesChannelService: SalesChannelService = req.scope.resolve(
"salesChannelService"
)
const validatedBody =
req.validatedBody as AdminDeleteSalesChannelsChannelProductsBatchReq
const salesChannel = await salesChannelService.removeProducts(
id,
validatedBody.product_ids.map((p) => p.id)
)
res.status(200).json({ sales_channel: salesChannel })
}
export class AdminDeleteSalesChannelsChannelProductsBatchReq {
@IsArray()
@ValidateNested({ each: true })
@Type(() => ProductBatchSalesChannel)
product_ids: ProductBatchSalesChannel[]
}

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

@@ -10,6 +10,7 @@ import middlewares, {
import { AdminPostSalesChannelsSalesChannelReq } from "./update-sales-channel"
import { AdminPostSalesChannelsReq } from "./create-sales-channel"
import { AdminGetSalesChannelsParams } from "./list-sales-channels"
import { AdminDeleteSalesChannelsChannelProductsBatchReq } from "./delete-products-batch"
const route = Router()
@@ -40,6 +41,11 @@ export default (app) => {
transformBody(AdminPostSalesChannelsSalesChannelReq),
middlewares.wrap(require("./update-sales-channel").default)
)
salesChannelRouter.delete(
"/products/batch",
transformBody(AdminDeleteSalesChannelsChannelProductsBatchReq),
middlewares.wrap(require("./delete-products-batch").default)
)
route.post(
"/",
@@ -75,3 +81,4 @@ export * from "./create-sales-channel"
export * from "./list-sales-channels"
export * from "./update-sales-channel"
export * from "./delete-sales-channel"
export * from "./delete-products-batch"

18
packages/medusa/src/repositories/sales-channel.ts
View File

@@ -1,10 +1,10 @@
import { Brackets, EntityRepository, Repository } from "typeorm"
import { Brackets, DeleteResult, EntityRepository, In, Repository } from "typeorm"
import { SalesChannel } from "../models"
import { ExtendedFindConfig, Selector } from "../types/common";
@EntityRepository(SalesChannel)
export class SalesChannelRepository extends Repository<SalesChannel> {
public async getFreeTextSearchResultsAndCount(
public async getFreeTextSearchResultsAndCount(
q: string,
options: ExtendedFindConfig<SalesChannel, Selector<SalesChannel>> = { where: {} },
): Promise<[SalesChannel[], number]> {
@@ -30,4 +30,18 @@ export class SalesChannelRepository extends Repository<SalesChannel> {
return await qb.getManyAndCount()
}
async removeProducts(
salesChannelId: string,
productIds: string[]
): Promise<DeleteResult> {
return await this.createQueryBuilder()
.delete()
.from("product_sales_channel")
.where({
sales_channel_id: salesChannelId,
product_id: In(productIds),
})
.execute()
}
}

6
packages/medusa/src/services/__mocks__/sales-channel.js
View File

@@ -46,7 +46,11 @@ export const SalesChannelServiceMock = {
description: "sales channel 1 description",
is_disabled: false,
})
})
}),
removeProducts: jest.fn().mockImplementation((id, productIds) => {
return Promise.resolve()
}),
}
const mock = jest.fn().mockImplementation(() => {

48
packages/medusa/src/services/__tests__/sales-channel.ts
View File

@@ -44,13 +44,16 @@ describe("SalesChannelService", () => {
}),
}),
getFreeTextSearchResultsAndCount: jest.fn().mockImplementation(() =>
Promise.resolve([
{
id: IdMap.getId("sales_channel_1"),
...salesChannelData
},
]),
)
Promise.resolve([
{
id: IdMap.getId("sales_channel_1"),
...salesChannelData
},
]),
),
removeProducts: jest.fn().mockImplementation((id: string, productIds: string[]): any => {
return Promise.resolve()
}),
}
describe("create default", async () => {
@@ -290,4 +293,35 @@ describe("SalesChannelService", () => {
}
})
})
describe("Remove products", () => {
const salesChannelService = new SalesChannelService({
manager: MockManager,
eventBusService: EventBusServiceMock as unknown as EventBusService,
salesChannelRepository: salesChannelRepositoryMock,
storeService: StoreServiceMock as unknown as StoreService,
})
beforeEach(() => {
jest.clearAllMocks()
})
it('should remove a list of product to a sales channel', async () => {
const salesChannel = await salesChannelService.removeProducts(
IdMap.getId("sales_channel_1"),
[IdMap.getId("sales_channel_1_product_1")]
)
expect(salesChannelRepositoryMock.removeProducts).toHaveBeenCalledTimes(1)
expect(salesChannelRepositoryMock.removeProducts).toHaveBeenCalledWith(
IdMap.getId("sales_channel_1"),
[IdMap.getId("sales_channel_1_product_1")]
)
expect(salesChannel).toBeTruthy()
expect(salesChannel).toEqual({
id: IdMap.getId("sales_channel_1"),
...salesChannelData,
})
})
})
})

21
packages/medusa/src/services/sales-channel.ts
View File

@@ -244,6 +244,27 @@ class SalesChannelService extends TransactionBaseService<SalesChannelService> {
return defaultSalesChannel
})
}
/**
* Remove a batch of product from a sales channel
* @param salesChannelId - The id of the sales channel on which to remove the products
* @param productIds - The products ids to remove from the sales channel
* @return the sales channel on which the products have been removed
*/
async removeProducts(
salesChannelId: string,
productIds: string[]
): Promise<SalesChannel | never> {
return await this.atomicPhase_(async (transactionManager) => {
const salesChannelRepo = transactionManager.getCustomRepository(
this.salesChannelRepository_
)
await salesChannelRepo.removeProducts(salesChannelId, productIds)
return await this.retrieve(salesChannelId)
})
}
}
export default SalesChannelService

7
packages/medusa/src/types/sales-channels.ts
View File

@@ -1,4 +1,4 @@
import { SalesChannel } from "../models"
import { IsString } from "class-validator"
export type CreateSalesChannelInput = {
name: string
@@ -7,3 +7,8 @@ export type CreateSalesChannelInput = {
}
export type UpdateSalesChannelInput = Partial<CreateSalesChannelInput>
export class ProductBatchSalesChannel {
@IsString()
id: string
}