@chordcommerce/analytics 1.19.0 → 1.21.0-beta.3

package/dist/types/formatters.d.ts

@@ -1,6 +1,6 @@
-import type { CartViewed, CheckoutStarted, CheckoutStepCompleted, CheckoutStepViewed, ProductAdded, ProductClicked, VariantClicked, ProductViewed, ProductListViewed, CouponApplied, CouponDenied, CouponEntered, CouponRemoved, EmailCaptured, ProductListFiltered, ProductRemoved, ProductsSearched, SignedIn, SignedOut, SignedUp, LoginStarted, SubscriptionCancelled, NavigationClicked, PaymentInfoEntered } from './typewriter.js';
+import type { CartViewed, CheckoutStarted, CheckoutStepCompleted, CheckoutStepViewed, ProductAdded, ProductClicked, VariantClicked, ProductViewed, ProductListViewed, CouponApplied, CouponDenied, CouponEntered, CouponRemoved, EmailCaptured, ProductListFiltered, ProductRemoved, ProductsSearched, SignedIn, SignedOut, SignedUp, LoginStarted, OrderCompleted, SubscriptionCancelled, NavigationClicked, PaymentInfoEntered } from './typewriter.js';
 import type { Cart, Checkout, LineItem, Product } from './objects.js';
-import type { CartInput, CheckoutInput, CheckoutStepCompletedInput, CheckoutStepViewedInput, LineItemInput, ProductInput, CartViewedInput, CheckoutStartedInput, ProductAddedInput, ProductClickedInput, VariantClickedInput, ProductViewedInput, ProductListViewedInput, ProductListFilteredInput, ProductRemovedInput, CouponAppliedInput, CouponDeniedInput, CouponEnteredInput, CouponRemovedInput, EmailCapturedInput, ProductsSearchedInput, SignedInInput, SignedOutInput, SignedUpInput, LoginStartedInput, SubscriptionCancelledInput, NavigationClickedInput, PaymentInfoEnteredInput } from './input.js';
+import type { CartInput, CheckoutInput, CheckoutStepCompletedInput, CheckoutStepViewedInput, LineItemInput, ProductInput, CartViewedInput, CheckoutStartedInput, ProductAddedInput, ProductClickedInput, VariantClickedInput, ProductViewedInput, ProductListViewedInput, ProductListFilteredInput, ProductRemovedInput, CouponAppliedInput, CouponDeniedInput, CouponEnteredInput, CouponRemovedInput, EmailCapturedInput, ProductsSearchedInput, SignedInInput, SignedOutInput, SignedUpInput, LoginStartedInput, OrderCompletedInput, SubscriptionCancelledInput, NavigationClickedInput, PaymentInfoEnteredInput } from './input.js';
 import type { ObjectTypes } from './client.js';
 export type CartFormatter<T = ObjectTypes['Cart']> = (props: CartInput<T>) => Cart;
 export type CheckoutFormatter<T = ObjectTypes['Checkout']> = (props: CheckoutInput<T>) => Checkout;
