chore(order): Paid Total and Refunded Total (#7373)

This commit is contained in:
Carlos R. L. Rodrigues
2024-05-20 15:48:57 -03:00
committed by GitHub
parent 025536e2a5
commit f57dc98c7a
24 changed files with 340 additions and 175 deletions
@@ -2,19 +2,19 @@ import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { IOrderModuleService } from "@medusajs/types" import { IOrderModuleService } from "@medusajs/types"
import { StepResponse, createStep } from "@medusajs/workflows-sdk" import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type CompleteOrdersStepInput = { type ArchiveOrdersStepInput = {
order_ids: string[] orderIds: string[]
} }
export const archiveOrdersStepId = "archive-orders" export const archiveOrdersStepId = "archive-orders"
export const archiveOrdersStep = createStep( export const archiveOrdersStep = createStep(
archiveOrdersStepId, archiveOrdersStepId,
async (data: CompleteOrdersStepInput, { container }) => { async (data: ArchiveOrdersStepInput, { container }) => {
const service = container.resolve<IOrderModuleService>( const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER ModuleRegistrationName.ORDER
) )
const archived = await service.archive(data.order_ids) const archived = await service.archive(data.orderIds)
return new StepResponse( return new StepResponse(
archived, archived,
archived.map((store) => { archived.map((store) => {
@@ -3,7 +3,7 @@ import { IOrderModuleService } from "@medusajs/types"
import { StepResponse, createStep } from "@medusajs/workflows-sdk" import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type CompleteOrdersStepInput = { type CompleteOrdersStepInput = {
order_ids: string[] orderIds: string[]
} }
export const completeOrdersStepId = "complete-orders" export const completeOrdersStepId = "complete-orders"
@@ -14,7 +14,7 @@ export const completeOrdersStep = createStep(
ModuleRegistrationName.ORDER ModuleRegistrationName.ORDER
) )
const completed = await service.completeOrder(data.order_ids) const completed = await service.completeOrder(data.orderIds)
return new StepResponse( return new StepResponse(
completed, completed,
completed.map((store) => { completed.map((store) => {
@@ -3,7 +3,7 @@ import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
import { archiveOrdersStep } from "../steps" import { archiveOrdersStep } from "../steps"
type ArchiveOrdersStepInput = { type ArchiveOrdersStepInput = {
order_ids: string[] orderIds: string[]
} }
export const archiveOrderWorkflowId = "archive-order-workflow" export const archiveOrderWorkflowId = "archive-order-workflow"
@@ -3,7 +3,7 @@ import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
import { completeOrdersStep } from "../steps" import { completeOrdersStep } from "../steps"
type CompleteOrdersStepInput = { type CompleteOrdersStepInput = {
order_ids: string[] orderIds: string[]
} }
export const completeOrderWorkflowId = "complete-order-workflow" export const completeOrderWorkflowId = "complete-order-workflow"
@@ -20,6 +20,8 @@ interface OrderSummary {
future_projected_total: number future_projected_total: number
balance: number balance: number
future_balance: number future_balance: number
paid_total: number
refunded_total: number
} }
interface OrderAdjustmentLine { interface OrderAdjustmentLine {
+3 -4
View File
@@ -38,6 +38,9 @@ export type OrderSummaryDTO = {
balance: BigNumberValue balance: BigNumberValue
future_balance: BigNumberValue future_balance: BigNumberValue
paid_total: BigNumberValue
refunded_total: BigNumberValue
} }
export interface OrderAdjustmentLineDTO { export interface OrderAdjustmentLineDTO {
@@ -1266,10 +1269,6 @@ export interface OrderTransactionDTO {
* The ID of the reference * The ID of the reference
*/ */
reference_id: string reference_id: string
/**
* The metadata of the transaction
*/
metadata: Record<string, unknown> | null
/** /**
* When the transaction was created * When the transaction was created
*/ */
+1 -1
View File
@@ -317,7 +317,7 @@ export interface UpdateOrderChangeActionDTO {
export interface CreateOrderTransactionDTO { export interface CreateOrderTransactionDTO {
order_id: string order_id: string
description?: string description?: string
reference_type?: string reference?: string
reference_id?: string reference_id?: string
internal_note?: string internal_note?: string
created_by?: string created_by?: string
+4 -26
View File
@@ -59,8 +59,6 @@ import {
UpdateOrderReturnReasonWithSelectorDTO, UpdateOrderReturnReasonWithSelectorDTO,
UpdateOrderShippingMethodAdjustmentDTO, UpdateOrderShippingMethodAdjustmentDTO,
UpdateOrderShippingMethodTaxLineDTO, UpdateOrderShippingMethodTaxLineDTO,
UpdateOrderTransactionDTO,
UpdateOrderTransactionWithSelectorDTO,
UpsertOrderLineItemAdjustmentDTO, UpsertOrderLineItemAdjustmentDTO,
} from "./mutations" } from "./mutations"
@@ -1400,14 +1398,8 @@ export interface IOrderModuleService extends IModuleService {
revertLastVersion(orderId: string, sharedContext?: Context): Promise<void> revertLastVersion(orderId: string, sharedContext?: Context): Promise<void>
retrieveTransaction(
id: string,
config?: FindConfig<OrderTransactionDTO>,
sharedContext?: Context
): Promise<OrderTransactionDTO>
listTransactions( listTransactions(
filters: FilterableOrderTransactionProps, filters?: FilterableOrderTransactionProps,
config?: FindConfig<OrderTransactionDTO>, config?: FindConfig<OrderTransactionDTO>,
sharedContext?: Context sharedContext?: Context
): Promise<OrderTransactionDTO[]> ): Promise<OrderTransactionDTO[]>
@@ -1422,33 +1414,19 @@ export interface IOrderModuleService extends IModuleService {
sharedContext?: Context sharedContext?: Context
): Promise<OrderTransactionDTO[]> ): Promise<OrderTransactionDTO[]>
updateTransactions(
data: UpdateOrderTransactionWithSelectorDTO[]
): Promise<OrderTransactionDTO[]>
updateTransactions(
selector: Partial<FilterableOrderTransactionProps>,
data: Partial<UpdateOrderTransactionDTO>,
sharedContext?: Context
): Promise<OrderTransactionDTO[]>
updateTransactions(
id: string,
data: Partial<UpdateOrderTransactionDTO>,
sharedContext?: Context
): Promise<OrderTransactionDTO>
deleteTransactions( deleteTransactions(
returnReasonIds: string[], transactionIds: string | object | string[] | object[],
sharedContext?: Context sharedContext?: Context
): Promise<void> ): Promise<void>
softDeleteTransactions<TReturnableLinkableKeys extends string = string>( softDeleteTransactions<TReturnableLinkableKeys extends string = string>(
storeIds: string[], transactionIds: string[],
config?: SoftDeleteReturn<TReturnableLinkableKeys>, config?: SoftDeleteReturn<TReturnableLinkableKeys>,
sharedContext?: Context sharedContext?: Context
): Promise<Record<string, string[]> | void> ): Promise<Record<string, string[]> | void>
restoreTransactions<TReturnableLinkableKeys extends string = string>( restoreTransactions<TReturnableLinkableKeys extends string = string>(
storeIds: string[], transactionIds: string[],
config?: RestoreReturn<TReturnableLinkableKeys>, config?: RestoreReturn<TReturnableLinkableKeys>,
sharedContext?: Context sharedContext?: Context
): Promise<Record<string, string[]> | void> ): Promise<Record<string, string[]> | void>
@@ -14,7 +14,7 @@ export const POST = async (
const { id } = req.params const { id } = req.params
const { errors } = await archiveOrderWorkflow(req.scope).run({ const { errors } = await archiveOrderWorkflow(req.scope).run({
input: { order_ids: [req.validatedBody.order_id] }, input: { orderIds: [req.validatedBody.order_id] },
throwOnError: false, throwOnError: false,
}) })
@@ -14,7 +14,7 @@ export const POST = async (
const { id } = req.params const { id } = req.params
const { errors } = await completeOrderWorkflow(req.scope).run({ const { errors } = await completeOrderWorkflow(req.scope).run({
input: { order_ids: [req.validatedBody.order_id] }, input: { orderIds: [req.validatedBody.order_id] },
throwOnError: false, throwOnError: false,
}) })
@@ -1,19 +0,0 @@
import { remoteQueryObjectFromString } from "@medusajs/utils"
import { MedusaRequest, MedusaResponse } from "../../../../../types/routing"
export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
const remoteQuery = req.scope.resolve("remoteQuery")
const variables = { id: req.params.id }
// TODO: refund payment - v1.x - packages/medusa/src/api/routes/admin/orders/refund-payment.ts
const queryObject = remoteQueryObjectFromString({
entryPoint: "order",
variables,
fields: req.remoteQueryConfig.fields,
})
const [order] = await remoteQuery(queryObject)
res.status(200).json({ order })
}
@@ -12,7 +12,7 @@ export const POST = async (
const variables = { id: req.params.id } const variables = { id: req.params.id }
// TODO: Workflow fulfill items, create fulfillments and adjust inventory - v1.x - packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts // TODO: Workflow fulfill items, create fulfillments - v1.x - packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts
const queryObject = remoteQueryObjectFromString({ const queryObject = remoteQueryObjectFromString({
entryPoint: "order", entryPoint: "order",
@@ -7,14 +7,14 @@ import {
MedusaResponse, MedusaResponse,
} from "../../../../../types/routing" } from "../../../../../types/routing"
export const GET = async ( export const POST = async (
req: AuthenticatedMedusaRequest, req: AuthenticatedMedusaRequest,
res: MedusaResponse res: MedusaResponse
) => { ) => {
const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const queryObject = remoteQueryObjectFromString({ const queryObject = remoteQueryObjectFromString({
entryPoint: "order", entryPoint: "return",
variables: { variables: {
filters: { filters: {
...req.filterableFields, ...req.filterableFields,
@@ -7,18 +7,17 @@ import {
MedusaResponse, MedusaResponse,
} from "../../../../../types/routing" } from "../../../../../types/routing"
export const GET = async ( export const POST = async (
req: AuthenticatedMedusaRequest, req: AuthenticatedMedusaRequest,
res: MedusaResponse res: MedusaResponse
) => { ) => {
const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const queryObject = remoteQueryObjectFromString({ const queryObject = remoteQueryObjectFromString({
entryPoint: "order", entryPoint: "return",
variables: { variables: {
filters: { filters: {
...req.filterableFields, ...req.filterableFields,
is_draft_order: false,
}, },
...req.remoteQueryConfig.pagination, ...req.remoteQueryConfig.pagination,
}, },
@@ -14,7 +14,7 @@ export const GET = async (
const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const queryObject = remoteQueryObjectFromString({ const queryObject = remoteQueryObjectFromString({
entryPoint: "order", entryPoint: "return",
variables: { variables: {
filters: { filters: {
...req.filterableFields, ...req.filterableFields,
@@ -32,7 +32,6 @@ export const StorePostReturnsReqSchema = z.object({
return_shipping: ReturnShippingSchema, return_shipping: ReturnShippingSchema,
note: z.string().optional(), note: z.string().optional(),
receive_now: z.boolean().optional(), receive_now: z.boolean().optional(),
refund_amount: z.number().optional(),
location_id: z.string().optional(), location_id: z.string().optional(),
}) })
export type StorePostReturnsReqSchemaType = z.infer< export type StorePostReturnsReqSchemaType = z.infer<
@@ -196,9 +196,99 @@ moduleIntegrationTestRunner({
const createdOrder = await service.create(input) const createdOrder = await service.create(input)
const serializedOrder = JSON.parse(JSON.stringify(createdOrder)) const serializedOrder = JSON.parse(JSON.stringify(createdOrder))
expect(serializedOrder).toEqual(expectation) expect(serializedOrder).toEqual(expectation)
}) })
it("should create an order, shipping method and items. Including taxes and adjustments associated with them and add new transactions", async function () {
const inpCopy = JSON.parse(JSON.stringify(input))
inpCopy.transactions.push({
amount: 10,
currency_code: "USD",
})
const created = await service.create(inpCopy)
const refund = await service.addTransactions([
{
order_id: created.id,
amount: -20,
currency_code: "USD",
},
])
const serializedOrder = JSON.parse(
JSON.stringify(
await service.retrieve(created.id, {
select: ["id", "summary"],
})
)
)
expect(serializedOrder.summary).toEqual(
expect.objectContaining({
paid_total: 68,
refunded_total: 20,
})
)
await service.softDeleteTransactions(refund[0].id)
const serializedOrder2 = JSON.parse(
JSON.stringify(
await service.retrieve(created.id, {
select: ["id", "summary"],
})
)
)
expect(serializedOrder2.summary).toEqual(
expect.objectContaining({
paid_total: 68,
refunded_total: 0,
})
)
await service.addTransactions([
{
order_id: created.id,
amount: -50,
currency_code: "USD",
},
])
const serializedOrder3 = JSON.parse(
JSON.stringify(
await service.retrieve(created.id, {
select: ["id", "summary"],
})
)
)
expect(serializedOrder3.summary).toEqual(
expect.objectContaining({
paid_total: 68,
refunded_total: 50,
})
)
await service.restoreTransactions(refund[0].id)
const serializedOrder4 = JSON.parse(
JSON.stringify(
await service.retrieve(created.id, {
select: ["id", "summary"],
})
)
)
expect(serializedOrder4.summary).toEqual(
expect.objectContaining({
paid_total: 68,
refunded_total: 70,
})
)
})
it("should transform requested fields and relations to match the db schema and return the order", async function () { it("should transform requested fields and relations to match the db schema and return the order", async function () {
const createdOrder = await service.create(input) const createdOrder = await service.create(input)
const getOrder = await service.retrieve(createdOrder.id, { const getOrder = await service.retrieve(createdOrder.id, {
@@ -445,6 +445,7 @@ export class Migration20240219102530 extends Migration {
CREATE TABLE IF NOT EXISTS "order_transaction" ( CREATE TABLE IF NOT EXISTS "order_transaction" (
"id" TEXT NOT NULL, "id" TEXT NOT NULL,
"order_id" TEXT NOT NULL, "order_id" TEXT NOT NULL,
"version" INTEGER NOT NULL DEFAULT 1,
"amount" NUMERIC NOT NULL, "amount" NUMERIC NOT NULL,
"raw_amount" JSONB NOT NULL, "raw_amount" JSONB NOT NULL,
"currency_code" TEXT NOT NULL, "currency_code" TEXT NOT NULL,
@@ -452,20 +453,25 @@ export class Migration20240219102530 extends Migration {
"reference_id" TEXT NULL, "reference_id" TEXT NULL,
"created_at" TIMESTAMPTZ NOT NULL DEFAULT Now(), "created_at" TIMESTAMPTZ NOT NULL DEFAULT Now(),
"updated_at" TIMESTAMPTZ NOT NULL DEFAULT Now(), "updated_at" TIMESTAMPTZ NOT NULL DEFAULT Now(),
"deleted_at" timestamptz NULL,
CONSTRAINT "order_transaction_pkey" PRIMARY KEY ("id") CONSTRAINT "order_transaction_pkey" PRIMARY KEY ("id")
); );
CREATE INDEX IF NOT EXISTS "IDX_order_transaction_order_id" ON "order_transaction" ( CREATE INDEX IF NOT EXISTS "IDX_order_transaction_order_id_version" ON "order_transaction" (
order_id order_id,
); version
)
WHERE deleted_at IS NOT NULL;
CREATE INDEX IF NOT EXISTS "IDX_order_transaction_currency_code" ON "order_transaction" ( CREATE INDEX IF NOT EXISTS "IDX_order_transaction_currency_code" ON "order_transaction" (
currency_code currency_code
); )
WHERE deleted_at IS NOT NULL;
CREATE INDEX IF NOT EXISTS "IDX_order_transaction_reference_id" ON "order_transaction" ( CREATE INDEX IF NOT EXISTS "IDX_order_transaction_reference_id" ON "order_transaction" (
reference_id reference_id
); )
WHERE deleted_at IS NOT NULL;
CREATE TABLE IF NOT EXISTS "return_reason" CREATE TABLE IF NOT EXISTS "return_reason"
( (
@@ -36,6 +36,9 @@ type OrderSummaryTotals = {
balance: BigNumber balance: BigNumber
future_balance: BigNumber future_balance: BigNumber
paid_total: BigNumber
refunded_total: BigNumber
} }
const OrderIdVersionIndex = createPsqlIndexStatementHelper({ const OrderIdVersionIndex = createPsqlIndexStatementHelper({
@@ -33,7 +33,20 @@ const CurrencyCodeIndex = createPsqlIndexStatementHelper({
columns: "currency_code", columns: "currency_code",
}) })
const DeletedAtIndex = createPsqlIndexStatementHelper({
tableName: "order_transaction",
columns: "deleted_at",
where: "deleted_at IS NOT NULL",
})
const OrderIdVersionIndex = createPsqlIndexStatementHelper({
tableName: "order_transaction",
columns: ["order_id", "version"],
where: "deleted_at IS NOT NULL",
})
@Entity({ tableName: "order_transaction" }) @Entity({ tableName: "order_transaction" })
@OrderIdVersionIndex.MikroORMIndex()
export default class Transaction { export default class Transaction {
[OptionalProps]?: OptionalLineItemProps [OptionalProps]?: OptionalLineItemProps
@@ -55,6 +68,12 @@ export default class Transaction {
}) })
order: Order order: Order
@Property({
columnType: "integer",
defaultRaw: "1",
})
version: number = 1
@MikroOrmBigNumberProperty() @MikroOrmBigNumberProperty()
amount: BigNumber | number amount: BigNumber | number
@@ -93,6 +112,10 @@ export default class Transaction {
}) })
updated_at: Date updated_at: Date
@Property({ columnType: "timestamptz", nullable: true })
@DeletedAtIndex.MikroORMIndex()
deleted_at: Date | null = null
@BeforeCreate() @BeforeCreate()
onCreate() { onCreate() {
this.id = generateEntityId(this.id, "ordtrx") this.id = generateEntityId(this.id, "ordtrx")
@@ -104,6 +104,8 @@ describe("Order Exchange - Actions", function () {
future_temporary_difference: 0, future_temporary_difference: 0,
pending_difference: 312.5, pending_difference: 312.5,
difference_sum: 42.5, difference_sum: 42.5,
paid_total: 0,
refunded_total: 0,
}) })
const toJson = JSON.parse(JSON.stringify(changes.order.items)) const toJson = JSON.parse(JSON.stringify(changes.order.items))
@@ -1,4 +1,5 @@
import { import {
BigNumberInput,
Context, Context,
CreateOrderChangeActionDTO, CreateOrderChangeActionDTO,
DAL, DAL,
@@ -9,11 +10,13 @@ import {
ModulesSdkTypes, ModulesSdkTypes,
OrderDTO, OrderDTO,
OrderTypes, OrderTypes,
RestoreReturn,
SoftDeleteReturn,
UpdateOrderItemWithSelectorDTO, UpdateOrderItemWithSelectorDTO,
UpdateOrderReturnReasonDTO, UpdateOrderReturnReasonDTO,
UpdateOrderTransactionDTO,
} from "@medusajs/types" } from "@medusajs/types"
import { import {
BigNumber,
createRawPropertiesFromBigNumber, createRawPropertiesFromBigNumber,
decorateCartTotals, decorateCartTotals,
deduplicate, deduplicate,
@@ -22,12 +25,14 @@ import {
InjectTransactionManager, InjectTransactionManager,
isObject, isObject,
isString, isString,
MathBN,
MedusaContext, MedusaContext,
MedusaError, MedusaError,
ModulesSdkUtils, ModulesSdkUtils,
OrderChangeStatus, OrderChangeStatus,
OrderStatus, OrderStatus,
promiseAll, promiseAll,
transformPropertiesToBigNumber,
} from "@medusajs/utils" } from "@medusajs/utils"
import { import {
Address, Address,
@@ -129,13 +134,13 @@ export default class OrderModuleService<
dto: OrderTypes.OrderShippingMethodAdjustmentDTO dto: OrderTypes.OrderShippingMethodAdjustmentDTO
} }
ShippingMethodTaxLine: { dto: OrderTypes.OrderShippingMethodTaxLineDTO } ShippingMethodTaxLine: { dto: OrderTypes.OrderShippingMethodTaxLineDTO }
Transaction: { dto: OrderTypes.OrderTransactionDTO }
OrderChange: { dto: OrderTypes.OrderChangeDTO } OrderChange: { dto: OrderTypes.OrderChangeDTO }
OrderChangeAction: { dto: OrderTypes.OrderChangeActionDTO } OrderChangeAction: { dto: OrderTypes.OrderChangeActionDTO }
OrderItem: { dto: OrderTypes.OrderItemDTO } OrderItem: { dto: OrderTypes.OrderItemDTO }
OrderSummary: { dto: OrderTypes.OrderSummaryDTO }
OrderShippingMethod: { dto: OrderShippingMethod } OrderShippingMethod: { dto: OrderShippingMethod }
ReturnReason: { dto: OrderTypes.OrderReturnReasonDTO } ReturnReason: { dto: OrderTypes.OrderReturnReasonDTO }
OrderSummary: { dto: OrderTypes.OrderSummaryDTO }
Transaction: { dto: OrderTypes.OrderTransactionDTO }
} }
>(Order, generateMethodForModels, entityNameToLinkableKeysMap) >(Order, generateMethodForModels, entityNameToLinkableKeysMap)
implements IOrderModuleService implements IOrderModuleService
@@ -2273,18 +2278,18 @@ export default class OrderModuleService<
await this.confirmOrderChange(change[0].id, sharedContext) await this.confirmOrderChange(change[0].id, sharedContext)
} }
public async addTransactions( async addTransactions(
transactionData: OrderTypes.CreateOrderTransactionDTO, transactionData: OrderTypes.CreateOrderTransactionDTO,
sharedContext?: Context sharedContext?: Context
): Promise<OrderTypes.OrderTransactionDTO> ): Promise<OrderTypes.OrderTransactionDTO>
public async addTransactions( async addTransactions(
transactionData: OrderTypes.CreateOrderTransactionDTO[], transactionData: OrderTypes.CreateOrderTransactionDTO[],
sharedContext?: Context sharedContext?: Context
): Promise<OrderTypes.OrderTransactionDTO[]> ): Promise<OrderTypes.OrderTransactionDTO[]>
@InjectTransactionManager("baseRepository_") @InjectManager("baseRepository_")
public async addTransactions( async addTransactions(
transactionData: transactionData:
| OrderTypes.CreateOrderTransactionDTO | OrderTypes.CreateOrderTransactionDTO
| OrderTypes.CreateOrderTransactionDTO[], | OrderTypes.CreateOrderTransactionDTO[],
@@ -2292,12 +2297,33 @@ export default class OrderModuleService<
): Promise< ): Promise<
OrderTypes.OrderTransactionDTO | OrderTypes.OrderTransactionDTO[] OrderTypes.OrderTransactionDTO | OrderTypes.OrderTransactionDTO[]
> { > {
const orders = await this.orderService_.list(
{
id: Array.isArray(transactionData)
? transactionData.map((t) => t.order_id)
: transactionData.order_id,
},
{
select: ["id", "version"],
},
sharedContext
)
const data = Array.isArray(transactionData) const data = Array.isArray(transactionData)
? transactionData ? transactionData
: [transactionData] : [transactionData]
for (const order of orders) {
const trxs = data.filter((t) => t.order_id === order.id)
for (const trx of trxs) {
;(trx as any).version = order.version
}
}
const created = await this.transactionService_.create(data, sharedContext) const created = await this.transactionService_.create(data, sharedContext)
await this.updateOrderPaidRefundableAmount_(created, false, sharedContext)
return await this.baseRepository_.serialize<OrderTypes.OrderTransactionDTO>( return await this.baseRepository_.serialize<OrderTypes.OrderTransactionDTO>(
!Array.isArray(transactionData) ? created[0] : created, !Array.isArray(transactionData) ? created[0] : created,
{ {
@@ -2306,120 +2332,158 @@ export default class OrderModuleService<
) )
} }
updateTransactions(
data: OrderTypes.UpdateOrderTransactionWithSelectorDTO[]
): Promise<OrderTypes.OrderTransactionDTO[]>
updateTransactions(
selector: Partial<OrderTypes.FilterableOrderTransactionProps>,
data: OrderTypes.UpdateOrderTransactionDTO,
sharedContext?: Context
): Promise<OrderTypes.OrderTransactionDTO[]>
updateTransactions(
id: string,
data: Partial<OrderTypes.UpdateOrderTransactionDTO>,
sharedContext?: Context
): Promise<OrderTypes.OrderTransactionDTO>
@InjectManager("baseRepository_") @InjectManager("baseRepository_")
async updateTransactions( // @ts-ignore
idOrDataOrSelector: async deleteTransactions(
| string transactionIds: string | object | string[] | object[],
| OrderTypes.UpdateOrderTransactionWithSelectorDTO[] sharedContext?: Context
| Partial<OrderTypes.FilterableOrderTransactionProps>, ): Promise<void> {
data?: const data = Array.isArray(transactionIds)
| OrderTypes.UpdateOrderTransactionDTO ? transactionIds
| Partial<OrderTypes.UpdateOrderTransactionDTO>, : [transactionIds]
@MedusaContext() sharedContext: Context = {}
): Promise<
OrderTypes.OrderTransactionDTO[] | OrderTypes.OrderTransactionDTO
> {
let trxs: Transaction[] = []
if (isString(idOrDataOrSelector)) {
const trx = await this.updateTransaction_(
idOrDataOrSelector,
data as Partial<OrderTypes.UpdateOrderTransactionDTO>,
sharedContext
)
return await this.baseRepository_.serialize<OrderTypes.OrderTransactionDTO>( const transactions = await super.listTransactions(
trx, {
{ id: data,
populate: true, },
} {
) select: ["order_id", "version", "amount"],
} },
const toUpdate = Array.isArray(idOrDataOrSelector)
? idOrDataOrSelector
: [
{
selector: idOrDataOrSelector,
data: data,
} as OrderTypes.UpdateOrderTransactionWithSelectorDTO,
]
trxs = await this.updateTransactionsWithSelector_(toUpdate, sharedContext)
return await this.baseRepository_.serialize<
OrderTypes.OrderTransactionDTO[]
>(trxs, {
populate: true,
})
}
@InjectTransactionManager("baseRepository_")
protected async updateTransaction_(
trxId: string,
data: Partial<OrderTypes.UpdateOrderTransactionDTO>,
@MedusaContext() sharedContext: Context = {}
): Promise<Transaction> {
const [trx] = await this.transactionService_.update(
[{ id: trxId, ...data }],
sharedContext sharedContext
) )
return trx await this.transactionService_.delete(data, sharedContext)
await this.updateOrderPaidRefundableAmount_(
transactions,
true,
sharedContext
)
}
@InjectManager("baseRepository_")
// @ts-ignore
async softDeleteTransactions<TReturnableLinkableKeys extends string>(
transactionIds: string | object | string[] | object[],
config?: SoftDeleteReturn<TReturnableLinkableKeys>,
sharedContext?: Context
): Promise<Record<string, string[]> | void> {
const transactions = await super.listTransactions(
{
id: transactionIds,
},
{
select: ["order_id", "amount"],
},
sharedContext
)
const returned = await super.softDeleteTransactions(
transactionIds,
config,
sharedContext
)
await this.updateOrderPaidRefundableAmount_(
transactions,
true,
sharedContext
)
return returned
}
@InjectManager("baseRepository_")
// @ts-ignore
async restoreTransactions<TReturnableLinkableKeys extends string>(
transactionIds: string | object | string[] | object[],
config?: RestoreReturn<TReturnableLinkableKeys>,
sharedContext?: Context
): Promise<Record<string, string[]> | void> {
const transactions = await super.listTransactions(
{
id: transactionIds,
},
{
select: ["order_id", "amount"],
withDeleted: true,
},
sharedContext
)
const returned = await super.restoreTransactions(
transactionIds as string[],
config,
sharedContext
)
await this.updateOrderPaidRefundableAmount_(
transactions,
false,
sharedContext
)
return returned
} }
@InjectTransactionManager("baseRepository_") @InjectTransactionManager("baseRepository_")
protected async updateTransactionsWithSelector_( private async updateOrderPaidRefundableAmount_(
updates: OrderTypes.UpdateOrderTransactionWithSelectorDTO[], transactionData: {
@MedusaContext() sharedContext: Context = {} order_id: string
): Promise<Transaction[]> { amount: BigNumber | number | BigNumberInput
let toUpdate: UpdateOrderTransactionDTO[] = [] }[],
isRemoved: boolean,
sharedContext?: Context
) {
const summaries: any = await super.listOrderSummaries(
{
order_id: transactionData.map((trx) => trx.order_id),
},
{},
sharedContext
)
for (const { selector, data } of updates) { summaries.forEach((summary) => {
const trxs = await super.listTransactions( let trxs = transactionData.filter(
{ ...selector }, (trx) => trx.order_id === summary.order_id
{},
sharedContext
) )
trxs.forEach((trx) => { if (!trxs.length) {
toUpdate.push({ return
...data, }
id: trx.id, transformPropertiesToBigNumber(trxs)
})
})
}
return await this.transactionService_.update(toUpdate, sharedContext) const op = isRemoved ? MathBN.sub : MathBN.add
for (const trx of trxs) {
if (MathBN.gt(trx.amount, 0)) {
summary.totals.paid_total = new BigNumber(
op(summary.totals.paid_total, trx.amount)
)
} else {
summary.totals.refunded_total = new BigNumber(
op(summary.totals.refunded_total, MathBN.abs(trx.amount))
)
}
}
})
createRawPropertiesFromBigNumber(summaries)
await this.orderSummaryService_.update(summaries, sharedContext)
} }
public async createReturnReasons( async createReturnReasons(
transactionData: OrderTypes.CreateOrderReturnReasonDTO, transactionData: OrderTypes.CreateOrderReturnReasonDTO,
sharedContext?: Context sharedContext?: Context
): Promise<OrderTypes.OrderReturnReasonDTO> ): Promise<OrderTypes.OrderReturnReasonDTO>
public async createReturnReasons( async createReturnReasons(
transactionData: OrderTypes.CreateOrderReturnReasonDTO[], transactionData: OrderTypes.CreateOrderReturnReasonDTO[],
sharedContext?: Context sharedContext?: Context
): Promise<OrderTypes.OrderReturnReasonDTO[]> ): Promise<OrderTypes.OrderReturnReasonDTO[]>
@InjectTransactionManager("baseRepository_") @InjectTransactionManager("baseRepository_")
public async createReturnReasons( async createReturnReasons(
returnReasonData: returnReasonData:
| OrderTypes.CreateOrderReturnReasonDTO | OrderTypes.CreateOrderReturnReasonDTO
| OrderTypes.CreateOrderReturnReasonDTO[], | OrderTypes.CreateOrderReturnReasonDTO[],
@@ -2547,7 +2611,7 @@ export default class OrderModuleService<
} }
@InjectTransactionManager("baseRepository_") @InjectTransactionManager("baseRepository_")
public async receiveReturn( async receiveReturn(
data: OrderTypes.ReceiveOrderReturnDTO, data: OrderTypes.ReceiveOrderReturnDTO,
sharedContext?: Context sharedContext?: Context
): Promise<void> { ): Promise<void> {
@@ -2622,7 +2686,9 @@ export default class OrderModuleService<
if (notAllowed.length) { if (notAllowed.length) {
throw new MedusaError( throw new MedusaError(
MedusaError.Types.INVALID_DATA, MedusaError.Types.INVALID_DATA,
`Pending Order cannot be archived: ${notAllowed.join(", ")}.` `Orders ${notAllowed.join(
", "
)} are completed, canceled, or in draft and cannot be archived`
) )
} }
@@ -2672,7 +2738,7 @@ export default class OrderModuleService<
if (notAllowed.length) { if (notAllowed.length) {
throw new MedusaError( throw new MedusaError(
MedusaError.Types.INVALID_DATA, MedusaError.Types.INVALID_DATA,
`Canceled Order cannot be completed: ${notAllowed.join(", ")}.` `Orders ${notAllowed.join(", ")} are canceled and cannot be completed`
) )
} }
@@ -44,6 +44,8 @@ export interface OrderSummaryCalculated {
future_temporary_difference: BigNumberInput future_temporary_difference: BigNumberInput
temporary_difference: BigNumberInput temporary_difference: BigNumberInput
difference_sum: BigNumberInput difference_sum: BigNumberInput
paid_total: BigNumberInput
refunded_total: BigNumberInput
} }
export interface OrderTransaction { export interface OrderTransaction {
@@ -51,7 +51,18 @@ export class OrderChangeProcessing {
this.transactions = JSON.parse(JSON.stringify(transactions ?? [])) this.transactions = JSON.parse(JSON.stringify(transactions ?? []))
this.actions = JSON.parse(JSON.stringify(actions ?? [])) this.actions = JSON.parse(JSON.stringify(actions ?? []))
const transactionTotal = MathBN.add(...transactions.map((tr) => tr.amount)) let paid = MathBN.convert(0)
let refunded = MathBN.convert(0)
let transactionTotal = MathBN.convert(0)
for (const tr of transactions) {
if (MathBN.lt(tr.amount, 0)) {
refunded = MathBN.add(refunded, MathBN.abs(tr.amount))
} else {
paid = MathBN.add(paid, tr.amount)
}
transactionTotal = MathBN.add(transactionTotal, tr.amount)
}
transformPropertiesToBigNumber(this.order.metadata) transformPropertiesToBigNumber(this.order.metadata)
@@ -65,6 +76,8 @@ export class OrderChangeProcessing {
current_order_total: this.order.total ?? 0, current_order_total: this.order.total ?? 0,
original_order_total: this.order.total ?? 0, original_order_total: this.order.total ?? 0,
transaction_total: transactionTotal, transaction_total: transactionTotal,
paid_total: paid,
refunded_total: refunded,
} }
} }
@@ -358,6 +371,8 @@ export class OrderChangeProcessing {
), ),
pending_difference: new BigNumber(summary.pending_difference), pending_difference: new BigNumber(summary.pending_difference),
difference_sum: new BigNumber(summary.difference_sum), difference_sum: new BigNumber(summary.difference_sum),
paid_total: new BigNumber(summary.paid_total),
refunded_total: new BigNumber(summary.refunded_total),
} as unknown as OrderSummaryDTO } as unknown as OrderSummaryDTO
return orderSummary return orderSummary