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

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
packages/modules/order/src/migrations/Migration20240219102530.ts
+11 -5
View File
@@ -445,6 +445,7 @@ export class Migration20240219102530 extends Migration {
CREATE TABLE IF NOT EXISTS "order_transaction" (
"id" TEXT NOT NULL,
"order_id" TEXT NOT NULL,
"version" INTEGER NOT NULL DEFAULT 1,
"amount" NUMERIC NOT NULL,
"raw_amount" JSONB NOT NULL,
"currency_code" TEXT NOT NULL,
@@ -452,20 +453,25 @@ export class Migration20240219102530 extends Migration {
"reference_id" TEXT NULL,
"created_at" TIMESTAMPTZ NOT NULL DEFAULT Now(),
"updated_at" TIMESTAMPTZ NOT NULL DEFAULT Now(),
"deleted_at" timestamptz NULL,
CONSTRAINT "order_transaction_pkey" PRIMARY KEY ("id")
);
CREATE INDEX IF NOT EXISTS "IDX_order_transaction_order_id" ON "order_transaction" (
order_id
);
CREATE INDEX IF NOT EXISTS "IDX_order_transaction_order_id_version" ON "order_transaction" (
order_id,
version
)
WHERE deleted_at IS NOT NULL;
CREATE INDEX IF NOT EXISTS "IDX_order_transaction_currency_code" ON "order_transaction" (
currency_code
);
)
WHERE deleted_at IS NOT NULL;
CREATE INDEX IF NOT EXISTS "IDX_order_transaction_reference_id" ON "order_transaction" (
reference_id
);
)
WHERE deleted_at IS NOT NULL;
CREATE TABLE IF NOT EXISTS "return_reason"
(
packages/modules/order/src/models/order-summary.ts
+3
View File
@@ -36,6 +36,9 @@ type OrderSummaryTotals = {
balance: BigNumber
future_balance: BigNumber
paid_total: BigNumber
refunded_total: BigNumber
}
const OrderIdVersionIndex = createPsqlIndexStatementHelper({
packages/modules/order/src/models/transaction.ts
+23
View File
@@ -33,7 +33,20 @@ const CurrencyCodeIndex = createPsqlIndexStatementHelper({
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" })
@OrderIdVersionIndex.MikroORMIndex()
export default class Transaction {
[OptionalProps]?: OptionalLineItemProps
@@ -55,6 +68,12 @@ export default class Transaction {
})
order: Order
@Property({
columnType: "integer",
defaultRaw: "1",
})
version: number = 1
@MikroOrmBigNumberProperty()
amount: BigNumber | number
@@ -93,6 +112,10 @@ export default class Transaction {
})
updated_at: Date
@Property({ columnType: "timestamptz", nullable: true })
@DeletedAtIndex.MikroORMIndex()
deleted_at: Date | null = null
@BeforeCreate()
onCreate() {
this.id = generateEntityId(this.id, "ordtrx")
packages/modules/order/src/services/__tests__/util/actions/exchanges.ts
+2
View File
@@ -104,6 +104,8 @@ describe("Order Exchange - Actions", function () {
future_temporary_difference: 0,
pending_difference: 312.5,
difference_sum: 42.5,
paid_total: 0,
refunded_total: 0,
})
const toJson = JSON.parse(JSON.stringify(changes.order.items))
packages/modules/order/src/services/order-module-service.ts
+167 -101
View File
@@ -1,4 +1,5 @@
import {
BigNumberInput,
Context,
CreateOrderChangeActionDTO,
DAL,
@@ -9,11 +10,13 @@ import {
ModulesSdkTypes,
OrderDTO,
OrderTypes,
RestoreReturn,
SoftDeleteReturn,
UpdateOrderItemWithSelectorDTO,
UpdateOrderReturnReasonDTO,
UpdateOrderTransactionDTO,
} from "@medusajs/types"
import {
BigNumber,
createRawPropertiesFromBigNumber,
decorateCartTotals,
deduplicate,
@@ -22,12 +25,14 @@ import {
InjectTransactionManager,
isObject,
isString,
MathBN,
MedusaContext,
MedusaError,
ModulesSdkUtils,
OrderChangeStatus,
OrderStatus,
promiseAll,
transformPropertiesToBigNumber,
} from "@medusajs/utils"
import {
Address,
@@ -129,13 +134,13 @@ export default class OrderModuleService<
dto: OrderTypes.OrderShippingMethodAdjustmentDTO
}
ShippingMethodTaxLine: { dto: OrderTypes.OrderShippingMethodTaxLineDTO }
Transaction: { dto: OrderTypes.OrderTransactionDTO }
OrderChange: { dto: OrderTypes.OrderChangeDTO }
OrderChangeAction: { dto: OrderTypes.OrderChangeActionDTO }
OrderItem: { dto: OrderTypes.OrderItemDTO }
OrderSummary: { dto: OrderTypes.OrderSummaryDTO }
OrderShippingMethod: { dto: OrderShippingMethod }
ReturnReason: { dto: OrderTypes.OrderReturnReasonDTO }
OrderSummary: { dto: OrderTypes.OrderSummaryDTO }
Transaction: { dto: OrderTypes.OrderTransactionDTO }
}
>(Order, generateMethodForModels, entityNameToLinkableKeysMap)
implements IOrderModuleService
@@ -2273,18 +2278,18 @@ export default class OrderModuleService<
await this.confirmOrderChange(change[0].id, sharedContext)
}
public async addTransactions(
async addTransactions(
transactionData: OrderTypes.CreateOrderTransactionDTO,
sharedContext?: Context
): Promise<OrderTypes.OrderTransactionDTO>
public async addTransactions(
async addTransactions(
transactionData: OrderTypes.CreateOrderTransactionDTO[],
sharedContext?: Context
): Promise<OrderTypes.OrderTransactionDTO[]>
@InjectTransactionManager("baseRepository_")
public async addTransactions(
@InjectManager("baseRepository_")
async addTransactions(
transactionData:
| OrderTypes.CreateOrderTransactionDTO
| OrderTypes.CreateOrderTransactionDTO[],
@@ -2292,12 +2297,33 @@ export default class OrderModuleService<
): Promise<
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)
? 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)
await this.updateOrderPaidRefundableAmount_(created, false, sharedContext)
return await this.baseRepository_.serialize<OrderTypes.OrderTransactionDTO>(
!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_")
async updateTransactions(
idOrDataOrSelector:
| string
| OrderTypes.UpdateOrderTransactionWithSelectorDTO[]
| Partial<OrderTypes.FilterableOrderTransactionProps>,
data?:
| OrderTypes.UpdateOrderTransactionDTO
| Partial<OrderTypes.UpdateOrderTransactionDTO>,
@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
)
// @ts-ignore
async deleteTransactions(
transactionIds: string | object | string[] | object[],
sharedContext?: Context
): Promise<void> {
const data = Array.isArray(transactionIds)
? transactionIds
: [transactionIds]
return await this.baseRepository_.serialize<OrderTypes.OrderTransactionDTO>(
trx,
{
populate: true,
}
)
}
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 }],
const transactions = await super.listTransactions(
{
id: data,
},
{
select: ["order_id", "version", "amount"],
},
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_")
protected async updateTransactionsWithSelector_(
updates: OrderTypes.UpdateOrderTransactionWithSelectorDTO[],
@MedusaContext() sharedContext: Context = {}
): Promise<Transaction[]> {
let toUpdate: UpdateOrderTransactionDTO[] = []
private async updateOrderPaidRefundableAmount_(
transactionData: {
order_id: string
amount: BigNumber | number | BigNumberInput
}[],
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) {
const trxs = await super.listTransactions(
{ ...selector },
{},
sharedContext
summaries.forEach((summary) => {
let trxs = transactionData.filter(
(trx) => trx.order_id === summary.order_id
)
trxs.forEach((trx) => {
toUpdate.push({
...data,
id: trx.id,
})
})
}
if (!trxs.length) {
return
}
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,
sharedContext?: Context
): Promise<OrderTypes.OrderReturnReasonDTO>
public async createReturnReasons(
async createReturnReasons(
transactionData: OrderTypes.CreateOrderReturnReasonDTO[],
sharedContext?: Context
): Promise<OrderTypes.OrderReturnReasonDTO[]>
@InjectTransactionManager("baseRepository_")
public async createReturnReasons(
async createReturnReasons(
returnReasonData:
| OrderTypes.CreateOrderReturnReasonDTO
| OrderTypes.CreateOrderReturnReasonDTO[],
@@ -2547,7 +2611,7 @@ export default class OrderModuleService<
}
@InjectTransactionManager("baseRepository_")
public async receiveReturn(
async receiveReturn(
data: OrderTypes.ReceiveOrderReturnDTO,
sharedContext?: Context
): Promise<void> {
@@ -2622,7 +2686,9 @@ export default class OrderModuleService<
if (notAllowed.length) {
throw new MedusaError(
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) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`Canceled Order cannot be completed: ${notAllowed.join(", ")}.`
`Orders ${notAllowed.join(", ")} are canceled and cannot be completed`
)
}
packages/modules/order/src/types/utils/index.ts
+2
View File
@@ -44,6 +44,8 @@ export interface OrderSummaryCalculated {
future_temporary_difference: BigNumberInput
temporary_difference: BigNumberInput
difference_sum: BigNumberInput
paid_total: BigNumberInput
refunded_total: BigNumberInput
}
export interface OrderTransaction {
packages/modules/order/src/utils/calculate-order-change.ts
+16 -1
View File
@@ -51,7 +51,18 @@ export class OrderChangeProcessing {
this.transactions = JSON.parse(JSON.stringify(transactions ?? []))
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)
@@ -65,6 +76,8 @@ export class OrderChangeProcessing {
current_order_total: this.order.total ?? 0,
original_order_total: this.order.total ?? 0,
transaction_total: transactionTotal,
paid_total: paid,
refunded_total: refunded,
}
}
@@ -358,6 +371,8 @@ export class OrderChangeProcessing {
),
pending_difference: new BigNumber(summary.pending_difference),
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
return orderSummary