@@ -78,6 +78,9 @@ export interface NavigationClickedFormatter {
 export interface PaymentInfoEnteredFormatter {
     (props: PaymentInfoEnteredInput, event: PaymentInfoEntered): PaymentInfoEntered;
 }
+export interface OrderCompletedFormatter {
+    (props: OrderCompletedInput, event: OrderCompleted): OrderCompleted;
+}
 export interface ChordAnalyticsFormatters<T extends ObjectTypes = ObjectTypes> {
     events?: {
         cartViewed?: CartViewedFormatter<T>;
@@ -104,6 +107,7 @@ export interface ChordAnalyticsFormatters<T extends ObjectTypes = ObjectTypes> {
         subscriptionCancelled?: SubscriptionCancelledFormatter;
         navigationClicked?: NavigationClickedFormatter;
         paymentInfoEntered?: PaymentInfoEnteredFormatter;
+        orderCompleted?: OrderCompletedFormatter;
     };
     objects: {
         cart: CartFormatter<T['Cart']>;

package/dist/types/input.d.ts

@@ -394,3 +394,248 @@ export interface PaymentInfoEnteredInput<T extends ObjectTypes = ObjectTypes> {
      */
     value?: number;
 }
+export interface OrderCompletedProductInput {
+    /**
+     * Product affiliation (for example, "Google Store")
+     */
+    affiliation?: string;
+    /**
+     * Brand associated with the product
+     */
+    brand?: string;
+    /**
+     * Product belongs to a bundle
+     */
+    bundle?: boolean;
+    /**
+     * Number of SKUs in the bundle
+     */
+    bundleSize?: number;
+    /**
+     * Product category
+     */
+    category?: string;
+    /**
+     * Coupon code associated with the product
+     */
+    coupon?: string;
+    /**
+     * Quantity sold via cross-selling
+     */
+    crossSoldQuantity?: number;
+    /**
+     * Short description of the product
+     */
+    description?: string;
+    /**
+     * Image URL of the product
+     */
+    imageUrl?: string;
+    /**
+     * Database ID of the line item
+     */
+    lineItemId?: string;
+    /**
+     * Name of the product
+     */
+    name: string;
+    /**
+     * Option values of the product variant
+     */
+    optionValues?: string[];
+    /**
+     * Position in the product list
+     */
+    position?: number;
+    /**
+     * Price ($) of the product
+     */
+    price: number;
+    /**
+     * Database ID of the product
+     */
+    productId: string;
+    /**
+     * Quantity of the product
+     */
+    quantity: number;
+    /**
+     * Revenue ($) with discounts and coupons added in
+     */
+    revenue: number;
+    /**
+     * SKU of the product variant
+     */
+    sku: string;
+    /**
+     * Slug of the product
+     */
+    slug?: string;
+    /**
+     * URL of the product page
+     */
+    url?: string;
+    /**
+     * Name of the product variant
+     */
+    variant?: string;
+    /**
+     * Metadata of the product variant
+     */
+    variantMetadata?: {
+        [key: string]: any;
+    };
+    [property: string]: any;
+}
+export interface OrderCompletedShippingMethodDetailsInput {
+    /**
+     * Code of shipping method (for example, "standard_shipping")
+     */
+    shippingCode?: string;
+    /**
+     * Name of shipping method (for example, "Standard Shipping")
+     */
+    shippingMethod?: string;
+}
+export interface OrderCompletedInput {
+    /**
+     * Store or affiliation from which this transaction occurred
+     */
+    affiliation?: string;
+    /**
+     * Order metadata "campaign_id"
+     */
+    campaignId?: number;
+    /**
+     * Order category
+     */
+    category?: string;
+    /**
+     * Channel where order was placed (for example, "chord")
+     */
+    channel?: string;
+    /**
+     * Checkout ID
+     */
+    checkoutId?: string;
+    /**
+     * Checkout provider (for example, "stripe")
+     */
+    checkoutType?: string;
+    /**
+     * Transaction coupon redeemed with the transaction
+     */
+    coupon?: string;
+    /**
+     * Currency code of the transaction (for example, "USD")
+     */
+    currency: string;
+    /**
+     * Total discount associated with the transaction
+     */
+    discount?: number;
+    /**
+     * Email address associated with the order
+     */
+    email?: string;
+    /**
+     * First name in the shipping address for the order
+     */
+    firstName?: string;
+    /**
+     * Order contains a subscription
+     */
+    hasSubscription?: boolean;
+    /**
+     * Order is a recurring subscription order
+     */
+    isRecurring?: boolean;
+    /**
+     * Last name in the shipping address for the order
+     */
+    lastName?: string;
+    /**
+     * Metadata of the order
+     */
+    metadata?: {
+        [key: string]: any;
+    };
+    /**
+     * Date and time order was placed
+     */
+    orderDate: string;
+    /**
+     * Order/transaction ID
+     */
+    orderId: string;
+    /**
+     * Phone number associated with the order
+     */
+    phone?: string;
+    /**
+     * Products in the order
+     */
+    products: OrderCompletedProductInput[];
+    /**
+     * URL for customer to share to receive referral credit
+     */
+    purlLink?: string;
+    /**
+     * ID for referral that customer used to place the order
+     */
+    referralIdentifierId?: string;
+    /**
+     * Indicates whether the customer is new or returning
+     */
+    repeat?: boolean;
+    /**
+     * Revenue ($) associated with the transaction (excluding shipping and tax)
+     */
+    revenue: number;
+    /**
+     * Shipping cost associated with the transaction
+     */
+    shipping?: number;
+    /**
+     * City in the shipping address for the order
+     */
+    shippingCity?: string;
+    /**
+     * Country in the shipping address for the order
+     */
+    shippingCountry?: string;
+    /**
+     * Shipping method details
+     */
+    shippingMethodDetails?: OrderCompletedShippingMethodDetailsInput;
+    /**
+     * State in the shipping address for the order
+     */
+    shippingState?: string;
+    /**
+     * Zipcode in the shipping address for the order
+     */
+    shippingZipcode?: string;
+    /**
+     * Order total after discounts but before taxes and shipping
+     */
+    subtotal?: number;
+    /**
+     * Total tax associated with the transaction
+     */
+    tax?: number;
+    /**
+     * Order metadata "template_id"
+     */
+    templateId?: number;
+    /**
+     * Revenue ($) with discounts and coupons added in
+     */
+    total: number;
+    /**
+     * Tracking IDs for third party integrations
+     */
+    trackingIds?: {
+        [key: string]: any;
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chordcommerce/analytics",
   "description": "Chord Commerce event tracking",
-  "version": "1.19.0",
+  "version": "1.21.0-beta.3",
   "author": "Chord Commerce <help@chord.co> (https://www.chord.co)",
   "type": "module",
   "main": "dist/index.js",