chore(order): cancel order (#7586)
This commit is contained in:
@@ -69,7 +69,7 @@ medusaIntegrationTestRunner({
|
|||||||
{ throwIfKeyNotFound: true }
|
{ throwIfKeyNotFound: true }
|
||||||
)
|
)
|
||||||
|
|
||||||
expect(getNonExistingRegion).rejects.toThrow(
|
await expect(getNonExistingRegion).rejects.toThrow(
|
||||||
"region id not found: region_123"
|
"region id not found: region_123"
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
@@ -113,7 +113,7 @@ medusaIntegrationTestRunner({
|
|||||||
])
|
])
|
||||||
|
|
||||||
// Validate all relations, including the link
|
// Validate all relations, including the link
|
||||||
expect(
|
await expect(
|
||||||
remoteQuery(
|
remoteQuery(
|
||||||
{
|
{
|
||||||
region: {
|
region: {
|
||||||
@@ -136,7 +136,7 @@ medusaIntegrationTestRunner({
|
|||||||
)
|
)
|
||||||
|
|
||||||
// Only validate the relations with Payment. It doesn't fail because the link didn't return any data
|
// Only validate the relations with Payment. It doesn't fail because the link didn't return any data
|
||||||
expect(
|
await expect(
|
||||||
remoteQuery(
|
remoteQuery(
|
||||||
{
|
{
|
||||||
region: {
|
region: {
|
||||||
@@ -157,7 +157,7 @@ medusaIntegrationTestRunner({
|
|||||||
).resolves.toHaveLength(1)
|
).resolves.toHaveLength(1)
|
||||||
|
|
||||||
// The link exists, but the payment doesn't
|
// The link exists, but the payment doesn't
|
||||||
expect(
|
await expect(
|
||||||
remoteQuery(
|
remoteQuery(
|
||||||
{
|
{
|
||||||
region: {
|
region: {
|
||||||
@@ -180,7 +180,7 @@ medusaIntegrationTestRunner({
|
|||||||
)
|
)
|
||||||
|
|
||||||
// everything is fine
|
// everything is fine
|
||||||
expect(
|
await expect(
|
||||||
remoteQuery(
|
remoteQuery(
|
||||||
{
|
{
|
||||||
region: {
|
region: {
|
||||||
|
|||||||
@@ -25,7 +25,6 @@ jest.setTimeout(50000)
|
|||||||
const env = { MEDUSA_FF_MEDUSA_V2: true }
|
const env = { MEDUSA_FF_MEDUSA_V2: true }
|
||||||
|
|
||||||
medusaIntegrationTestRunner({
|
medusaIntegrationTestRunner({
|
||||||
debug: true,
|
|
||||||
env,
|
env,
|
||||||
testSuite: ({ dbConnection, getContainer, api }) => {
|
testSuite: ({ dbConnection, getContainer, api }) => {
|
||||||
let appContainer
|
let appContainer
|
||||||
|
|||||||
@@ -25,7 +25,6 @@ jest.setTimeout(50000)
|
|||||||
const env = { MEDUSA_FF_MEDUSA_V2: true }
|
const env = { MEDUSA_FF_MEDUSA_V2: true }
|
||||||
|
|
||||||
medusaIntegrationTestRunner({
|
medusaIntegrationTestRunner({
|
||||||
debug: true,
|
|
||||||
env,
|
env,
|
||||||
testSuite: ({ dbConnection, getContainer, api }) => {
|
testSuite: ({ dbConnection, getContainer, api }) => {
|
||||||
let appContainer
|
let appContainer
|
||||||
|
|||||||
@@ -0,0 +1,436 @@
|
|||||||
|
import {
|
||||||
|
cancelOrderFulfillmentWorkflow,
|
||||||
|
cancelOrderWorkflow,
|
||||||
|
createOrderFulfillmentWorkflow,
|
||||||
|
createShippingOptionsWorkflow,
|
||||||
|
} from "@medusajs/core-flows"
|
||||||
|
import { ModuleRegistrationName, Modules } from "@medusajs/modules-sdk"
|
||||||
|
import {
|
||||||
|
FulfillmentWorkflow,
|
||||||
|
IOrderModuleService,
|
||||||
|
IRegionModuleService,
|
||||||
|
IStockLocationServiceNext,
|
||||||
|
OrderWorkflow,
|
||||||
|
ProductDTO,
|
||||||
|
RegionDTO,
|
||||||
|
ShippingOptionDTO,
|
||||||
|
StockLocationDTO,
|
||||||
|
} from "@medusajs/types"
|
||||||
|
import {
|
||||||
|
ContainerRegistrationKeys,
|
||||||
|
remoteQueryObjectFromString,
|
||||||
|
} from "@medusajs/utils"
|
||||||
|
import { medusaIntegrationTestRunner } from "medusa-test-utils/dist"
|
||||||
|
|
||||||
|
jest.setTimeout(500000)
|
||||||
|
|
||||||
|
const env = { MEDUSA_FF_MEDUSA_V2: true }
|
||||||
|
const providerId = "manual_test-provider"
|
||||||
|
let inventoryItem
|
||||||
|
|
||||||
|
async function prepareDataFixtures({ container }) {
|
||||||
|
const fulfillmentService = container.resolve(
|
||||||
|
ModuleRegistrationName.FULFILLMENT
|
||||||
|
)
|
||||||
|
const salesChannelService = container.resolve(
|
||||||
|
ModuleRegistrationName.SALES_CHANNEL
|
||||||
|
)
|
||||||
|
const stockLocationModule: IStockLocationServiceNext = container.resolve(
|
||||||
|
ModuleRegistrationName.STOCK_LOCATION
|
||||||
|
)
|
||||||
|
const productModule = container.resolve(ModuleRegistrationName.PRODUCT)
|
||||||
|
const inventoryModule = container.resolve(ModuleRegistrationName.INVENTORY)
|
||||||
|
|
||||||
|
const shippingProfile = await fulfillmentService.createShippingProfiles({
|
||||||
|
name: "test",
|
||||||
|
type: "default",
|
||||||
|
})
|
||||||
|
|
||||||
|
const fulfillmentSet = await fulfillmentService.create({
|
||||||
|
name: "Test fulfillment set",
|
||||||
|
type: "manual_test",
|
||||||
|
})
|
||||||
|
|
||||||
|
const serviceZone = await fulfillmentService.createServiceZones({
|
||||||
|
name: "Test service zone",
|
||||||
|
fulfillment_set_id: fulfillmentSet.id,
|
||||||
|
geo_zones: [
|
||||||
|
{
|
||||||
|
type: "country",
|
||||||
|
country_code: "US",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
})
|
||||||
|
|
||||||
|
const regionService = container.resolve(
|
||||||
|
ModuleRegistrationName.REGION
|
||||||
|
) as IRegionModuleService
|
||||||
|
|
||||||
|
const [region] = await regionService.create([
|
||||||
|
{
|
||||||
|
name: "Test region",
|
||||||
|
currency_code: "eur",
|
||||||
|
countries: ["fr"],
|
||||||
|
},
|
||||||
|
])
|
||||||
|
|
||||||
|
const salesChannel = await salesChannelService.create({
|
||||||
|
name: "Webshop",
|
||||||
|
})
|
||||||
|
|
||||||
|
const location: StockLocationDTO = await stockLocationModule.create({
|
||||||
|
name: "Warehouse",
|
||||||
|
address: {
|
||||||
|
address_1: "Test",
|
||||||
|
city: "Test",
|
||||||
|
country_code: "US",
|
||||||
|
postal_code: "12345",
|
||||||
|
phone: "12345",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
const [product] = await productModule.create([
|
||||||
|
{
|
||||||
|
title: "Test product",
|
||||||
|
variants: [
|
||||||
|
{
|
||||||
|
title: "Test variant",
|
||||||
|
sku: "test-variant",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
])
|
||||||
|
|
||||||
|
inventoryItem = await inventoryModule.create({
|
||||||
|
sku: "inv-1234",
|
||||||
|
})
|
||||||
|
|
||||||
|
await inventoryModule.createInventoryLevels([
|
||||||
|
{
|
||||||
|
inventory_item_id: inventoryItem.id,
|
||||||
|
location_id: location.id,
|
||||||
|
stocked_quantity: 2,
|
||||||
|
reserved_quantity: 0,
|
||||||
|
},
|
||||||
|
])
|
||||||
|
|
||||||
|
const remoteLink = container.resolve(ContainerRegistrationKeys.REMOTE_LINK)
|
||||||
|
|
||||||
|
await remoteLink.create([
|
||||||
|
{
|
||||||
|
[Modules.STOCK_LOCATION]: {
|
||||||
|
stock_location_id: location.id,
|
||||||
|
},
|
||||||
|
[Modules.FULFILLMENT]: {
|
||||||
|
fulfillment_set_id: fulfillmentSet.id,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[Modules.SALES_CHANNEL]: {
|
||||||
|
sales_channel_id: salesChannel.id,
|
||||||
|
},
|
||||||
|
[Modules.STOCK_LOCATION]: {
|
||||||
|
stock_location_id: location.id,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[Modules.PRODUCT]: {
|
||||||
|
variant_id: product.variants[0].id,
|
||||||
|
},
|
||||||
|
[Modules.INVENTORY]: {
|
||||||
|
inventory_item_id: inventoryItem.id,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
])
|
||||||
|
|
||||||
|
const shippingOptionData: FulfillmentWorkflow.CreateShippingOptionsWorkflowInput =
|
||||||
|
{
|
||||||
|
name: "Shipping option",
|
||||||
|
price_type: "flat",
|
||||||
|
service_zone_id: serviceZone.id,
|
||||||
|
shipping_profile_id: shippingProfile.id,
|
||||||
|
provider_id: providerId,
|
||||||
|
type: {
|
||||||
|
code: "manual-type",
|
||||||
|
label: "Manual Type",
|
||||||
|
description: "Manual Type Description",
|
||||||
|
},
|
||||||
|
prices: [
|
||||||
|
{
|
||||||
|
currency_code: "usd",
|
||||||
|
amount: 10,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
region_id: region.id,
|
||||||
|
amount: 100,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
const { result } = await createShippingOptionsWorkflow(container).run({
|
||||||
|
input: [shippingOptionData],
|
||||||
|
})
|
||||||
|
|
||||||
|
const remoteQueryObject = remoteQueryObjectFromString({
|
||||||
|
entryPoint: "shipping_option",
|
||||||
|
variables: {
|
||||||
|
id: result[0].id,
|
||||||
|
},
|
||||||
|
fields: [
|
||||||
|
"id",
|
||||||
|
"name",
|
||||||
|
"price_type",
|
||||||
|
"service_zone_id",
|
||||||
|
"shipping_profile_id",
|
||||||
|
"provider_id",
|
||||||
|
"data",
|
||||||
|
"metadata",
|
||||||
|
"type.*",
|
||||||
|
"created_at",
|
||||||
|
"updated_at",
|
||||||
|
"deleted_at",
|
||||||
|
"shipping_option_type_id",
|
||||||
|
"prices.*",
|
||||||
|
],
|
||||||
|
})
|
||||||
|
|
||||||
|
const remoteQuery = container.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
|
||||||
|
|
||||||
|
const [createdShippingOption] = await remoteQuery(remoteQueryObject)
|
||||||
|
return {
|
||||||
|
shippingOption: createdShippingOption,
|
||||||
|
region,
|
||||||
|
salesChannel,
|
||||||
|
location,
|
||||||
|
product,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function createOrderFixture({ container, product, location }) {
|
||||||
|
const orderService: IOrderModuleService = container.resolve(
|
||||||
|
ModuleRegistrationName.ORDER
|
||||||
|
)
|
||||||
|
let order = await orderService.create({
|
||||||
|
region_id: "test_region_idclear",
|
||||||
|
email: "foo@bar.com",
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
title: "Custom Item 2",
|
||||||
|
variant_sku: product.variants[0].sku,
|
||||||
|
variant_title: product.variants[0].title,
|
||||||
|
quantity: 1,
|
||||||
|
unit_price: 50,
|
||||||
|
adjustments: [
|
||||||
|
{
|
||||||
|
code: "VIP_25 ETH",
|
||||||
|
amount: "0.000000000000000005",
|
||||||
|
description: "VIP discount",
|
||||||
|
promotion_id: "prom_123",
|
||||||
|
provider_id: "coupon_kings",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
} as any,
|
||||||
|
],
|
||||||
|
transactions: [
|
||||||
|
{
|
||||||
|
amount: 50,
|
||||||
|
currency_code: "usd",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
sales_channel_id: "test",
|
||||||
|
shipping_address: {
|
||||||
|
first_name: "Test",
|
||||||
|
last_name: "Test",
|
||||||
|
address_1: "Test",
|
||||||
|
city: "Test",
|
||||||
|
country_code: "US",
|
||||||
|
postal_code: "12345",
|
||||||
|
phone: "12345",
|
||||||
|
},
|
||||||
|
billing_address: {
|
||||||
|
first_name: "Test",
|
||||||
|
last_name: "Test",
|
||||||
|
address_1: "Test",
|
||||||
|
city: "Test",
|
||||||
|
country_code: "US",
|
||||||
|
postal_code: "12345",
|
||||||
|
},
|
||||||
|
shipping_methods: [
|
||||||
|
{
|
||||||
|
name: "Test shipping method",
|
||||||
|
amount: 10,
|
||||||
|
data: {},
|
||||||
|
tax_lines: [
|
||||||
|
{
|
||||||
|
description: "shipping Tax 1",
|
||||||
|
tax_rate_id: "tax_usa_shipping",
|
||||||
|
code: "code",
|
||||||
|
rate: 10,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
adjustments: [
|
||||||
|
{
|
||||||
|
code: "VIP_10",
|
||||||
|
amount: 1,
|
||||||
|
description: "VIP discount",
|
||||||
|
promotion_id: "prom_123",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
currency_code: "usd",
|
||||||
|
customer_id: "joe",
|
||||||
|
})
|
||||||
|
|
||||||
|
const inventoryModule = container.resolve(ModuleRegistrationName.INVENTORY)
|
||||||
|
const reservation = await inventoryModule.createReservationItems([
|
||||||
|
{
|
||||||
|
line_item_id: order.items![0].id,
|
||||||
|
inventory_item_id: inventoryItem.id,
|
||||||
|
location_id: location.id,
|
||||||
|
quantity: order.items![0].quantity,
|
||||||
|
},
|
||||||
|
])
|
||||||
|
|
||||||
|
order = await orderService.retrieve(order.id, {
|
||||||
|
relations: ["items"],
|
||||||
|
})
|
||||||
|
|
||||||
|
return order
|
||||||
|
}
|
||||||
|
|
||||||
|
medusaIntegrationTestRunner({
|
||||||
|
env,
|
||||||
|
testSuite: ({ getContainer }) => {
|
||||||
|
let container
|
||||||
|
|
||||||
|
beforeAll(() => {
|
||||||
|
container = getContainer()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe("Order fulfillment workflow", () => {
|
||||||
|
let shippingOption: ShippingOptionDTO
|
||||||
|
let region: RegionDTO
|
||||||
|
let location: StockLocationDTO
|
||||||
|
let product: ProductDTO
|
||||||
|
|
||||||
|
let orderService: IOrderModuleService
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
const fixtures = await prepareDataFixtures({
|
||||||
|
container,
|
||||||
|
})
|
||||||
|
|
||||||
|
shippingOption = fixtures.shippingOption
|
||||||
|
region = fixtures.region
|
||||||
|
location = fixtures.location
|
||||||
|
product = fixtures.product
|
||||||
|
|
||||||
|
orderService = container.resolve(ModuleRegistrationName.ORDER)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("should cancel an order", async () => {
|
||||||
|
const order = await createOrderFixture({ container, product, location })
|
||||||
|
|
||||||
|
// Create a fulfillment
|
||||||
|
const createOrderFulfillmentData: OrderWorkflow.CreateOrderFulfillmentWorkflowInput =
|
||||||
|
{
|
||||||
|
order_id: order.id,
|
||||||
|
created_by: "user_1",
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
id: order.items![0].id,
|
||||||
|
quantity: 1,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
no_notification: false,
|
||||||
|
location_id: undefined,
|
||||||
|
}
|
||||||
|
|
||||||
|
await createOrderFulfillmentWorkflow(container).run({
|
||||||
|
input: createOrderFulfillmentData,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it("should fail to cancel an order that has fulfilled items", async () => {
|
||||||
|
const order = await createOrderFixture({ container, product, location })
|
||||||
|
|
||||||
|
// Create a fulfillment
|
||||||
|
const createOrderFulfillmentData: OrderWorkflow.CreateOrderFulfillmentWorkflowInput =
|
||||||
|
{
|
||||||
|
order_id: order.id,
|
||||||
|
created_by: "user_1",
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
id: order.items![0].id,
|
||||||
|
quantity: 1,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
no_notification: false,
|
||||||
|
location_id: undefined,
|
||||||
|
}
|
||||||
|
|
||||||
|
await createOrderFulfillmentWorkflow(container).run({
|
||||||
|
input: createOrderFulfillmentData,
|
||||||
|
})
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
cancelOrderWorkflow(container).run({
|
||||||
|
input: {
|
||||||
|
order_id: order.id,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
).rejects.toMatchObject({
|
||||||
|
message:
|
||||||
|
"All fulfillments must be canceled before canceling an order",
|
||||||
|
})
|
||||||
|
|
||||||
|
// Cancel the fulfillment
|
||||||
|
const remoteQuery = container.resolve(
|
||||||
|
ContainerRegistrationKeys.REMOTE_QUERY
|
||||||
|
)
|
||||||
|
const remoteQueryObject = remoteQueryObjectFromString({
|
||||||
|
entryPoint: "order",
|
||||||
|
variables: {
|
||||||
|
id: order.id,
|
||||||
|
},
|
||||||
|
fields: ["id", "fulfillments.id"],
|
||||||
|
})
|
||||||
|
|
||||||
|
const [orderFulfill] = await remoteQuery(remoteQueryObject)
|
||||||
|
await cancelOrderFulfillmentWorkflow(container).run({
|
||||||
|
input: {
|
||||||
|
order_id: orderFulfill.id,
|
||||||
|
fulfillment_id: orderFulfill.fulfillments[0].id,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
await cancelOrderWorkflow(container).run({
|
||||||
|
input: {
|
||||||
|
order_id: order.id,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
const finalOrderQuery = remoteQueryObjectFromString({
|
||||||
|
entryPoint: "order",
|
||||||
|
variables: {
|
||||||
|
id: order.id,
|
||||||
|
},
|
||||||
|
fields: ["status", "fulfillments.canceled_at"],
|
||||||
|
})
|
||||||
|
const [finalOrder] = await remoteQuery(finalOrderQuery)
|
||||||
|
|
||||||
|
expect(finalOrder).toEqual(
|
||||||
|
expect.objectContaining({
|
||||||
|
status: "canceled",
|
||||||
|
fulfillments: [
|
||||||
|
expect.objectContaining({
|
||||||
|
canceled_at: expect.any(Date),
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
},
|
||||||
|
})
|
||||||
@@ -17,7 +17,6 @@ import {
|
|||||||
} from "@medusajs/types"
|
} from "@medusajs/types"
|
||||||
import {
|
import {
|
||||||
ContainerRegistrationKeys,
|
ContainerRegistrationKeys,
|
||||||
RuleOperator,
|
|
||||||
remoteQueryObjectFromString,
|
remoteQueryObjectFromString,
|
||||||
} from "@medusajs/utils"
|
} from "@medusajs/utils"
|
||||||
import { medusaIntegrationTestRunner } from "medusa-test-utils/dist"
|
import { medusaIntegrationTestRunner } from "medusa-test-utils/dist"
|
||||||
@@ -145,7 +144,7 @@ async function prepareDataFixtures({ container }) {
|
|||||||
|
|
||||||
const shippingOptionData: FulfillmentWorkflow.CreateShippingOptionsWorkflowInput =
|
const shippingOptionData: FulfillmentWorkflow.CreateShippingOptionsWorkflowInput =
|
||||||
{
|
{
|
||||||
name: "Return shipping option",
|
name: "Shipping option",
|
||||||
price_type: "flat",
|
price_type: "flat",
|
||||||
service_zone_id: serviceZone.id,
|
service_zone_id: serviceZone.id,
|
||||||
shipping_profile_id: shippingProfile.id,
|
shipping_profile_id: shippingProfile.id,
|
||||||
@@ -165,13 +164,6 @@ async function prepareDataFixtures({ container }) {
|
|||||||
amount: 100,
|
amount: 100,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
rules: [
|
|
||||||
{
|
|
||||||
attribute: "is_return",
|
|
||||||
operator: RuleOperator.EQ,
|
|
||||||
value: '"true"',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const { result } = await createShippingOptionsWorkflow(container).run({
|
const { result } = await createShippingOptionsWorkflow(container).run({
|
||||||
|
|||||||
@@ -1,35 +0,0 @@
|
|||||||
import { FulfillmentWorkflow } from "@medusajs/types"
|
|
||||||
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
|
|
||||||
import { updateFulfillmentWorkflow } from "../workflows/update-fulfillment"
|
|
||||||
|
|
||||||
export const updateFulfillmentWorkflowStepId = "update-fulfillment-workflow"
|
|
||||||
export const updateFulfillmentWorkflowStep = createStep(
|
|
||||||
updateFulfillmentWorkflowStepId,
|
|
||||||
async (
|
|
||||||
data: FulfillmentWorkflow.UpdateFulfillmentWorkflowInput,
|
|
||||||
{ container }
|
|
||||||
) => {
|
|
||||||
const {
|
|
||||||
transaction,
|
|
||||||
result: updated,
|
|
||||||
errors,
|
|
||||||
} = await updateFulfillmentWorkflow(container).run({
|
|
||||||
input: data,
|
|
||||||
throwOnError: false,
|
|
||||||
})
|
|
||||||
|
|
||||||
if (Array.isArray(errors) && errors[0]) {
|
|
||||||
throw errors[0].error
|
|
||||||
}
|
|
||||||
|
|
||||||
return new StepResponse(updated, transaction)
|
|
||||||
},
|
|
||||||
|
|
||||||
async (transaction, { container }) => {
|
|
||||||
if (!transaction) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
await updateFulfillmentWorkflow(container).cancel({ transaction })
|
|
||||||
}
|
|
||||||
)
|
|
||||||
@@ -5,7 +5,7 @@ import {
|
|||||||
transform,
|
transform,
|
||||||
} from "@medusajs/workflows-sdk"
|
} from "@medusajs/workflows-sdk"
|
||||||
import { validateShipmentStep } from "../steps"
|
import { validateShipmentStep } from "../steps"
|
||||||
import { updateFulfillmentWorkflowStep } from "../steps/update-fulfillment-workflow"
|
import { updateFulfillmentWorkflow } from "./update-fulfillment"
|
||||||
|
|
||||||
export const createShipmentWorkflowId = "create-shipment-workflow"
|
export const createShipmentWorkflowId = "create-shipment-workflow"
|
||||||
export const createShipmentWorkflow = createWorkflow(
|
export const createShipmentWorkflow = createWorkflow(
|
||||||
@@ -20,6 +20,8 @@ export const createShipmentWorkflow = createWorkflow(
|
|||||||
shipped_at: new Date(),
|
shipped_at: new Date(),
|
||||||
}))
|
}))
|
||||||
|
|
||||||
updateFulfillmentWorkflowStep(update)
|
updateFulfillmentWorkflow.runAsStep({
|
||||||
|
input: update,
|
||||||
|
})
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -0,0 +1,50 @@
|
|||||||
|
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
||||||
|
import { IOrderModuleService } from "@medusajs/types"
|
||||||
|
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
|
||||||
|
|
||||||
|
type CompleteOrdersStepInput = {
|
||||||
|
orderIds: string[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export const cancelOrdersStepId = "cancel-orders"
|
||||||
|
export const cancelOrdersStep = createStep(
|
||||||
|
cancelOrdersStepId,
|
||||||
|
async (data: CompleteOrdersStepInput, { container }) => {
|
||||||
|
const service = container.resolve<IOrderModuleService>(
|
||||||
|
ModuleRegistrationName.ORDER
|
||||||
|
)
|
||||||
|
|
||||||
|
const orders = await service.list(
|
||||||
|
{
|
||||||
|
id: data.orderIds,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
select: ["id", "status"],
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
const canceled = await service.cancel(data.orderIds)
|
||||||
|
return new StepResponse(
|
||||||
|
canceled,
|
||||||
|
canceled.map((order) => {
|
||||||
|
const prevData = orders.find((o) => o.id === order.id)!
|
||||||
|
return {
|
||||||
|
id: order.id,
|
||||||
|
status: prevData.status,
|
||||||
|
canceled_at: null,
|
||||||
|
}
|
||||||
|
})
|
||||||
|
)
|
||||||
|
},
|
||||||
|
async (canceled, { container }) => {
|
||||||
|
if (!canceled?.length) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
const service = container.resolve<IOrderModuleService>(
|
||||||
|
ModuleRegistrationName.ORDER
|
||||||
|
)
|
||||||
|
|
||||||
|
await service.update(canceled)
|
||||||
|
}
|
||||||
|
)
|
||||||
@@ -14,13 +14,23 @@ export const completeOrdersStep = createStep(
|
|||||||
ModuleRegistrationName.ORDER
|
ModuleRegistrationName.ORDER
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const orders = await service.list(
|
||||||
|
{
|
||||||
|
id: data.orderIds,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
select: ["id", "status"],
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
const completed = await service.completeOrder(data.orderIds)
|
const completed = await service.completeOrder(data.orderIds)
|
||||||
return new StepResponse(
|
return new StepResponse(
|
||||||
completed,
|
completed,
|
||||||
completed.map((store) => {
|
completed.map((order) => {
|
||||||
|
const prevData = orders.find((o) => o.id === order.id)!
|
||||||
return {
|
return {
|
||||||
id: store.id,
|
id: order.id,
|
||||||
status: store.status,
|
status: prevData.status,
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
export * from "./archive-orders"
|
export * from "./archive-orders"
|
||||||
|
export * from "./cancel-orders"
|
||||||
export * from "./complete-orders"
|
export * from "./complete-orders"
|
||||||
export * from "./create-orders"
|
export * from "./create-orders"
|
||||||
export * from "./get-item-tax-lines"
|
export * from "./get-item-tax-lines"
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ export function throwIfOrderIsCancelled({ order }: { order: OrderDTO }) {
|
|||||||
if (order.status === OrderStatus.CANCELED) {
|
if (order.status === OrderStatus.CANCELED) {
|
||||||
throw new MedusaError(
|
throw new MedusaError(
|
||||||
MedusaError.Types.INVALID_DATA,
|
MedusaError.Types.INVALID_DATA,
|
||||||
`Order with id ${order.id} has been cancelled.`
|
`Order with id ${order.id} has been canceled.`
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,130 @@
|
|||||||
|
import {
|
||||||
|
FulfillmentDTO,
|
||||||
|
OrderDTO,
|
||||||
|
OrderWorkflow,
|
||||||
|
PaymentCollectionDTO,
|
||||||
|
} from "@medusajs/types"
|
||||||
|
import { MedusaError, deepFlatMap } from "@medusajs/utils"
|
||||||
|
import {
|
||||||
|
WorkflowData,
|
||||||
|
createStep,
|
||||||
|
createWorkflow,
|
||||||
|
transform,
|
||||||
|
} from "@medusajs/workflows-sdk"
|
||||||
|
import { useRemoteQueryStep } from "../../common"
|
||||||
|
import { cancelPaymentStep } from "../../payment/steps"
|
||||||
|
import { deleteReservationsByLineItemsStep } from "../../reservation/steps"
|
||||||
|
import { cancelOrdersStep } from "../steps/cancel-orders"
|
||||||
|
import { throwIfOrderIsCancelled } from "../utils/order-validation"
|
||||||
|
|
||||||
|
const validateOrder = createStep(
|
||||||
|
"validate-order",
|
||||||
|
({
|
||||||
|
order,
|
||||||
|
}: {
|
||||||
|
order: OrderDTO
|
||||||
|
input: OrderWorkflow.CancelOrderWorkflowInput
|
||||||
|
}) => {
|
||||||
|
const order_ = order as OrderDTO & {
|
||||||
|
payment_collections: PaymentCollectionDTO[]
|
||||||
|
fulfillments: FulfillmentDTO[]
|
||||||
|
}
|
||||||
|
|
||||||
|
throwIfOrderIsCancelled({ order })
|
||||||
|
|
||||||
|
let refunds = 0
|
||||||
|
let captures = 0
|
||||||
|
|
||||||
|
deepFlatMap(order_, "payment_collections.payments", ({ payments }) => {
|
||||||
|
refunds += payments?.refunds?.length ?? 0
|
||||||
|
captures += payments?.captures?.length ?? 0
|
||||||
|
})
|
||||||
|
|
||||||
|
if (captures > 0) {
|
||||||
|
throw new MedusaError(
|
||||||
|
MedusaError.Types.NOT_ALLOWED,
|
||||||
|
"Order with payment capture(s) cannot be canceled"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (refunds > 0) {
|
||||||
|
throw new MedusaError(
|
||||||
|
MedusaError.Types.NOT_ALLOWED,
|
||||||
|
"Order with payment refund(s) cannot be canceled"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
const throwErrorIf = (
|
||||||
|
arr: unknown[],
|
||||||
|
pred: (obj: any) => boolean,
|
||||||
|
type: string
|
||||||
|
) => {
|
||||||
|
if (arr?.filter(pred).length) {
|
||||||
|
throw new MedusaError(
|
||||||
|
MedusaError.Types.NOT_ALLOWED,
|
||||||
|
`All ${type} must be canceled before canceling an order`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const notCanceled = (o) => !o.canceled_at
|
||||||
|
|
||||||
|
throwErrorIf(order_.fulfillments, notCanceled, "fulfillments")
|
||||||
|
/*
|
||||||
|
TODO: relationship between order and returns, swaps, claims
|
||||||
|
|
||||||
|
throwErrorIf(
|
||||||
|
order_.returns,
|
||||||
|
(ret) => ret.status !== "canceled",
|
||||||
|
"returns"
|
||||||
|
)
|
||||||
|
throwErrorIf(order_.swaps, notCanceled, "swaps")
|
||||||
|
throwErrorIf(order_.claims, notCanceled, "claims")
|
||||||
|
*/
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
export const cancelOrderWorkflowId = "cancel-order"
|
||||||
|
export const cancelOrderWorkflow = createWorkflow(
|
||||||
|
cancelOrderWorkflowId,
|
||||||
|
(
|
||||||
|
input: WorkflowData<OrderWorkflow.CancelOrderWorkflowInput>
|
||||||
|
): WorkflowData<void> => {
|
||||||
|
const order: OrderDTO & { fulfillments: FulfillmentDTO[] } =
|
||||||
|
useRemoteQueryStep({
|
||||||
|
entry_point: "orders",
|
||||||
|
fields: [
|
||||||
|
"id",
|
||||||
|
"status",
|
||||||
|
"items.id",
|
||||||
|
"fulfillments.canceled_at",
|
||||||
|
"payment_collections.payments.id",
|
||||||
|
"payment_collections.payments.refunds.id",
|
||||||
|
"payment_collections.payments.captures.id",
|
||||||
|
],
|
||||||
|
variables: { id: input.order_id },
|
||||||
|
list: false,
|
||||||
|
throw_if_key_not_found: true,
|
||||||
|
})
|
||||||
|
|
||||||
|
validateOrder({ order, input })
|
||||||
|
|
||||||
|
const lineItemIds = transform({ order }, ({ order }) => {
|
||||||
|
return order.items?.map((i) => i.id)
|
||||||
|
})
|
||||||
|
deleteReservationsByLineItemsStep(lineItemIds)
|
||||||
|
|
||||||
|
const paymentIds = transform({ order }, ({ order }) => {
|
||||||
|
return deepFlatMap(
|
||||||
|
order,
|
||||||
|
"payment_collections.payments",
|
||||||
|
({ payments }) => {
|
||||||
|
return payments?.id
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
cancelPaymentStep({ paymentIds })
|
||||||
|
|
||||||
|
cancelOrdersStep({ orderIds: [order.id] })
|
||||||
|
}
|
||||||
|
)
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
export * from "./archive-orders"
|
export * from "./archive-orders"
|
||||||
|
export * from "./cancel-order"
|
||||||
export * from "./cancel-order-fulfillment"
|
export * from "./cancel-order-fulfillment"
|
||||||
export * from "./complete-orders"
|
export * from "./complete-orders"
|
||||||
export * from "./create-fulfillment"
|
export * from "./create-fulfillment"
|
||||||
|
|||||||
@@ -0,0 +1,35 @@
|
|||||||
|
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
||||||
|
import { IPaymentModuleService, Logger } from "@medusajs/types"
|
||||||
|
import { ContainerRegistrationKeys, promiseAll } from "@medusajs/utils"
|
||||||
|
import { createStep } from "@medusajs/workflows-sdk"
|
||||||
|
|
||||||
|
type StepInput = {
|
||||||
|
paymentIds: string | string[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export const cancelPaymentStepId = "cancel-payment-step"
|
||||||
|
export const cancelPaymentStep = createStep(
|
||||||
|
cancelPaymentStepId,
|
||||||
|
async (input: StepInput, { container }) => {
|
||||||
|
const logger = container.resolve<Logger>(ContainerRegistrationKeys.LOGGER)
|
||||||
|
const paymentModule = container.resolve<IPaymentModuleService>(
|
||||||
|
ModuleRegistrationName.PAYMENT
|
||||||
|
)
|
||||||
|
|
||||||
|
const paymentIds = Array.isArray(input.paymentIds)
|
||||||
|
? input.paymentIds
|
||||||
|
: [input.paymentIds]
|
||||||
|
|
||||||
|
const promises: Promise<any>[] = []
|
||||||
|
for (const id of paymentIds) {
|
||||||
|
promises.push(
|
||||||
|
paymentModule.cancelPayment(id).catch((e) => {
|
||||||
|
logger.error(
|
||||||
|
`Error was thrown trying to cancel payment - ${id} - ${e}`
|
||||||
|
)
|
||||||
|
})
|
||||||
|
)
|
||||||
|
}
|
||||||
|
await promiseAll(promises)
|
||||||
|
}
|
||||||
|
)
|
||||||
@@ -1,3 +1,3 @@
|
|||||||
|
export * from "./cancel-payment"
|
||||||
export * from "./capture-payment"
|
export * from "./capture-payment"
|
||||||
export * from "./refund-payment"
|
export * from "./refund-payment"
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,30 @@
|
|||||||
|
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
|
||||||
|
|
||||||
|
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
||||||
|
import { IInventoryServiceNext } from "@medusajs/types"
|
||||||
|
|
||||||
|
export const deleteReservationsByLineItemsStepId =
|
||||||
|
"delete-reservations-by-line-items"
|
||||||
|
export const deleteReservationsByLineItemsStep = createStep(
|
||||||
|
deleteReservationsByLineItemsStepId,
|
||||||
|
async (ids: string[], { container }) => {
|
||||||
|
const service = container.resolve<IInventoryServiceNext>(
|
||||||
|
ModuleRegistrationName.INVENTORY
|
||||||
|
)
|
||||||
|
|
||||||
|
await service.deleteReservationItemsByLineItem(ids)
|
||||||
|
|
||||||
|
return new StepResponse(void 0, ids)
|
||||||
|
},
|
||||||
|
async (prevIds, { container }) => {
|
||||||
|
if (!prevIds?.length) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
const service = container.resolve<IInventoryServiceNext>(
|
||||||
|
ModuleRegistrationName.INVENTORY
|
||||||
|
)
|
||||||
|
|
||||||
|
await service.restoreReservationItemsByLineItem(prevIds)
|
||||||
|
}
|
||||||
|
)
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
|
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
|
||||||
|
|
||||||
import { IInventoryServiceNext } from "@medusajs/types"
|
|
||||||
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
||||||
|
import { IInventoryServiceNext } from "@medusajs/types"
|
||||||
|
|
||||||
export const deleteReservationsStepId = "delete-reservations"
|
export const deleteReservationsStepId = "delete-reservations"
|
||||||
export const deleteReservationsStep = createStep(
|
export const deleteReservationsStep = createStep(
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
export * from "./create-reservations"
|
export * from "./create-reservations"
|
||||||
export * from "./delete-reservations"
|
export * from "./delete-reservations"
|
||||||
|
export * from "./delete-reservations-by-line-items"
|
||||||
export * from "./update-reservations"
|
export * from "./update-reservations"
|
||||||
|
|||||||
+14
@@ -0,0 +1,14 @@
|
|||||||
|
import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
|
||||||
|
|
||||||
|
import { deleteReservationsByLineItemsStep } from "../steps"
|
||||||
|
|
||||||
|
type WorkflowInput = { ids: string[] }
|
||||||
|
|
||||||
|
export const deleteReservationsByLineItemsWorkflowId =
|
||||||
|
"delete-reservations-by-line-items"
|
||||||
|
export const deleteReservationsByLineItemsWorkflow = createWorkflow(
|
||||||
|
deleteReservationsByLineItemsWorkflowId,
|
||||||
|
(input: WorkflowData<WorkflowInput>): WorkflowData<void> => {
|
||||||
|
return deleteReservationsByLineItemsStep(input.ids)
|
||||||
|
}
|
||||||
|
)
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
export * from "./create-reservations"
|
export * from "./create-reservations"
|
||||||
export * from "./delete-reservations"
|
export * from "./delete-reservations"
|
||||||
|
export * from "./delete-reservations-by-line-items"
|
||||||
export * from "./update-reservations"
|
export * from "./update-reservations"
|
||||||
|
|||||||
@@ -280,7 +280,7 @@ describe("Medusa Modules", () => {
|
|||||||
} as InternalModuleDeclaration,
|
} as InternalModuleDeclaration,
|
||||||
})
|
})
|
||||||
|
|
||||||
expect(moduleC).rejects.toThrow(
|
await expect(moduleC).rejects.toThrow(
|
||||||
"Module moduleKey already have a 'main' registered."
|
"Module moduleKey already have a 'main' registered."
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
@@ -314,7 +314,7 @@ describe("Medusa Modules", () => {
|
|||||||
} as InternalModuleDeclaration,
|
} as InternalModuleDeclaration,
|
||||||
})
|
})
|
||||||
|
|
||||||
expect(moduleC).rejects.toThrow(
|
await expect(moduleC).rejects.toThrow(
|
||||||
"Module moduleKey already registed as 'module_alias'. Please choose a different alias."
|
"Module moduleKey already registed as 'module_alias'. Please choose a different alias."
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -110,7 +110,7 @@ describe("modules loader", () => {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
expect(
|
await expect(
|
||||||
moduleLoader({ container, moduleResolutions, logger })
|
moduleLoader({ container, moduleResolutions, logger })
|
||||||
).rejects.toThrow("Loaders for module TestService failed: loader")
|
).rejects.toThrow("Loaders for module TestService failed: loader")
|
||||||
})
|
})
|
||||||
@@ -136,7 +136,7 @@ describe("modules loader", () => {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
expect(
|
await expect(
|
||||||
moduleLoader({ container, moduleResolutions, logger })
|
moduleLoader({ container, moduleResolutions, logger })
|
||||||
).rejects.toThrow(
|
).rejects.toThrow(
|
||||||
"No service found in module TestService. Make sure your module exports a service."
|
"No service found in module TestService. Make sure your module exports a service."
|
||||||
@@ -165,7 +165,7 @@ describe("modules loader", () => {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
expect(
|
await expect(
|
||||||
moduleLoader({ container, moduleResolutions, logger })
|
moduleLoader({ container, moduleResolutions, logger })
|
||||||
).rejects.toThrow(
|
).rejects.toThrow(
|
||||||
"No service found in module TestService. Make sure your module exports a service."
|
"No service found in module TestService. Make sure your module exports a service."
|
||||||
|
|||||||
@@ -793,7 +793,7 @@ describe("RemoteJoiner", () => {
|
|||||||
fields: ["id", "name", "email"],
|
fields: ["id", "name", "email"],
|
||||||
}
|
}
|
||||||
|
|
||||||
expect(newJoiner.query(queryWithAlias)).rejects.toThrowError(
|
await expect(newJoiner.query(queryWithAlias)).rejects.toThrowError(
|
||||||
`Service with alias "user" was not found.`
|
`Service with alias "user" was not found.`
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
@@ -825,6 +825,8 @@ describe("RemoteJoiner", () => {
|
|||||||
throwIfKeyNotFound: true,
|
throwIfKeyNotFound: true,
|
||||||
})
|
})
|
||||||
|
|
||||||
expect(dataNotFound).rejects.toThrowError("order id not found: ord_1234556")
|
await expect(dataNotFound).rejects.toThrowError(
|
||||||
|
"order id not found: ord_1234556"
|
||||||
|
)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -733,6 +733,33 @@ export interface IInventoryServiceNext extends IModuleService {
|
|||||||
context?: Context
|
context?: Context
|
||||||
): Promise<void>
|
): Promise<void>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method is used to restore the reservation items associated with a line item or multiple line items that were deleted.
|
||||||
|
*
|
||||||
|
* @param {string | string[]} lineItemId - The ID(s) of the line item(s).
|
||||||
|
* @param {SharedContext} context - A context used to share re9sources, such as transaction manager, between the application and the module.
|
||||||
|
* @returns {Promise<void>} Resolves when the reservation items are successfully deleted.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* import {
|
||||||
|
* initialize as initializeInventoryModule,
|
||||||
|
* } from "@medusajs/inventory"
|
||||||
|
*
|
||||||
|
* async function restoreReservationItemsByLineItem (
|
||||||
|
* lineItemIds: string[]
|
||||||
|
* ) {
|
||||||
|
* const inventoryModule = await initializeInventoryModule({})
|
||||||
|
*
|
||||||
|
* await inventoryModule.restoreReservationItemsByLineItem(
|
||||||
|
* lineItemIds
|
||||||
|
* )
|
||||||
|
* }
|
||||||
|
*/
|
||||||
|
restoreReservationItemsByLineItem(
|
||||||
|
lineItemId: string | string[],
|
||||||
|
context?: Context
|
||||||
|
): Promise<void>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method deletes reservation items by their IDs.
|
* This method deletes reservation items by their IDs.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -875,6 +875,10 @@ export interface OrderDTO {
|
|||||||
* Holds custom data in key-value pairs.
|
* Holds custom data in key-value pairs.
|
||||||
*/
|
*/
|
||||||
metadata?: Record<string, unknown> | null
|
metadata?: Record<string, unknown> | null
|
||||||
|
/**
|
||||||
|
* When the order was canceled.
|
||||||
|
*/
|
||||||
|
canceled_at?: string | Date
|
||||||
/**
|
/**
|
||||||
* When the order was created.
|
* When the order was created.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -395,6 +395,11 @@ export interface CreateOrderReturnDTO extends BaseOrderBundledActionsDTO {
|
|||||||
shipping_method: Omit<CreateOrderShippingMethodDTO, "order_id"> | string
|
shipping_method: Omit<CreateOrderShippingMethodDTO, "order_id"> | string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface CancelOrderReturnDTO {
|
||||||
|
order_id: string
|
||||||
|
return_id: string
|
||||||
|
}
|
||||||
|
|
||||||
export interface ReceiveOrderReturnDTO extends BaseOrderBundledActionsDTO {}
|
export interface ReceiveOrderReturnDTO extends BaseOrderBundledActionsDTO {}
|
||||||
|
|
||||||
/** ORDER bundled action flows */
|
/** ORDER bundled action flows */
|
||||||
|
|||||||
@@ -1491,6 +1491,9 @@ export interface IOrderModuleService extends IModuleService {
|
|||||||
completeOrder(orderId: string[], sharedContext?: Context): Promise<OrderDTO[]>
|
completeOrder(orderId: string[], sharedContext?: Context): Promise<OrderDTO[]>
|
||||||
completeOrder(orderId: string, sharedContext?: Context): Promise<OrderDTO>
|
completeOrder(orderId: string, sharedContext?: Context): Promise<OrderDTO>
|
||||||
|
|
||||||
|
cancel(orderId: string[], sharedContext?: Context): Promise<OrderDTO[]>
|
||||||
|
cancel(orderId: string, sharedContext?: Context): Promise<OrderDTO>
|
||||||
|
|
||||||
// Bundled flows
|
// Bundled flows
|
||||||
registerFulfillment(
|
registerFulfillment(
|
||||||
data: RegisterOrderFulfillmentDTO,
|
data: RegisterOrderFulfillmentDTO,
|
||||||
@@ -1512,6 +1515,13 @@ export interface IOrderModuleService extends IModuleService {
|
|||||||
sharedContext?: Context
|
sharedContext?: Context
|
||||||
): Promise<void>
|
): Promise<void>
|
||||||
|
|
||||||
|
/*
|
||||||
|
cancelReturn(
|
||||||
|
returnData: CancelOrderReturnDTO,
|
||||||
|
sharedContext?: Context
|
||||||
|
): Promise<void>
|
||||||
|
*/
|
||||||
|
|
||||||
receiveReturn(
|
receiveReturn(
|
||||||
returnData: ReceiveOrderReturnDTO,
|
returnData: ReceiveOrderReturnDTO,
|
||||||
sharedContext?: Context
|
sharedContext?: Context
|
||||||
|
|||||||
@@ -0,0 +1,4 @@
|
|||||||
|
export interface CancelOrderWorkflowInput {
|
||||||
|
order_id: string
|
||||||
|
no_notification?: boolean
|
||||||
|
}
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
export * from "./cancel-fulfillment"
|
export * from "./cancel-fulfillment"
|
||||||
|
export * from "./cancel-order"
|
||||||
export * from "./create-fulfillment"
|
export * from "./create-fulfillment"
|
||||||
export * from "./create-return-order"
|
export * from "./create-return-order"
|
||||||
export * from "./create-shipment"
|
export * from "./create-shipment"
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import { cancelOrderWorkflow } from "@medusajs/core-flows"
|
||||||
import {
|
import {
|
||||||
ContainerRegistrationKeys,
|
ContainerRegistrationKeys,
|
||||||
remoteQueryObjectFromString,
|
remoteQueryObjectFromString,
|
||||||
@@ -15,7 +16,13 @@ export const GET = async (
|
|||||||
|
|
||||||
const variables = { id: req.params.id }
|
const variables = { id: req.params.id }
|
||||||
|
|
||||||
// TODO: cancel order - v1.x - packages/medusa/src/api/routes/admin/orders/cancel-order.ts
|
const input = {
|
||||||
|
order_id: req.params.id,
|
||||||
|
}
|
||||||
|
|
||||||
|
await cancelOrderWorkflow(req.scope).run({
|
||||||
|
input,
|
||||||
|
})
|
||||||
|
|
||||||
const queryObject = remoteQueryObjectFromString({
|
const queryObject = remoteQueryObjectFromString({
|
||||||
entryPoint: "order",
|
entryPoint: "order",
|
||||||
|
|||||||
+1
-6
@@ -22,15 +22,10 @@ export const POST = async (
|
|||||||
order_id: req.params.id,
|
order_id: req.params.id,
|
||||||
}
|
}
|
||||||
|
|
||||||
const { errors } = await cancelOrderFulfillmentWorkflow(req.scope).run({
|
await cancelOrderFulfillmentWorkflow(req.scope).run({
|
||||||
input,
|
input,
|
||||||
throwOnError: false,
|
|
||||||
})
|
})
|
||||||
|
|
||||||
if (Array.isArray(errors) && errors[0]) {
|
|
||||||
throw errors[0].error
|
|
||||||
}
|
|
||||||
|
|
||||||
const queryObject = remoteQueryObjectFromString({
|
const queryObject = remoteQueryObjectFromString({
|
||||||
entryPoint: "order",
|
entryPoint: "order",
|
||||||
variables,
|
variables,
|
||||||
|
|||||||
+1
-6
@@ -24,15 +24,10 @@ export const POST = async (
|
|||||||
labels: req.validatedBody.labels ?? [],
|
labels: req.validatedBody.labels ?? [],
|
||||||
}
|
}
|
||||||
|
|
||||||
const { errors } = await createOrderShipmentWorkflow(req.scope).run({
|
await createOrderShipmentWorkflow(req.scope).run({
|
||||||
input,
|
input,
|
||||||
throwOnError: false,
|
|
||||||
})
|
})
|
||||||
|
|
||||||
if (Array.isArray(errors) && errors[0]) {
|
|
||||||
throw errors[0].error
|
|
||||||
}
|
|
||||||
|
|
||||||
const queryObject = remoteQueryObjectFromString({
|
const queryObject = remoteQueryObjectFromString({
|
||||||
entryPoint: "order",
|
entryPoint: "order",
|
||||||
variables,
|
variables,
|
||||||
|
|||||||
@@ -22,15 +22,10 @@ export const POST = async (
|
|||||||
order_id: req.params.id,
|
order_id: req.params.id,
|
||||||
}
|
}
|
||||||
|
|
||||||
const { errors } = await createOrderFulfillmentWorkflow(req.scope).run({
|
await createOrderFulfillmentWorkflow(req.scope).run({
|
||||||
input,
|
input,
|
||||||
throwOnError: false,
|
|
||||||
})
|
})
|
||||||
|
|
||||||
if (Array.isArray(errors) && errors[0]) {
|
|
||||||
throw errors[0].error
|
|
||||||
}
|
|
||||||
|
|
||||||
const queryObject = remoteQueryObjectFromString({
|
const queryObject = remoteQueryObjectFromString({
|
||||||
entryPoint: "order",
|
entryPoint: "order",
|
||||||
variables,
|
variables,
|
||||||
|
|||||||
+1
-1
@@ -13,6 +13,6 @@ export default async function orderNotifier({
|
|||||||
}
|
}
|
||||||
|
|
||||||
export const config: SubscriberConfig = {
|
export const config: SubscriberConfig = {
|
||||||
event: ["order.placed", "order.cancelled", "order.completed"],
|
event: ["order.placed", "order.canceled", "order.completed"],
|
||||||
context: { subscriberId: "order-notifier" },
|
context: { subscriberId: "order-notifier" },
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -81,7 +81,7 @@ describe("SubscriberLoader", () => {
|
|||||||
)
|
)
|
||||||
|
|
||||||
expect(eventBusServiceMock.subscribe).toHaveBeenCalledWith(
|
expect(eventBusServiceMock.subscribe).toHaveBeenCalledWith(
|
||||||
"order.cancelled",
|
"order.canceled",
|
||||||
expect.any(Function),
|
expect.any(Function),
|
||||||
{
|
{
|
||||||
subscriberId: "order-notifier",
|
subscriberId: "order-notifier",
|
||||||
|
|||||||
@@ -1,11 +1,11 @@
|
|||||||
import crypto from "crypto"
|
|
||||||
import { Modules } from "@medusajs/modules-sdk"
|
import { Modules } from "@medusajs/modules-sdk"
|
||||||
import { IApiKeyModuleService } from "@medusajs/types"
|
import { IApiKeyModuleService } from "@medusajs/types"
|
||||||
import { ApiKeyType } from "@medusajs/utils"
|
import { ApiKeyType } from "@medusajs/utils"
|
||||||
|
import crypto from "crypto"
|
||||||
import { moduleIntegrationTestRunner, SuiteOptions } from "medusa-test-utils"
|
import { moduleIntegrationTestRunner, SuiteOptions } from "medusa-test-utils"
|
||||||
import {
|
import {
|
||||||
createSecretKeyFixture,
|
|
||||||
createPublishableKeyFixture,
|
createPublishableKeyFixture,
|
||||||
|
createSecretKeyFixture,
|
||||||
} from "../__fixtures__"
|
} from "../__fixtures__"
|
||||||
|
|
||||||
jest.setTimeout(100000)
|
jest.setTimeout(100000)
|
||||||
@@ -88,7 +88,7 @@ moduleIntegrationTestRunner({
|
|||||||
})
|
})
|
||||||
|
|
||||||
it("should only allow creating one active token", async function () {
|
it("should only allow creating one active token", async function () {
|
||||||
expect(
|
await expect(
|
||||||
service.create([createSecretKeyFixture, createSecretKeyFixture])
|
service.create([createSecretKeyFixture, createSecretKeyFixture])
|
||||||
).rejects.toThrow(
|
).rejects.toThrow(
|
||||||
"You can only create one secret key at a time. You tried to create 2 secret keys."
|
"You can only create one secret key at a time. You tried to create 2 secret keys."
|
||||||
|
|||||||
+21
-2
@@ -96,7 +96,7 @@ moduleIntegrationTestRunner({
|
|||||||
quantity: 3,
|
quantity: 3,
|
||||||
})
|
})
|
||||||
|
|
||||||
expect(reserveMoreThanInStock).rejects.toThrow(
|
await expect(reserveMoreThanInStock).rejects.toThrow(
|
||||||
`Not enough stock available for item ${inventoryItem.id} at location location-1`
|
`Not enough stock available for item ${inventoryItem.id} at location location-1`
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -415,7 +415,7 @@ moduleIntegrationTestRunner({
|
|||||||
])
|
])
|
||||||
})
|
})
|
||||||
|
|
||||||
it("deleted reseravation items by line item", async () => {
|
it("deleted reseravation items by line item and restore them", async () => {
|
||||||
const reservationsPreDeleted = await service.listReservationItems({
|
const reservationsPreDeleted = await service.listReservationItems({
|
||||||
line_item_id: "line-item-id",
|
line_item_id: "line-item-id",
|
||||||
})
|
})
|
||||||
@@ -440,6 +440,25 @@ moduleIntegrationTestRunner({
|
|||||||
})
|
})
|
||||||
|
|
||||||
expect(reservationsPostDeleted).toEqual([])
|
expect(reservationsPostDeleted).toEqual([])
|
||||||
|
|
||||||
|
await service.restoreReservationItemsByLineItem("line-item-id")
|
||||||
|
|
||||||
|
const reservationsPostRestored = await service.listReservationItems({
|
||||||
|
line_item_id: "line-item-id",
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(reservationsPostRestored).toEqual([
|
||||||
|
expect.objectContaining({
|
||||||
|
location_id: "location-1",
|
||||||
|
quantity: 2,
|
||||||
|
line_item_id: "line-item-id",
|
||||||
|
}),
|
||||||
|
expect.objectContaining({
|
||||||
|
location_id: "location-1",
|
||||||
|
quantity: 2,
|
||||||
|
line_item_id: "line-item-id",
|
||||||
|
}),
|
||||||
|
])
|
||||||
})
|
})
|
||||||
|
|
||||||
it("adjusts inventory levels accordingly when removing reservations by line item", async () => {
|
it("adjusts inventory levels accordingly when removing reservations by line item", async () => {
|
||||||
|
|||||||
@@ -1,17 +1,8 @@
|
|||||||
import {
|
import { Context } from "@medusajs/types"
|
||||||
Context,
|
import { ModulesSdkUtils } from "@medusajs/utils"
|
||||||
CreateInventoryLevelInput,
|
|
||||||
DAL,
|
|
||||||
SharedContext,
|
|
||||||
} from "@medusajs/types"
|
|
||||||
import {
|
|
||||||
InjectTransactionManager,
|
|
||||||
MedusaContext,
|
|
||||||
ModulesSdkUtils,
|
|
||||||
} from "@medusajs/utils"
|
|
||||||
|
|
||||||
import { InventoryLevel } from "../models/inventory-level"
|
|
||||||
import { InventoryLevelRepository } from "@repositories"
|
import { InventoryLevelRepository } from "@repositories"
|
||||||
|
import { InventoryLevel } from "../models/inventory-level"
|
||||||
|
|
||||||
type InjectedDependencies = {
|
type InjectedDependencies = {
|
||||||
inventoryLevelRepository: InventoryLevelRepository
|
inventoryLevelRepository: InventoryLevelRepository
|
||||||
|
|||||||
@@ -15,11 +15,11 @@ import {
|
|||||||
InjectManager,
|
InjectManager,
|
||||||
InjectTransactionManager,
|
InjectTransactionManager,
|
||||||
InventoryEvents,
|
InventoryEvents,
|
||||||
isDefined,
|
|
||||||
isString,
|
|
||||||
MedusaContext,
|
MedusaContext,
|
||||||
MedusaError,
|
MedusaError,
|
||||||
ModulesSdkUtils,
|
ModulesSdkUtils,
|
||||||
|
isDefined,
|
||||||
|
isString,
|
||||||
partitionArray,
|
partitionArray,
|
||||||
promiseAll,
|
promiseAll,
|
||||||
} from "@medusajs/utils"
|
} from "@medusajs/utils"
|
||||||
@@ -781,6 +781,43 @@ export default class InventoryModuleService<
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deletes reservation items by line item
|
||||||
|
* @param lineItemId - the id of the line item associated with the reservation item
|
||||||
|
* @param context
|
||||||
|
*/
|
||||||
|
|
||||||
|
@InjectTransactionManager("baseRepository_")
|
||||||
|
@EmitEvents()
|
||||||
|
async restoreReservationItemsByLineItem(
|
||||||
|
lineItemId: string | string[],
|
||||||
|
@MedusaContext() context: Context = {}
|
||||||
|
): Promise<void> {
|
||||||
|
const reservations: InventoryNext.ReservationItemDTO[] =
|
||||||
|
await this.listReservationItems({ line_item_id: lineItemId }, {}, context)
|
||||||
|
|
||||||
|
await this.reservationItemService_.restore(
|
||||||
|
{ line_item_id: lineItemId },
|
||||||
|
context
|
||||||
|
)
|
||||||
|
|
||||||
|
await this.adjustInventoryLevelsForReservationsRestore(
|
||||||
|
reservations,
|
||||||
|
context
|
||||||
|
)
|
||||||
|
|
||||||
|
context.messageAggregator?.saveRawMessageData(
|
||||||
|
reservations.map((reservationItem) => ({
|
||||||
|
eventName: InventoryEvents.reservation_item_created,
|
||||||
|
service: this.constructor.name,
|
||||||
|
action: CommonEvents.CREATED,
|
||||||
|
object: "reservation-item",
|
||||||
|
context,
|
||||||
|
data: { id: reservationItem.id },
|
||||||
|
}))
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adjusts the inventory level for a given inventory item and location.
|
* Adjusts the inventory level for a given inventory item and location.
|
||||||
* @param inventoryItemId - the id of the inventory item
|
* @param inventoryItemId - the id of the inventory item
|
||||||
@@ -1040,6 +1077,30 @@ export default class InventoryModuleService<
|
|||||||
reservations: ReservationItemDTO[],
|
reservations: ReservationItemDTO[],
|
||||||
context: Context
|
context: Context
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
|
await this.adjustInventoryLevelsForReservations_(
|
||||||
|
reservations,
|
||||||
|
true,
|
||||||
|
context
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private async adjustInventoryLevelsForReservationsRestore(
|
||||||
|
reservations: ReservationItemDTO[],
|
||||||
|
context: Context
|
||||||
|
): Promise<void> {
|
||||||
|
await this.adjustInventoryLevelsForReservations_(
|
||||||
|
reservations,
|
||||||
|
false,
|
||||||
|
context
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private async adjustInventoryLevelsForReservations_(
|
||||||
|
reservations: ReservationItemDTO[],
|
||||||
|
isDelete: boolean,
|
||||||
|
context: Context
|
||||||
|
): Promise<void> {
|
||||||
|
const multiplier = isDelete ? -1 : 1
|
||||||
const inventoryLevels = await this.ensureInventoryLevels(
|
const inventoryLevels = await this.ensureInventoryLevels(
|
||||||
reservations.map((r) => ({
|
reservations.map((r) => ({
|
||||||
inventory_item_id: r.inventory_item_id,
|
inventory_item_id: r.inventory_item_id,
|
||||||
@@ -1055,8 +1116,8 @@ export default class InventoryModuleService<
|
|||||||
const inventoryLevelMap = acc.get(curr.inventory_item_id) ?? new Map()
|
const inventoryLevelMap = acc.get(curr.inventory_item_id) ?? new Map()
|
||||||
|
|
||||||
const adjustment = inventoryLevelMap.has(curr.location_id)
|
const adjustment = inventoryLevelMap.has(curr.location_id)
|
||||||
? inventoryLevelMap.get(curr.location_id) - curr.quantity
|
? inventoryLevelMap.get(curr.location_id) + curr.quantity * multiplier
|
||||||
: -curr.quantity
|
: curr.quantity * multiplier
|
||||||
|
|
||||||
inventoryLevelMap.set(curr.location_id, adjustment)
|
inventoryLevelMap.set(curr.location_id, adjustment)
|
||||||
acc.set(curr.inventory_item_id, inventoryLevelMap)
|
acc.set(curr.inventory_item_id, inventoryLevelMap)
|
||||||
|
|||||||
@@ -410,7 +410,9 @@ moduleIntegrationTestRunner({
|
|||||||
confirmed_by: "cx_agent_123",
|
confirmed_by: "cx_agent_123",
|
||||||
})
|
})
|
||||||
|
|
||||||
expect(service.confirmOrderChange(orderChange.id)).rejects.toThrowError(
|
await expect(
|
||||||
|
service.confirmOrderChange(orderChange.id)
|
||||||
|
).rejects.toThrowError(
|
||||||
`Order Change cannot be modified: ${orderChange.id}`
|
`Order Change cannot be modified: ${orderChange.id}`
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -579,9 +581,9 @@ moduleIntegrationTestRunner({
|
|||||||
canceled_by: "cx_agent_123",
|
canceled_by: "cx_agent_123",
|
||||||
})
|
})
|
||||||
|
|
||||||
expect(service.cancelOrderChange(orderChange.id)).rejects.toThrowError(
|
await expect(
|
||||||
"Order Change cannot be modified"
|
service.cancelOrderChange(orderChange.id)
|
||||||
)
|
).rejects.toThrowError("Order Change cannot be modified")
|
||||||
|
|
||||||
await service.declineOrderChange({
|
await service.declineOrderChange({
|
||||||
id: orderChange2.id,
|
id: orderChange2.id,
|
||||||
@@ -589,7 +591,7 @@ moduleIntegrationTestRunner({
|
|||||||
declined_reason: "changed my mind",
|
declined_reason: "changed my mind",
|
||||||
})
|
})
|
||||||
|
|
||||||
expect(
|
await expect(
|
||||||
service.declineOrderChange(orderChange2.id)
|
service.declineOrderChange(orderChange2.id)
|
||||||
).rejects.toThrowError("Order Change cannot be modified")
|
).rejects.toThrowError("Order Change cannot be modified")
|
||||||
|
|
||||||
|
|||||||
@@ -2753,10 +2753,55 @@ export default class OrderModuleService<
|
|||||||
}
|
}
|
||||||
|
|
||||||
await this.orderService_.update(
|
await this.orderService_.update(
|
||||||
|
orderIds.map((id) => {
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
status: OrderStatus.COMPLETED,
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
sharedContext
|
||||||
|
)
|
||||||
|
|
||||||
|
return Array.isArray(orderId) ? orders : orders[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
async cancel(
|
||||||
|
orderId: string,
|
||||||
|
sharedContext?: Context
|
||||||
|
): Promise<OrderTypes.OrderDTO>
|
||||||
|
async cancel(
|
||||||
|
orderId: string[],
|
||||||
|
sharedContext?: Context
|
||||||
|
): Promise<OrderTypes.OrderDTO[]>
|
||||||
|
|
||||||
|
@InjectTransactionManager("baseRepository_")
|
||||||
|
async cancel(
|
||||||
|
orderId: string | string[],
|
||||||
|
sharedContext?: Context
|
||||||
|
): Promise<OrderTypes.OrderDTO | OrderTypes.OrderDTO[]> {
|
||||||
|
const orderIds = Array.isArray(orderId) ? orderId : [orderId]
|
||||||
|
const orders = await this.list(
|
||||||
{
|
{
|
||||||
id: orderIds,
|
id: orderIds,
|
||||||
status: OrderStatus.COMPLETED,
|
|
||||||
},
|
},
|
||||||
|
{},
|
||||||
|
sharedContext
|
||||||
|
)
|
||||||
|
|
||||||
|
const canceled_at = new Date()
|
||||||
|
for (const order of orders) {
|
||||||
|
order.status = OrderStatus.CANCELED
|
||||||
|
order.canceled_at = canceled_at
|
||||||
|
}
|
||||||
|
|
||||||
|
await this.orderService_.update(
|
||||||
|
orderIds.map((id) => {
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
status: OrderStatus.CANCELED,
|
||||||
|
canceled_at,
|
||||||
|
}
|
||||||
|
}),
|
||||||
sharedContext
|
sharedContext
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -299,7 +299,7 @@ moduleIntegrationTestRunner({
|
|||||||
{}
|
{}
|
||||||
)
|
)
|
||||||
|
|
||||||
expect(result).rejects.toThrow(
|
await expect(result).rejects.toThrow(
|
||||||
"Method calculatePrices requires currency_code in the pricing context"
|
"Method calculatePrices requires currency_code in the pricing context"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -308,7 +308,7 @@ moduleIntegrationTestRunner({
|
|||||||
{ context: { region_id: "DE" } }
|
{ context: { region_id: "DE" } }
|
||||||
)
|
)
|
||||||
|
|
||||||
expect(result).rejects.toThrow(
|
await expect(result).rejects.toThrow(
|
||||||
"Method calculatePrices requires currency_code in the pricing context"
|
"Method calculatePrices requires currency_code in the pricing context"
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|||||||
Reference in New Issue
Block a user