@reactionary/core 0.12.3 → 0.12.4

package/analytics/index.js

@@ -2,5 +2,6 @@ export * from "./context.js";
 export * from "./dispatcher.js";
 export * from "./legacy-adapter.js";
 export * from "./origins.js";
+export * from "./placed-order.js";
 export * from "./recording-subscriber.js";
 export * from "./refs.js";

package/analytics/placed-order.js

@@ -0,0 +1,15 @@
+function summarizePlacedOrder(payload) {
+  const { checkout, order } = payload;
+  const source = checkout ?? order;
+  if (!source) {
+    return void 0;
+  }
+  return {
+    transactionId: order?.identifier.key ?? checkout?.resultingOrder?.key ?? source.identifier.key,
+    items: source.items,
+    price: source.price
+  };
+}
+export {
+  summarizePlacedOrder
+};

package/capabilities/analytics.capability.js

@@ -50,6 +50,7 @@ import {
   AnalyticsMutationProductSharedSchema,
   AnalyticsMutationCustomSchema
 } from "../schemas/index.js";
+import { error } from "../schemas/result.js";
 import { BaseCapability } from "./base.capability.js";
 class AnalyticsCapability extends BaseCapability {
   dispatcher;
@@ -126,6 +127,9 @@ class AnalyticsCapability extends BaseCapability {
     return this.dispatcher.emit("payment-info-added", payload);
   }
   async orderPlaced(payload) {
+    if (!payload.checkout && !payload.order) {
+      return error({ type: "Generic", message: "orderPlaced needs a checkout (or the deprecated order)" });
+    }
     return this.dispatcher.emit("order-placed", payload);
   }
   async quoteRequested(payload) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/core",
-  "version": "0.12.3",
+  "version": "0.12.4",
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts",

package/schemas/mutations/analytics/events/commerce.mutation.js

@@ -1,6 +1,7 @@
 import * as z from "zod";
 import { AnalyticsCouponRejectionReasonSchema, AnalyticsStoreRefSchema } from "../../../models/analytics/event-parts.model.js";
 import { CartItemSchema, CartSchema } from "../../../models/cart.model.js";
+import { CheckoutSchema } from "../../../models/checkout.model.js";
 import { CompanySchema } from "../../../models/company.model.js";
 import { ProductVariantIdentifierSchema } from "../../../models/identifiers.model.js";
 import { OrderSchema } from "../../../models/order.model.js";
@@ -50,7 +51,8 @@ const AnalyticsMutationPaymentInfoAddedSchema = AnalyticsEventMutationBaseSchema
   paymentMethod: PaymentMethodSchema
 });
 const AnalyticsMutationOrderPlacedSchema = AnalyticsEventMutationBaseSchema.extend({
-  order: OrderSchema
+  checkout: CheckoutSchema.optional().meta({ description: "The finalized checkout: what the customer placed. Preferred over order, as the order may not exist yet when the OMS is the order source. Either checkout or order is required." }),
+  order: OrderSchema.optional().meta({ description: "Deprecated: pass the checkout instead. Either checkout or order is required.", deprecated: true })
 });
 const AnalyticsMutationQuoteRequestedSchema = AnalyticsEventMutationBaseSchema.extend({
   cart: CartSchema

package/src/analytics/index.d.ts

@@ -2,5 +2,6 @@ export * from './context.js';
 export * from './dispatcher.js';
 export * from './legacy-adapter.js';
 export * from './origins.js';
+export * from './placed-order.js';
 export * from './recording-subscriber.js';
 export * from './refs.js';

package/src/analytics/placed-order.d.ts

@@ -0,0 +1,24 @@
+import type { Checkout } from '../schemas/models/checkout.model.js';
+import type { CostBreakDown, ItemCostBreakdown } from '../schemas/models/cost.model.js';
+import type { ProductVariantIdentifier } from '../schemas/models/identifiers.model.js';
+import type { Order } from '../schemas/models/order.model.js';
+export interface PlacedOrderLine {
+    variant: ProductVariantIdentifier;
+    quantity: number;
+    price: ItemCostBreakdown;
+}
+/** What an analytics subscriber needs to report a purchase, whether it was given a checkout or an order. */
+export interface PlacedOrderSummary {
+    /** The order key when it is known, otherwise the key of the checkout that created it. */
+    transactionId: string;
+    items: PlacedOrderLine[];
+    price: CostBreakDown;
+}
+/**
+ * Normalizes an order-placed payload. The checkout is preferred, as it is what the customer placed; the order is
+ * the deprecated alternative. Returns undefined when the payload carries neither.
+ */
+export declare function summarizePlacedOrder(payload: {
+    checkout?: Checkout;
+    order?: Order;
+}): PlacedOrderSummary | undefined;