@porulle/adapter-woocommerce 0.75.0 → 0.77.0

package/dist/index.js

@@ -4,7 +4,7 @@ import { catalogItems, importPage, storeProfile } from "./catalog.js";
 import { pushCatalog, pushCaches } from "./catalog-push.js";
 import { discoverStore, normalizeStoreDomain, probeStore, refusedStoreUrl, wooClient, wooCredentialsSchema } from "./client.js";
 import { inventoryFor, inventoryPage } from "./inventory.js";
-import { cancelOrder, orderStatus, pushOrder } from "./orders.js";
+import { cancelOrder, orderStatus, pushOrder, recordRefund } from "./orders.js";
 import { decodeDelivery, orderEvents, registerWebhooks, unregisterWebhooks, verifyDelivery, webhookHealth, WOO_WEBHOOK_TOPICS } from "./webhooks.js";
 export { normalizeStoreDomain, probeStore, refusedStoreUrl, WOO_BLOCKED_BY_FIREWALL } from "./client.js";
 export { ORDER_META_KEY } from "./orders.js";
@@ -157,6 +157,9 @@ export function wooConnector(options = {}) {
         async cancelOrder(store, remoteId, input) {
             return withClient(store, (client) => cancelOrder(client, remoteId, input));
         },
+        async recordRefund(store, remoteId, input) {
+            return withClient(store, (client) => recordRefund(client, remoteId, input));
+        },
         async pushCatalog(store, items, opts) {
             return withClient(store, (client) => pushCatalog(client, store, items, opts, caches));
         },

package/dist/orders.d.ts

@@ -1,4 +1,4 @@
-import type { ChannelCancelOrderInput, ChannelConnectorError, ChannelOrderSlice, ChannelOrderStatus, ChannelPushOrderResult, Result } from "@porulle/core";
+import type { ChannelCancelOrderInput, ChannelConnectorError, ChannelRefundRecord, ChannelOrderSlice, ChannelOrderStatus, ChannelPushOrderResult, Result } from "@porulle/core";
 import { z } from "zod";
 import type { WooClient } from "./client.js";
 export declare const wooOrderSchema: z.ZodObject<{
@@ -18,6 +18,10 @@ export declare const wooOrderSchema: z.ZodObject<{
         quantity: z.ZodNumber;
         total: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>>>;
+    shipping_lines: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<string, string | number>>;
+        total: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>>;
     refunds: z.ZodDefault<z.ZodArray<z.ZodObject<{
         id: z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<string, string | number>>;
         total: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -48,4 +52,11 @@ export declare function pushOrder(client: WooClient, slice: ChannelOrderSlice, o
  * completed or refunded one is the merchant's (shipped) and is refused, never moved backwards.
  */
 export declare function cancelOrder(client: WooClient, remoteId: string, input: ChannelCancelOrderInput): Promise<Result<void, ChannelConnectorError>>;
+/**
+ * Books at the store a refund the marketplace already paid the shopper: `api_refund: false` moves no
+ * money, `api_restock` puts the stock back, and each line is the store's own order line for the variant.
+ */
+export declare function recordRefund(client: WooClient, remoteId: string, input: ChannelRefundRecord): Promise<Result<{
+    remoteRefundId: string;
+}, ChannelConnectorError>>;
 export declare function orderStatus(client: WooClient, remoteId: string): Promise<Result<ChannelOrderStatus, ChannelConnectorError>>;

package/dist/orders.js

@@ -10,6 +10,7 @@ export const wooOrderSchema = z.object({
     date_created_gmt: z.string().nullish(),
     meta_data: z.array(z.object({ key: z.string(), value: z.unknown() })).default([]),
     line_items: z.array(z.object({ id, product_id: id, variation_id: id, quantity: z.number(), total: z.string().nullish() })).default([]),
+    shipping_lines: z.array(z.object({ id, total: z.string().nullish() })).default([]),
     refunds: z.array(z.object({ id, total: z.string().nullish() })).default([]),
 });
 /** The meta key naming the marketplace order a store order was created for: how a retry finds it. */
@@ -97,7 +98,12 @@ export async function pushOrder(client, slice, options) {
     }
     const currency = slice.currency;
     const decimals = client.credentials.priceDecimals;
-    const discounts = allocate(slice.lines.map((line) => line.totalPrice), slice.discount?.amount ?? 0);
+    // The platform's own per-line discount when it sends one, so the store's line totals are what the
+    // platform refunds a line at; otherwise the slice's discount split here.
+    const shares = slice.lines.map((line) => line.discountAmount ?? 0);
+    const discounts = slice.discount !== undefined && shares.reduce((sum, share) => sum + share, 0) === slice.discount.amount
+        ? shares
+        : allocate(slice.lines.map((line) => line.totalPrice), slice.discount?.amount ?? 0);
     const [firstName = "", ...rest] = slice.customer.name.trim().split(/\s+/);
     const source = slice.customer.shippingAddress;
     const address = {
@@ -184,6 +190,45 @@ export async function cancelOrder(client, remoteId, input) {
     const cancelled = await cancel(client, remoteId, `Runvae: cancelled (${input.reason})${input.staffNote ? `: ${input.staffNote}` : ""}.`);
     return cancelled.ok ? Ok(undefined) : cancelled;
 }
+/**
+ * Books at the store a refund the marketplace already paid the shopper: `api_refund: false` moves no
+ * money, `api_restock` puts the stock back, and each line is the store's own order line for the variant.
+ */
+export async function recordRefund(client, remoteId, input) {
+    const read = await client.get(`/wc/v3/orders/${encodeURIComponent(remoteId)}`, wooOrderSchema);
+    if (!read.ok)
+        return read;
+    const order = read.value.data;
+    const currency = order.currency ?? client.credentials.currency;
+    if (!currency)
+        return Err({ code: "WOO_CURRENCY_UNKNOWN", message: `Order ${remoteId} names no currency.`, retriable: false });
+    const decimals = client.credentials.priceDecimals;
+    const lineItems = [];
+    for (const line of input.lines) {
+        const storeLine = order.line_items.find((candidate) => (candidate.variation_id !== "0" ? candidate.variation_id : candidate.product_id) === line.externalVariantId);
+        if (!storeLine)
+            return Err({ code: "CHANNEL_MAPPING_MISSING", message: `Order ${remoteId} has no line for ${line.externalVariantId}.`, retriable: false });
+        lineItems.push({ id: storeLine.id, quantity: line.quantity, refund_total: moneyString(line.amount, currency, decimals) });
+    }
+    // Delivery is refunded against the order's shipping item, as wp-admin does it.
+    const shippingAmount = input.shippingAmount ?? 0;
+    if (shippingAmount > 0) {
+        const shippingLine = order.shipping_lines[0];
+        if (!shippingLine)
+            return Err({ code: "CHANNEL_MAPPING_MISSING", message: `Order ${remoteId} has no delivery line to refund.`, retriable: false });
+        lineItems.push({ id: shippingLine.id, quantity: 0, refund_total: moneyString(shippingAmount, currency, decimals) });
+    }
+    const created = await client.send("POST", `/wc/v3/orders/${encodeURIComponent(remoteId)}/refunds`, {
+        amount: moneyString(input.amount, currency, decimals),
+        reason: input.reason,
+        api_refund: false,
+        api_restock: input.restock,
+        line_items: lineItems,
+    }, z.object({ id: z.union([z.number(), z.string()]).transform(String) }));
+    if (!created.ok)
+        return Err({ code: created.error.code, message: `The store would not record the refund: ${created.error.message}`, retriable: created.error.retriable === true });
+    return Ok({ remoteRefundId: created.value.id });
+}
 export async function orderStatus(client, remoteId) {
     const read = await client.get(`/wc/v3/orders/${encodeURIComponent(remoteId)}`, wooOrderSchema);
     if (!read.ok)