feat(order): fulfillment workflow (#7385)

FIXES: CORE-2162 CORE-2167 CORE-2041
This commit is contained in:
Carlos R. L. Rodrigues
2024-05-27 12:49:33 +00:00
committed by GitHub
parent 639758ffec
commit 62ef82f497
43 changed files with 1730 additions and 195 deletions
@@ -0,0 +1,397 @@
import {
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,
RuleOperator,
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: "Return 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,
},
],
rules: [
{
attribute: "is_return",
operator: RuleOperator.EQ,
value: '"true"',
},
],
}
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("Create 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 create a order fulfillment", async () => {
const order = await createOrderFixture({ container, product, location })
const createReturnOrderData: 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: createReturnOrderData,
})
const remoteQuery = container.resolve(
ContainerRegistrationKeys.REMOTE_QUERY
)
const remoteQueryObject = remoteQueryObjectFromString({
entryPoint: "order",
variables: {
id: order.id,
},
fields: [
"*",
"items.*",
"shipping_methods.*",
"total",
"item_total",
"fulfillments.*",
],
})
const [orderFulfill] = await remoteQuery(remoteQueryObject)
expect(orderFulfill.fulfillments).toHaveLength(1)
expect(orderFulfill.items[0].detail.fulfilled_quantity).toEqual(1)
const inventoryModule = container.resolve(
ModuleRegistrationName.INVENTORY
)
const reservation = await inventoryModule.listReservationItems({
line_item_id: order.items![0].id,
})
expect(reservation).toHaveLength(0)
const stockAvailability = await inventoryModule.retrieveStockedQuantity(
inventoryItem.id,
[location.id]
)
expect(stockAvailability).toEqual(1)
})
})
},
})
@@ -1,3 +1,7 @@
import {
createReturnOrderWorkflow,
createShippingOptionsWorkflow,
} from "@medusajs/core-flows"
import { import {
ModuleRegistrationName, ModuleRegistrationName,
Modules, Modules,
@@ -15,16 +19,12 @@ import {
ShippingOptionDTO, ShippingOptionDTO,
StockLocationDTO, StockLocationDTO,
} from "@medusajs/types" } from "@medusajs/types"
import { medusaIntegrationTestRunner } from "medusa-test-utils/dist"
import {
createReturnOrderWorkflow,
createShippingOptionsWorkflow,
} from "@medusajs/core-flows"
import { import {
ContainerRegistrationKeys, ContainerRegistrationKeys,
remoteQueryObjectFromString,
RuleOperator, RuleOperator,
remoteQueryObjectFromString,
} from "@medusajs/utils" } from "@medusajs/utils"
import { medusaIntegrationTestRunner } from "medusa-test-utils/dist"
jest.setTimeout(500000) jest.setTimeout(500000)
@@ -394,7 +394,7 @@ medusaIntegrationTestRunner({
await createReturnOrderWorkflow(container).run({ await createReturnOrderWorkflow(container).run({
input: createReturnOrderData, input: createReturnOrderData,
throwOnError: false, throwOnError: true,
}) })
const remoteQuery = container.resolve( const remoteQuery = container.resolve(
@@ -0,0 +1,423 @@
import {
createOrderFulfillmentWorkflow,
createOrderShipmentWorkflow,
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,
RuleOperator,
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: "Return 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,
},
],
rules: [
{
attribute: "is_return",
operator: RuleOperator.EQ,
value: '"true"',
},
],
}
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("Create 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 create a order fulfillment", async () => {
const order = await createOrderFixture({ container, product, location })
const createReturnOrderData: OrderWorkflow.CreateOrderFulfillmentWorkflowInput =
{
order_id: order.id,
created_by: "user_1",
items: [
{
id: order.items![0].id,
quantity: 1,
},
],
no_notification: false,
location_id: undefined,
}
const { result: fulfillment } = await createOrderFulfillmentWorkflow(
container
).run({
input: createReturnOrderData,
})
const createShipmentData: OrderWorkflow.CreateOrderShipmentWorkflowInput =
{
order_id: order.id,
fulfillment_id: fulfillment.id,
items: [
{
id: order.items![0].id,
quantity: 1,
},
],
labels: [
{
tracking_number: "123456",
tracking_url: "abcdef-xpress.com/track/123456",
label_url: "http://abcdef-xpress.com/label/123456",
},
],
}
await createOrderShipmentWorkflow(container).run({
input: createShipmentData,
})
const remoteQuery = container.resolve(
ContainerRegistrationKeys.REMOTE_QUERY
)
const remoteQueryObject = remoteQueryObjectFromString({
entryPoint: "order",
variables: {
id: order.id,
},
fields: [
"*",
"items.*",
"shipping_methods.*",
"total",
"item_total",
"fulfillments.*",
],
})
const [orderFulfill] = await remoteQuery(remoteQueryObject)
expect(orderFulfill.fulfillments).toHaveLength(1)
expect(orderFulfill.items[0].detail.fulfilled_quantity).toEqual(1)
const inventoryModule = container.resolve(
ModuleRegistrationName.INVENTORY
)
const reservation = await inventoryModule.listReservationItems({
line_item_id: order.items![0].id,
})
expect(reservation).toHaveLength(0)
const stockAvailability = await inventoryModule.retrieveStockedQuantity(
inventoryItem.id,
[location.id]
)
expect(stockAvailability).toEqual(1)
})
})
},
})
@@ -0,0 +1,29 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { FulfillmentTypes, IFulfillmentModuleService } from "@medusajs/types"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
export const createReturnFulfillmentStepId = "create-return-fulfillment"
export const createReturnFulfillmentStep = createStep(
createReturnFulfillmentStepId,
async (data: FulfillmentTypes.CreateFulfillmentDTO, { container }) => {
const service = container.resolve<IFulfillmentModuleService>(
ModuleRegistrationName.FULFILLMENT
)
const fulfillment = await service.createReturnFulfillment(data)
return new StepResponse(fulfillment, fulfillment.id)
},
async (id, { container }) => {
if (!id) {
return
}
const service = container.resolve<IFulfillmentModuleService>(
ModuleRegistrationName.FULFILLMENT
)
// await service.cancelReturnFulfillment(id) // TODO: Implement cancelReturnFulfillment
await service.cancelFulfillment(id)
}
)
@@ -1,14 +1,15 @@
export * from "./create-shipping-option-rules"
export * from "./add-shipping-options-prices" export * from "./add-shipping-options-prices"
export * from "./cancel-fulfillment" export * from "./cancel-fulfillment"
export * from "./create-fulfillment" export * from "./create-fulfillment"
export * from "./create-fulfillment-set" export * from "./create-fulfillment-set"
export * from "./create-return-fulfillment"
export * from "./create-service-zones" export * from "./create-service-zones"
export * from "./create-shipping-option-rules"
export * from "./create-shipping-profiles" export * from "./create-shipping-profiles"
export * from "./delete-fulfillment-sets" export * from "./delete-fulfillment-sets"
export * from "./delete-service-zones" export * from "./delete-service-zones"
export * from "./delete-shipping-options"
export * from "./delete-shipping-option-rules" export * from "./delete-shipping-option-rules"
export * from "./delete-shipping-options"
export * from "./set-shipping-options-prices" export * from "./set-shipping-options-prices"
export * from "./update-fulfillment" export * from "./update-fulfillment"
export * from "./upsert-shipping-options" export * from "./upsert-shipping-options"
@@ -1,12 +1,6 @@
import { FulfillmentDTO, FulfillmentWorkflow } from "@medusajs/types" import { FulfillmentDTO, FulfillmentWorkflow } from "@medusajs/types"
import { import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
WorkflowData,
createWorkflow,
transform,
} from "@medusajs/workflows-sdk"
import { createFulfillmentStep } from "../steps" import { createFulfillmentStep } from "../steps"
import { Modules } from "@medusajs/utils"
import { createLinkStep } from "../../common"
export const createFulfillmentWorkflowId = "create-fulfillment-workflow" export const createFulfillmentWorkflowId = "create-fulfillment-workflow"
export const createFulfillmentWorkflow = createWorkflow( export const createFulfillmentWorkflow = createWorkflow(
@@ -16,20 +10,6 @@ export const createFulfillmentWorkflow = createWorkflow(
): WorkflowData<FulfillmentDTO> => { ): WorkflowData<FulfillmentDTO> => {
const fulfillment = createFulfillmentStep(input) const fulfillment = createFulfillmentStep(input)
const link = transform(
{ order_id: input.order_id, fulfillment },
(data) => {
return [
{
[Modules.ORDER]: { order_id: data.order_id },
[Modules.FULFILLMENT]: { fulfillment_id: data.fulfillment.id },
},
]
}
)
createLinkStep(link)
return fulfillment return fulfillment
} }
) )
@@ -0,0 +1,16 @@
import { FulfillmentDTO, FulfillmentWorkflow } from "@medusajs/types"
import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
import { createReturnFulfillmentStep } from "../steps"
export const createReturnFulfillmentWorkflowId =
"create-return-fulfillment-workflow"
export const createReturnFulfillmentWorkflow = createWorkflow(
createReturnFulfillmentWorkflowId,
(
input: WorkflowData<FulfillmentWorkflow.CreateFulfillmentWorkflowInput>
): WorkflowData<FulfillmentDTO> => {
const fulfillment = createReturnFulfillmentStep(input)
return fulfillment
}
)
@@ -1,6 +1,7 @@
export * from "./batch-shipping-option-rules" export * from "./batch-shipping-option-rules"
export * from "./cancel-fulfillment" export * from "./cancel-fulfillment"
export * from "./create-fulfillment" export * from "./create-fulfillment"
export * from "./create-return-fulfillment"
export * from "./create-service-zones" export * from "./create-service-zones"
export * from "./create-shipment" export * from "./create-shipment"
export * from "./create-shipping-options" export * from "./create-shipping-options"
@@ -0,0 +1,47 @@
import { IInventoryServiceNext, InventoryNext } from "@medusajs/types"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
export const adjustInventoryLevelsStepId = "adjust-inventory-levels-step"
export const adjustInventoryLevelsStep = createStep(
adjustInventoryLevelsStepId,
async (
input: InventoryNext.BulkAdjustInventoryLevelInput[],
{ container }
) => {
const inventoryService: IInventoryServiceNext = container.resolve(
ModuleRegistrationName.INVENTORY
)
const adjustedLevels: InventoryNext.InventoryLevelDTO[] =
await inventoryService.adjustInventory(
input.map((item) => {
return {
inventoryItemId: item.inventory_item_id,
locationId: item.location_id,
adjustment: item.adjustment,
}
})
)
return new StepResponse(
adjustedLevels,
input.map((item) => {
return {
...item,
adjustment: item.adjustment * -1,
}
})
)
},
async (adjustedLevels, { container }) => {
if (!adjustedLevels) {
return
}
const inventoryService = container.resolve(ModuleRegistrationName.INVENTORY)
await inventoryService.adjustInventory(adjustedLevels)
}
)
@@ -1,10 +1,11 @@
export * from "./delete-inventory-items" export * from "./adjust-inventory-levels"
export * from "./attach-inventory-items" export * from "./attach-inventory-items"
export * from "./create-inventory-items" export * from "./create-inventory-items"
export * from "./validate-singular-inventory-items-for-tags"
export * from "./create-inventory-levels" export * from "./create-inventory-levels"
export * from "./validate-inventory-locations" export * from "./delete-inventory-items"
export * from "./update-inventory-items"
export * from "./delete-inventory-levels" export * from "./delete-inventory-levels"
export * from "./update-inventory-levels"
export * from "./delete-levels-by-item-and-location" export * from "./delete-levels-by-item-and-location"
export * from "./update-inventory-items"
export * from "./update-inventory-levels"
export * from "./validate-inventory-locations"
export * from "./validate-singular-inventory-items-for-tags"
@@ -1,6 +1,6 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk" import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { CreateOrderReturnDTO, IOrderModuleService } from "@medusajs/types" import { CreateOrderReturnDTO, IOrderModuleService } from "@medusajs/types"
import { createStep, StepResponse } from "@medusajs/workflows-sdk" import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type CreateReturnStepInput = CreateOrderReturnDTO type CreateReturnStepInput = CreateOrderReturnDTO
@@ -12,11 +12,11 @@ export const createReturnStep = createStep(
ModuleRegistrationName.ORDER ModuleRegistrationName.ORDER
) )
const created = await service.createReturn(data) await service.createReturn(data)
return new StepResponse(created, created) return new StepResponse(void 0, data.order_id)
}, },
async (createdId, { container }) => { async (orderId, { container }) => {
if (!createdId) { if (!orderId) {
return return
} }
@@ -24,6 +24,6 @@ export const createReturnStep = createStep(
ModuleRegistrationName.ORDER ModuleRegistrationName.ORDER
) )
// TODO: delete return await service.revertLastVersion(orderId)
} }
) )
@@ -3,5 +3,7 @@ export * from "./complete-orders"
export * from "./create-orders" export * from "./create-orders"
export * from "./get-item-tax-lines" export * from "./get-item-tax-lines"
export * from "./link-order-payment-collection" export * from "./link-order-payment-collection"
export * from "./register-fulfillment"
export * from "./register-shipment"
export * from "./set-tax-lines-for-items" export * from "./set-tax-lines-for-items"
export * from "./update-tax-lines" export * from "./update-tax-lines"
@@ -0,0 +1,32 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import {
IOrderModuleService,
RegisterOrderFulfillmentDTO,
} from "@medusajs/types"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type RegisterOrderFulfillmentStepInput = RegisterOrderFulfillmentDTO
export const registerOrderFulfillmentStepId = "register-order-fullfillment"
export const registerOrderFulfillmentStep = createStep(
registerOrderFulfillmentStepId,
async (data: RegisterOrderFulfillmentStepInput, { container }) => {
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
await service.registerFulfillment(data)
return new StepResponse(void 0, data.order_id)
},
async (orderId, { container }) => {
if (!orderId) {
return
}
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
await service.revertLastVersion(orderId)
}
)
@@ -0,0 +1,29 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { IOrderModuleService, RegisterOrderShipmentDTO } from "@medusajs/types"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type RegisterOrderShipmentStepInput = RegisterOrderShipmentDTO
export const registerOrderShipmentStepId = "register-order-shipment"
export const registerOrderShipmentStep = createStep(
registerOrderShipmentStepId,
async (data: RegisterOrderShipmentStepInput, { container }) => {
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
await service.registerShipment(data)
return new StepResponse(void 0, data.order_id)
},
async (orderId, { container }) => {
if (!orderId) {
return
}
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
await service.revertLastVersion(orderId)
}
)
@@ -0,0 +1,32 @@
import { OrderDTO, OrderWorkflow } from "@medusajs/types"
import { MedusaError, OrderStatus, arrayDifference } from "@medusajs/utils"
export function throwIfOrderIsCancelled({ order }: { order: OrderDTO }) {
if (order.status === OrderStatus.CANCELED) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`Order with id ${order.id} has been cancelled.`
)
}
}
export function throwIfItemsDoesNotExistsInOrder({
order,
inputItems,
}: {
order: Pick<OrderDTO, "id" | "items">
inputItems: OrderWorkflow.CreateOrderFulfillmentWorkflowInput["items"]
}) {
const orderItemIds = order.items?.map((i) => i.id) ?? []
const inputItemIds = inputItems.map((i) => i.id)
const diff = arrayDifference(inputItemIds, orderItemIds)
if (diff.length) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`Items with ids ${diff.join(", ")} does not exist in order with id ${
order.id
}.`
)
}
}
@@ -0,0 +1,278 @@
import { Modules } from "@medusajs/modules-sdk"
import {
FulfillmentDTO,
FulfillmentWorkflow,
OrderDTO,
OrderWorkflow,
} from "@medusajs/types"
import { MedusaError } from "@medusajs/utils"
import {
WorkflowData,
createStep,
createWorkflow,
parallelize,
transform,
} from "@medusajs/workflows-sdk"
import { createLinkStep, useRemoteQueryStep } from "../../common"
import { createFulfillmentWorkflow } from "../../fulfillment"
import { adjustInventoryLevelsStep } from "../../inventory"
import {
deleteReservationsStep,
updateReservationsStep,
} from "../../reservation"
import { registerOrderFulfillmentStep } from "../steps"
import {
throwIfItemsDoesNotExistsInOrder,
throwIfOrderIsCancelled,
} from "../utils/order-validation"
const validateOrder = createStep(
"validate-order",
(
{
order,
inputItems,
}: {
order: OrderDTO
inputItems: OrderWorkflow.CreateOrderFulfillmentWorkflowInput["items"]
},
context
) => {
throwIfOrderIsCancelled({ order })
throwIfItemsDoesNotExistsInOrder({ order, inputItems })
}
)
function prepareRegisterOrderFulfillmentData({
order,
fulfillment,
input,
}: {
order: OrderDTO
fulfillment: FulfillmentDTO
input: OrderWorkflow.CreateOrderFulfillmentWorkflowInput
}) {
return {
order_id: order.id,
reference: Modules.FULFILLMENT,
reference_id: fulfillment.id,
created_by: input.created_by,
items: order.items!.map((i) => {
return {
id: i.id,
quantity: i.quantity,
}
}),
}
}
function prepareFulfillmentData({
order,
input,
shippingOption,
}: {
order: OrderDTO
input: OrderWorkflow.CreateOrderFulfillmentWorkflowInput
shippingOption: {
id: string
provider_id: string
service_zone: { fulfillment_set: { location?: { id: string } } }
}
}) {
const inputItems = input.items
const orderItemsMap = new Map<string, Required<OrderDTO>["items"][0]>(
order.items!.map((i) => [i.id, i])
)
const fulfillmentItems = inputItems.map((i) => {
const orderItem = orderItemsMap.get(i.id)!
return {
line_item_id: i.id,
quantity: i.quantity,
title: orderItem.variant_title ?? orderItem.title,
sku: orderItem.variant_sku || "",
barcode: orderItem.variant_barcode || "",
} as FulfillmentWorkflow.CreateFulfillmentItemWorkflowDTO
})
let locationId: string | undefined = input.location_id
if (!locationId) {
locationId = shippingOption.service_zone.fulfillment_set.location?.id
}
if (!locationId) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`Cannot create fulfillment without stock location, either provide a location or you should link the shipping option ${shippingOption.id} to a stock location.`
)
}
return {
input: {
location_id: locationId,
provider_id: shippingOption.provider_id,
shipping_option_id: shippingOption.id,
items: fulfillmentItems,
labels: [] as FulfillmentWorkflow.CreateFulfillmentLabelWorkflowDTO[], // TODO: shipping labels
delivery_address: order.shipping_address ?? ({} as any),
},
}
}
function prepareInventoryReservations({ reservations, order, input }) {
if (!reservations || !reservations.length) {
throw new Error(
`No stock reservation found for items ${input.items.map((i) => i.id)}`
)
}
const reservationMap = reservations.reduce((acc, reservation) => {
acc[reservation.line_item_id as string] = reservation
return acc
}, {})
const inputItemsMap = input.items.reduce((acc, item) => {
acc[item.id] = item
return acc
}, {})
const toDelete: string[] = []
const toUpdate: {
id: string
quantity: number // TODO: BigNumberInput
location_id: string
}[] = []
const inventoryAdjustment: {
inventory_item_id: string
location_id: string
adjustment: number // TODO: BigNumberInput
}[] = []
for (const item of order.items) {
const reservation = reservationMap[item.id]
const inputQuantity = inputItemsMap[item.id]?.quantity ?? item.quantity
const quantity = reservation.quantity - inputQuantity
inventoryAdjustment.push({
inventory_item_id: reservation.inventory_item_id,
location_id: input.location_id ?? reservation.location_id,
adjustment: -item.quantity, // TODO: MathBN.mul(-1, item.quantity)
})
if (quantity === 0) {
toDelete.push(reservation.id)
} else {
toUpdate.push({
id: reservation.id,
quantity: quantity,
location_id: input.location_id ?? reservation.location_id,
})
}
}
return {
toDelete,
toUpdate,
inventoryAdjustment,
}
}
export const createOrderFulfillmentWorkflowId = "create-order-fulfillment"
export const createOrderFulfillmentWorkflow = createWorkflow(
createOrderFulfillmentWorkflowId,
(
input: WorkflowData<OrderWorkflow.CreateOrderFulfillmentWorkflowInput>
): WorkflowData<FulfillmentDTO> => {
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: [
"id",
"status",
"region_id",
"currency_code",
"items.*",
"shipping_address.*",
"shipping_methods.shipping_option_id", // TODO: which shipping method to use when multiple?
],
variables: { id: input.order_id },
list: false,
throw_if_key_not_found: true,
})
validateOrder({ order, inputItems: input.items })
const shippingOptionId = transform(order, (data) => {
return data.shipping_methods?.[0]?.shipping_option_id
})
const shippingOption = useRemoteQueryStep({
entry_point: "shipping_options",
fields: ["id", "provider_id", "service_zone.fulfillment_set.location.id"],
variables: {
id: shippingOptionId,
},
list: false,
throw_if_key_not_found: true,
}).config({ name: "get-shipping-option" })
const fulfillmentData = transform(
{ order, input, shippingOption },
prepareFulfillmentData
)
const fulfillment = createFulfillmentWorkflow.runAsStep(fulfillmentData)
const registerOrderFulfillmentData = transform(
{ order, fulfillment, input },
prepareRegisterOrderFulfillmentData
)
registerOrderFulfillmentStep(registerOrderFulfillmentData)
const link = transform(
{ order_id: input.order_id, fulfillment },
(data) => {
return [
{
[Modules.ORDER]: { order_id: data.order_id },
[Modules.FULFILLMENT]: { fulfillment_id: data.fulfillment.id },
},
]
}
)
createLinkStep(link)
const lineItemIds = transform({ order }, ({ order }) => {
return order.items?.map((i) => i.id)
})
const reservations = useRemoteQueryStep({
entry_point: "reservations",
fields: [
"id",
"line_item_id",
"quantity",
"inventory_item_id",
"location_id",
],
variables: {
filter: {
line_item_id: lineItemIds,
},
},
}).config({ name: "get-reservations" })
const { toDelete, toUpdate, inventoryAdjustment } = transform(
{ order, reservations, input },
prepareInventoryReservations
)
parallelize(
updateReservationsStep(toUpdate),
deleteReservationsStep(toDelete),
adjustInventoryLevelsStep(inventoryAdjustment)
)
// trigger event OrderModuleService.Events.FULFILLMENT_CREATED
return fulfillment
}
)
@@ -1,3 +1,4 @@
import { Modules } from "@medusajs/modules-sdk"
import { import {
CreateOrderShippingMethodDTO, CreateOrderShippingMethodDTO,
FulfillmentWorkflow, FulfillmentWorkflow,
@@ -7,55 +8,27 @@ import {
WithCalculatedPrice, WithCalculatedPrice,
} from "@medusajs/types" } from "@medusajs/types"
import { import {
ContainerRegistrationKeys,
MathBN,
MedusaError,
arrayDifference,
isDefined,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import {
WorkflowData,
createStep, createStep,
createWorkflow, createWorkflow,
transform, transform,
WorkflowData,
} from "@medusajs/workflows-sdk" } from "@medusajs/workflows-sdk"
import { createLinkStep, useRemoteQueryStep } from "../../common" import { createLinkStep, useRemoteQueryStep } from "../../common"
import { import { createReturnFulfillmentWorkflow } from "../../fulfillment"
arrayDifference,
ContainerRegistrationKeys,
isDefined,
MathBN,
MedusaError,
Modules,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import { updateOrderTaxLinesStep } from "../steps" import { updateOrderTaxLinesStep } from "../steps"
import { createReturnStep } from "../steps/create-return" import { createReturnStep } from "../steps/create-return"
import { createFulfillmentWorkflow } from "../../fulfillment" import {
throwIfItemsDoesNotExistsInOrder,
function throwIfOrderIsCancelled({ order }: { order: OrderDTO }) { throwIfOrderIsCancelled,
// TODO: need work, check canceled } from "../utils/order-validation"
if (false /*order.canceled_at*/) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`Order with id ${order.id} has been cancelled.`
)
}
}
function throwIfItemsDoesNotExistsInOrder({
order,
inputItems,
}: {
order: Pick<OrderDTO, "id" | "items">
inputItems: OrderWorkflow.CreateOrderReturnWorkflowInput["items"]
}) {
const orderItemIds = order.items?.map((i) => i.id) ?? []
const inputItemIds = inputItems.map((i) => i.id)
const diff = arrayDifference(inputItemIds, orderItemIds)
if (diff.length) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`Items with ids ${diff.join(", ")} does not exist in order with id ${
order.id
}.`
)
}
}
async function validateReturnReasons( async function validateReturnReasons(
{ {
@@ -214,8 +187,7 @@ function prepareFulfillmentData({
items: fulfillmentItems, items: fulfillmentItems,
labels: [] as FulfillmentWorkflow.CreateFulfillmentLabelWorkflowDTO[], labels: [] as FulfillmentWorkflow.CreateFulfillmentLabelWorkflowDTO[],
delivery_address: order.shipping_address ?? ({} as any), // TODO: should it be the stock location address? delivery_address: order.shipping_address ?? ({} as any), // TODO: should it be the stock location address?
order: {} as FulfillmentWorkflow.CreateFulfillmentOrderWorkflowDTO, // TODO see what todo here, is that even necessary? order: order,
order_id: input.order_id,
}, },
} }
} }
@@ -280,6 +252,7 @@ export const createReturnOrderWorkflow = createWorkflow(
entry_point: "orders", entry_point: "orders",
fields: [ fields: [
"id", "id",
"status",
"region_id", "region_id",
"currency_code", "currency_code",
"total", "total",
@@ -339,8 +312,20 @@ export const createReturnOrderWorkflow = createWorkflow(
prepareFulfillmentData prepareFulfillmentData
) )
createFulfillmentWorkflow.runAsStep(fulfillmentData) const returnFulfillment =
createReturnFulfillmentWorkflow.runAsStep(fulfillmentData)
// TODO call the createReturn from the fulfillment provider const link = transform(
{ order_id: input.order_id, fulfillment: returnFulfillment },
(data) => {
return [
{
[Modules.ORDER]: { order_id: data.order_id },
[Modules.FULFILLMENT]: { fulfillment_id: data.fulfillment.id },
},
]
}
)
createLinkStep(link)
} }
) )
@@ -0,0 +1,109 @@
import { FulfillmentDTO, OrderDTO, OrderWorkflow } from "@medusajs/types"
import { Modules } from "@medusajs/utils"
import {
WorkflowData,
createStep,
createWorkflow,
transform,
} from "@medusajs/workflows-sdk"
import { useRemoteQueryStep } from "../../common"
import { createShipmentWorkflow } from "../../fulfillment"
import { registerOrderShipmentStep } from "../steps"
import {
throwIfItemsDoesNotExistsInOrder,
throwIfOrderIsCancelled,
} from "../utils/order-validation"
const validateOrder = createStep(
"validate-order",
({
order,
input,
}: {
order: OrderDTO
input: OrderWorkflow.CreateOrderShipmentWorkflowInput
}) => {
const inputItems = input.items
throwIfOrderIsCancelled({ order })
throwIfItemsDoesNotExistsInOrder({ order, inputItems })
const order_ = order as OrderDTO & { fulfillments: FulfillmentDTO[] }
const fulfillment = order_.fulfillments.find(
(f) => f.id === input.fulfillment_id
)
if (!fulfillment) {
throw new Error(
`Fulfillment with id ${input.fulfillment_id} not found in the order`
)
}
}
)
function prepareRegisterShipmentData({
order,
input,
}: {
order: OrderDTO
input: OrderWorkflow.CreateOrderShipmentWorkflowInput
}) {
const fulfillId = input.fulfillment_id
const order_ = order as OrderDTO & { fulfillments: FulfillmentDTO[] }
const fulfillment = order_.fulfillments.find((f) => f.id === fulfillId)!
return {
order_id: order.id,
reference: Modules.FULFILLMENT,
reference_id: fulfillment.id,
created_by: input.created_by,
items: order.items!.map((i) => {
return {
id: i.id,
quantity: i.quantity,
}
}),
}
}
export const createOrderShipmentWorkflowId = "create-order-shipment"
export const createOrderShipmentWorkflow = createWorkflow(
createOrderShipmentWorkflowId,
(
input: WorkflowData<OrderWorkflow.CreateOrderShipmentWorkflowInput>
): WorkflowData<void> => {
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: [
"id",
"status",
"region_id",
"currency_code",
"items.*",
"fulfillments.*",
],
variables: { id: input.order_id },
list: false,
throw_if_key_not_found: true,
})
validateOrder({ order, input })
const fulfillmentData = transform({ input }, ({ input }) => {
return {
id: input.fulfillment_id,
labels: input.labels,
}
})
createShipmentWorkflow.runAsStep({
input: fulfillmentData,
})
const shipmentData = transform(
{ order, input },
prepareRegisterShipmentData
)
registerOrderShipmentStep(shipmentData)
}
)
@@ -1,5 +1,7 @@
export * from "./archive-orders" export * from "./archive-orders"
export * from "./complete-orders" export * from "./complete-orders"
export * from "./create-fulfillment"
export * from "./create-orders" export * from "./create-orders"
export * from "./create-return" export * from "./create-return"
export * from "./create-shipment"
export * from "./update-tax-lines" export * from "./update-tax-lines"
@@ -1,12 +1,8 @@
import { OrderDTO } from "../../order"
import { CreateFulfillmentAddressDTO } from "./fulfillment-address" import { CreateFulfillmentAddressDTO } from "./fulfillment-address"
import { CreateFulfillmentItemDTO } from "./fulfillment-item" import { CreateFulfillmentItemDTO } from "./fulfillment-item"
import { CreateFulfillmentLabelDTO } from "./fulfillment-label" import { CreateFulfillmentLabelDTO } from "./fulfillment-label"
/**
* The fulfillment order to be created.
*/
export interface CreateFulfillmentOrderDTO {}
/** /**
* The fulfillment to be created. * The fulfillment to be created.
*/ */
@@ -72,9 +68,9 @@ export interface CreateFulfillmentDTO {
labels: Omit<CreateFulfillmentLabelDTO, "fulfillment_id">[] labels: Omit<CreateFulfillmentLabelDTO, "fulfillment_id">[]
/** /**
* The associated fulfillment order. * The associated order to be sent to the provider.
*/ */
order: CreateFulfillmentOrderDTO order?: Partial<OrderDTO>
} }
/** /**
@@ -51,7 +51,7 @@ export interface IFulfillmentProvider {
createFulfillment( createFulfillment(
data: object, data: object,
items: object[], items: object[],
order: object, order: object | undefined,
fulfillment: Record<string, unknown> fulfillment: Record<string, unknown>
): Promise<Record<string, unknown>> ): Promise<Record<string, unknown>>
/** /**
@@ -56,3 +56,19 @@ export type BulkUpdateInventoryLevelInput = {
*/ */
location_id: string location_id: string
} & UpdateInventoryLevelInput } & UpdateInventoryLevelInput
export type BulkAdjustInventoryLevelInput = {
/**
* The ID of the associated inventory level.
*/
inventory_item_id: string
/**
* The ID of the associated location.
*/
location_id: string
/**
* The quantity to adjust the inventory level by.
*/
adjustment: number // TODO: BigNumberInput
} & UpdateInventoryLevelInput
@@ -1,9 +1,9 @@
import { RestoreReturn, SoftDeleteReturn } from "../dal" import { RestoreReturn, SoftDeleteReturn } from "../dal"
import { Context } from "../shared-context" import { InventoryNext } from "."
import { FindConfig } from "../common" import { FindConfig } from "../common"
import { IModuleService } from "../modules-sdk" import { IModuleService } from "../modules-sdk"
import { InventoryNext } from "." import { Context } from "../shared-context"
/** /**
* The main service interface for the Inventory Module. * The main service interface for the Inventory Module.
@@ -994,6 +994,16 @@ export interface IInventoryServiceNext extends IModuleService {
* -5 * -5
* ) * )
*/ */
adjustInventory(
data: {
inventoryItemId: string
locationId: string
adjustment: number
}[],
context?: Context
): Promise<InventoryNext.InventoryLevelDTO[]>
adjustInventory( adjustInventory(
inventoryItemId: string, inventoryItemId: string,
locationId: string, locationId: string,
+1 -1
View File
@@ -389,8 +389,8 @@ export interface RegisterOrderShipmentDTO {
description?: string description?: string
internal_note?: string internal_note?: string
reference?: string reference?: string
reference_id?: string
created_by?: string created_by?: string
shipping_method: Omit<CreateOrderShippingMethodDTO, "order_id"> | string
items: { items: {
id: string id: string
quantity: BigNumberInput quantity: BigNumberInput
@@ -177,10 +177,7 @@ export type CreateFulfillmentWorkflowInput = {
labels: CreateFulfillmentLabelWorkflowDTO[] labels: CreateFulfillmentLabelWorkflowDTO[]
/** /**
* The associated fulfillment order. * The associated fulfillment order to be sent to the provider.
*/ */
order: CreateFulfillmentOrderWorkflowDTO order?: CreateFulfillmentOrderWorkflowDTO
// TODO: revisit - either remove `order_id` or `order`
order_id: string
} }
@@ -12,5 +12,5 @@ export interface CreateShipmentWorkflowInput {
/** /**
* The labels associated with the fulfillment. * The labels associated with the fulfillment.
*/ */
labels?: CreateFulfillmentLabelWorkflowDTO[] labels: CreateFulfillmentLabelWorkflowDTO[]
} }
@@ -0,0 +1,15 @@
import { BigNumberInput } from "../../totals"
interface CreateOrderFulfillmentItem {
id: string
quantity: BigNumberInput
}
export interface CreateOrderFulfillmentWorkflowInput {
order_id: string
created_by?: string // The id of the authenticated user
items: CreateOrderFulfillmentItem[]
no_notification?: boolean
location_id?: string
metadata?: Record<string, any>
}
@@ -0,0 +1,17 @@
import { BigNumberInput } from "../../totals"
import { CreateFulfillmentLabelWorkflowDTO } from "../fulfillment"
interface CreateOrderShipmentItem {
id: string
quantity: BigNumberInput
}
export interface CreateOrderShipmentWorkflowInput {
order_id: string
fulfillment_id: string
created_by?: string // The id of the authenticated user
items: CreateOrderShipmentItem[]
labels: CreateFulfillmentLabelWorkflowDTO[]
no_notification?: boolean
metadata?: Record<string, any>
}
@@ -1 +1,3 @@
export * from "./create-fulfillment"
export * from "./create-return-order" export * from "./create-return-order"
export * from "./create-shipment"
@@ -1,5 +1,8 @@
import { archiveOrderWorkflow } from "@medusajs/core-flows" import { archiveOrderWorkflow } from "@medusajs/core-flows"
import { remoteQueryObjectFromString } from "@medusajs/utils" import {
ContainerRegistrationKeys,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import { import {
AuthenticatedMedusaRequest, AuthenticatedMedusaRequest,
MedusaResponse, MedusaResponse,
@@ -10,7 +13,7 @@ export const POST = async (
req: AuthenticatedMedusaRequest<AdminArchiveOrderType>, req: AuthenticatedMedusaRequest<AdminArchiveOrderType>,
res: MedusaResponse res: MedusaResponse
) => { ) => {
const remoteQuery = req.scope.resolve("remoteQuery") const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const { id } = req.params const { id } = req.params
await archiveOrderWorkflow(req.scope).run({ await archiveOrderWorkflow(req.scope).run({
@@ -1,4 +1,7 @@
import { remoteQueryObjectFromString } from "@medusajs/utils" import {
ContainerRegistrationKeys,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import { import {
AuthenticatedMedusaRequest, AuthenticatedMedusaRequest,
MedusaResponse, MedusaResponse,
@@ -8,7 +11,7 @@ export const GET = async (
req: AuthenticatedMedusaRequest, req: AuthenticatedMedusaRequest,
res: MedusaResponse res: MedusaResponse
) => { ) => {
const remoteQuery = req.scope.resolve("remoteQuery") const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const variables = { id: req.params.id } const variables = { id: req.params.id }
@@ -1,5 +1,8 @@
import { completeOrderWorkflow } from "@medusajs/core-flows" import { completeOrderWorkflow } from "@medusajs/core-flows"
import { remoteQueryObjectFromString } from "@medusajs/utils" import {
ContainerRegistrationKeys,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import { import {
AuthenticatedMedusaRequest, AuthenticatedMedusaRequest,
MedusaResponse, MedusaResponse,
@@ -10,7 +13,7 @@ export const POST = async (
req: AuthenticatedMedusaRequest<AdminCompleteOrderType>, req: AuthenticatedMedusaRequest<AdminCompleteOrderType>,
res: MedusaResponse res: MedusaResponse
) => { ) => {
const remoteQuery = req.scope.resolve("remoteQuery") const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const { id } = req.params const { id } = req.params
await completeOrderWorkflow(req.scope).run({ await completeOrderWorkflow(req.scope).run({
@@ -1,14 +1,17 @@
import { remoteQueryObjectFromString } from "@medusajs/utils" import {
ContainerRegistrationKeys,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import { import {
AuthenticatedMedusaRequest, AuthenticatedMedusaRequest,
MedusaResponse, MedusaResponse,
} from "../../../../../../types/routing" } from "../../../../../../../types/routing"
export const POST = async ( export const POST = async (
req: AuthenticatedMedusaRequest, req: AuthenticatedMedusaRequest,
res: MedusaResponse res: MedusaResponse
) => { ) => {
const remoteQuery = req.scope.resolve("remoteQuery") const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const variables = { id: req.params.id } const variables = { id: req.params.id }
@@ -0,0 +1,44 @@
import { createOrderShipmentWorkflow } from "@medusajs/core-flows"
import {
ContainerRegistrationKeys,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "../../../../../../../types/routing"
import { AdminOrderCreateShipmentType } from "../../../../validators"
export const POST = async (
req: AuthenticatedMedusaRequest<AdminOrderCreateShipmentType>,
res: MedusaResponse
) => {
const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const variables = { id: req.params.id }
const input = {
...req.validatedBody,
order_id: req.params.id,
fulfillment_id: req.params.fulfillment_id,
labels: req.validatedBody.labels ?? [],
}
const { errors } = await createOrderShipmentWorkflow(req.scope).run({
input,
throwOnError: false,
})
if (Array.isArray(errors) && errors[0]) {
throw errors[0].error
}
const queryObject = remoteQueryObjectFromString({
entryPoint: "order",
variables,
fields: req.remoteQueryConfig.fields,
})
const [order] = await remoteQuery(queryObject)
res.status(200).json({ order })
}
@@ -0,0 +1,42 @@
import { createOrderFulfillmentWorkflow } from "@medusajs/core-flows"
import {
ContainerRegistrationKeys,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "../../../../../types/routing"
import { AdminOrderCreateFulfillmentType } from "../../validators"
export const POST = async (
req: AuthenticatedMedusaRequest<AdminOrderCreateFulfillmentType>,
res: MedusaResponse
) => {
const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const variables = { id: req.params.id }
const input = {
...req.validatedBody,
order_id: req.params.id,
}
const { errors } = await createOrderFulfillmentWorkflow(req.scope).run({
input,
throwOnError: false,
})
if (Array.isArray(errors) && errors[0]) {
throw errors[0].error
}
const queryObject = remoteQueryObjectFromString({
entryPoint: "order",
variables,
fields: req.remoteQueryConfig.fields,
})
const [order] = await remoteQuery(queryObject)
res.status(200).json({ order })
}
@@ -1,4 +1,7 @@
import { remoteQueryObjectFromString } from "@medusajs/utils" import {
ContainerRegistrationKeys,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import { import {
AuthenticatedMedusaRequest, AuthenticatedMedusaRequest,
MedusaResponse, MedusaResponse,
@@ -8,7 +11,7 @@ export const GET = async (
req: AuthenticatedMedusaRequest, req: AuthenticatedMedusaRequest,
res: MedusaResponse res: MedusaResponse
) => { ) => {
const remoteQuery = req.scope.resolve("remoteQuery") const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const variables = { id: req.params.id } const variables = { id: req.params.id }
@@ -26,7 +29,7 @@ export const POST = async (
req: AuthenticatedMedusaRequest, req: AuthenticatedMedusaRequest,
res: MedusaResponse res: MedusaResponse
) => { ) => {
const remoteQuery = req.scope.resolve("remoteQuery") const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const variables = { id: req.params.id } const variables = { id: req.params.id }
@@ -1,25 +0,0 @@
import { remoteQueryObjectFromString } from "@medusajs/utils"
import {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "../../../../types/routing"
export const POST = async (
req: AuthenticatedMedusaRequest,
res: MedusaResponse
) => {
const remoteQuery = req.scope.resolve("remoteQuery")
const variables = { id: req.params.id }
// TODO: Workflow fulfill items, create fulfillments - v1.x - packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts
const queryObject = remoteQueryObjectFromString({
entryPoint: "order",
variables,
fields: req.remoteQueryConfig.fields,
})
const [order] = await remoteQuery(queryObject)
res.status(200).json({ order })
}
@@ -8,6 +8,7 @@ import {
AdminCompleteOrder, AdminCompleteOrder,
AdminGetOrdersOrderParams, AdminGetOrdersOrderParams,
AdminGetOrdersParams, AdminGetOrdersParams,
AdminOrderCreateFulfillment,
} from "./validators" } from "./validators"
export const adminOrderRoutesMiddlewares: MiddlewareRoute[] = [ export const adminOrderRoutesMiddlewares: MiddlewareRoute[] = [
@@ -74,7 +75,7 @@ export const adminOrderRoutesMiddlewares: MiddlewareRoute[] = [
method: ["POST"], method: ["POST"],
matcher: "/admin/orders/:id/fulfillments", matcher: "/admin/orders/:id/fulfillments",
middlewares: [ middlewares: [
// validateAndTransformBody(), validateAndTransformBody(AdminOrderCreateFulfillment),
validateAndTransformQuery( validateAndTransformQuery(
AdminGetOrdersOrderParams, AdminGetOrdersOrderParams,
QueryConfig.retrieveTransformQueryConfig QueryConfig.retrieveTransformQueryConfig
@@ -46,3 +46,36 @@ export const AdminCompleteOrder = z.object({
order_id: z.string(), order_id: z.string(),
}) })
export type AdminCompleteOrderType = z.infer<typeof AdminArchiveOrder> export type AdminCompleteOrderType = z.infer<typeof AdminArchiveOrder>
const Item = z.object({
id: z.string(),
quantity: z.number(),
})
export const AdminOrderCreateFulfillment = z.object({
items: z.array(Item),
location_id: z.string().optional(),
no_notification: z.boolean().optional(),
metadata: z.record(z.unknown()).optional(),
})
export type AdminOrderCreateFulfillmentType = z.infer<
typeof AdminOrderCreateFulfillment
>
const Label = z.object({
tracking_number: z.string(),
tracking_url: z.string(),
label_url: z.string(),
})
export const AdminOrderCreateShipment = z.object({
items: z.array(Item),
labels: z.array(Label).optional(),
no_notification: z.boolean().optional(),
metadata: z.record(z.unknown()).optional(),
})
export type AdminOrderCreateShipmentType = z.infer<
typeof AdminOrderCreateShipment
>
@@ -4,7 +4,7 @@ import {
FulfillmentTypes, FulfillmentTypes,
IFulfillmentProvider, IFulfillmentProvider,
} from "@medusajs/types" } from "@medusajs/types"
import { ModulesSdkUtils, promiseAll, MedusaError } from "@medusajs/utils" import { MedusaError, ModulesSdkUtils, promiseAll } from "@medusajs/utils"
import { FulfillmentProvider } from "@models" import { FulfillmentProvider } from "@models"
type InjectedDependencies = { type InjectedDependencies = {
@@ -86,7 +86,7 @@ export default class FulfillmentProviderService extends ModulesSdkUtils.internal
providerId: string, providerId: string,
data: object, data: object,
items: object[], items: object[],
order: object, order: object | undefined,
fulfillment: Record<string, unknown> fulfillment: Record<string, unknown>
): Promise<Record<string, unknown>> { ): Promise<Record<string, unknown>> {
const provider = this.retrieveProviderRegistration(providerId) const provider = this.retrieveProviderRegistration(providerId)
@@ -101,10 +101,7 @@ export default class FulfillmentProviderService extends ModulesSdkUtils.internal
return await provider.cancelFulfillment(fulfillment) return await provider.cancelFulfillment(fulfillment)
} }
async createReturn( async createReturn(providerId: string, fulfillment: Record<string, unknown>) {
providerId: string,
fulfillment: Record<string, unknown>,
) {
const provider = this.retrieveProviderRegistration(providerId) const provider = this.retrieveProviderRegistration(providerId)
return await provider.createReturnFulfillment(fulfillment) return await provider.createReturnFulfillment(fulfillment)
} }
@@ -19,6 +19,7 @@ import {
MedusaError, MedusaError,
ModulesSdkUtils, ModulesSdkUtils,
isDefined, isDefined,
isString,
partitionArray, partitionArray,
promiseAll, promiseAll,
} from "@medusajs/utils" } from "@medusajs/utils"
@@ -799,33 +800,68 @@ export default class InventoryModuleService<
* @return The updated inventory level * @return The updated inventory level
* @throws when the inventory level is not found * @throws when the inventory level is not found
*/ */
@InjectManager("baseRepository_") adjustInventory(
@EmitEvents()
async adjustInventory(
inventoryItemId: string, inventoryItemId: string,
locationId: string, locationId: string,
adjustment: number, adjustment: number,
@MedusaContext() context: Context = {} context: Context
): Promise<InventoryNext.InventoryLevelDTO> { ): Promise<InventoryNext.InventoryLevelDTO>
const result = await this.adjustInventory_(
inventoryItemId,
locationId,
adjustment,
context
)
context.messageAggregator?.saveRawMessageData({ adjustInventory(
eventName: InventoryEvents.inventory_level_updated, data: {
metadata: { inventoryItemId: string
service: this.constructor.name, locationId: string
action: CommonEvents.UPDATED, adjustment: number
object: "inventory-level", }[],
}, context: Context
data: { id: result.id }, ): Promise<InventoryNext.InventoryLevelDTO[]>
})
@InjectManager("baseRepository_")
@EmitEvents()
async adjustInventory(
inventoryItemIdOrData: string | any,
locationId?: string | Context,
adjustment?: number,
@MedusaContext() context: Context = {}
): Promise<
InventoryNext.InventoryLevelDTO | InventoryNext.InventoryLevelDTO[]
> {
let all: any = inventoryItemIdOrData
if (isString(inventoryItemIdOrData)) {
all = [
{
inventoryItemId: inventoryItemIdOrData,
locationId,
adjustment,
},
]
}
const results: TInventoryLevel[] = []
for (const data of all) {
const result = await this.adjustInventory_(
data.inventoryItemId,
data.locationId,
data.adjustment,
context
)
results.push(result)
context.messageAggregator?.saveRawMessageData({
eventName: InventoryEvents.inventory_level_updated,
metadata: {
service: this.constructor.name,
action: CommonEvents.UPDATED,
object: "inventory-level",
},
data: { id: result.id },
})
}
return await this.baseRepository_.serialize<InventoryNext.InventoryLevelDTO>( return await this.baseRepository_.serialize<InventoryNext.InventoryLevelDTO>(
result, Array.isArray(inventoryItemIdOrData) ? results : results[0],
{ {
populate: true, populate: true,
} }
@@ -489,7 +489,6 @@ moduleIntegrationTestRunner({
await service.registerShipment({ await service.registerShipment({
order_id: createdOrder.id, order_id: createdOrder.id,
reference: Modules.FULFILLMENT, reference: Modules.FULFILLMENT,
shipping_method: createdOrder.shipping_methods![0].id,
items: createdOrder.items!.map((item) => { items: createdOrder.items!.map((item) => {
return { return {
id: item.id, id: item.id,
@@ -2149,35 +2149,12 @@ export default class OrderModuleService<
): Promise<void> { ): Promise<void> {
let shippingMethodId let shippingMethodId
if (!isString(data.shipping_method)) {
const methods = await this.createShippingMethods(
data.order_id,
data.shipping_method as any,
sharedContext
)
shippingMethodId = methods[0].id
} else {
shippingMethodId = data.shipping_method
}
const method = await this.shippingMethodService_.retrieve(
shippingMethodId,
{
relations: ["tax_lines", "adjustments"],
},
sharedContext
)
const calculatedAmount = getShippingMethodsTotals([method as any], {})[
method.id
]
const actions: CreateOrderChangeActionDTO[] = data.items.map((item) => { const actions: CreateOrderChangeActionDTO[] = data.items.map((item) => {
return { return {
action: ChangeActionType.SHIP_ITEM, action: ChangeActionType.SHIP_ITEM,
internal_note: item.internal_note, internal_note: item.internal_note,
reference: data.reference, reference: data.reference,
reference_id: shippingMethodId, reference_id: data.reference_id,
details: { details: {
reference_id: item.id, reference_id: item.id,
quantity: item.quantity, quantity: item.quantity,
@@ -2191,7 +2168,6 @@ export default class OrderModuleService<
action: ChangeActionType.SHIPPING_ADD, action: ChangeActionType.SHIPPING_ADD,
reference: data.reference, reference: data.reference,
reference_id: shippingMethodId, reference_id: shippingMethodId,
amount: calculatedAmount.total,
}) })
} }