@chordcommerce/analytics 1.6.0 → 1.8.0

package/dist/types/formatters.d.ts

@@ -0,0 +1,114 @@
+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 { 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 { ObjectTypes } from './client.js';
+export type CartFormatter<T = ObjectTypes['Cart']> = (props: CartInput<T>) => Cart;
+export type CheckoutFormatter<T = ObjectTypes['Checkout']> = (props: CheckoutInput<T>) => Checkout;
+export type LineItemFormatter<T = ObjectTypes['LineItem']> = (props: LineItemInput<T>) => LineItem;
+export type ProductFormatter<T = ObjectTypes['Product']> = (props: ProductInput<T>) => Product;
+export interface CartViewedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: CartViewedInput<T>, event: CartViewed): CartViewed;
+}
+export interface CheckoutStartedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: CheckoutStartedInput<T>, event: CheckoutStarted): CheckoutStarted;
+}
+export interface CheckoutStepCompletedFormatter {
+    (props: CheckoutStepCompletedInput, event: CheckoutStepCompleted): CheckoutStepCompleted;
+}
+export interface CheckoutStepViewedFormatter {
+    (props: CheckoutStepViewedInput, event: CheckoutStepViewed): CheckoutStepViewed;
+}
+export interface CouponAppliedFormatter {
+    (props: CouponAppliedInput, event: CouponApplied): CouponApplied;
+}
+export interface CouponDeniedFormatter {
+    (props: CouponDeniedInput, event: CouponDenied): CouponDenied;
+}
+export interface CouponEnteredFormatter {
+    (props: CouponEnteredInput, event: CouponEntered): CouponEntered;
+}
+export interface CouponRemovedFormatter {
+    (props: CouponRemovedInput, event: CouponRemoved): CouponRemoved;
+}
+export interface EmailCapturedFormatter {
+    (props: EmailCapturedInput, event: EmailCaptured): EmailCaptured;
+}
+export interface ProductAddedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductAddedInput<T>, event: ProductAdded): ProductAdded;
+}
+export interface ProductClickedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductClickedInput<T>, event: ProductClicked): ProductClicked;
+}
+export interface VariantClickedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: VariantClickedInput<T>, event: VariantClicked): VariantClicked;
+}
+export interface ProductListFilteredFormatter {
+    (props: ProductListFilteredInput, event: ProductListFiltered): ProductListFiltered;
+}
+export interface ProductListViewedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductListViewedInput<T>, event: ProductListViewed): ProductListViewed;
+}
+export interface ProductRemovedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductRemovedInput<T>, event: ProductRemoved): ProductRemoved;
+}
+export interface ProductViewedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductViewedInput<T>, event: ProductViewed): ProductViewed;
+}
+export interface ProductsSearchedFormatter {
+    (props: ProductsSearchedInput, event: ProductsSearched): ProductsSearched;
+}
+export interface SignedInFormatter {
+    (props: SignedInInput, event: SignedIn): SignedIn;
+}
+export interface SignedOutFormatter {
+    (props: SignedOutInput, event: SignedOut): SignedOut;
+}
+export interface SignedUpFormatter {
+    (props: SignedUpInput, event: SignedUp): SignedUp;
+}
+export interface LoginStartedFormatter {
+    (props: LoginStartedInput, event: LoginStarted): LoginStarted;
+}
+export interface SubscriptionCancelledFormatter {
+    (props: SubscriptionCancelledInput, event: SubscriptionCancelled): SubscriptionCancelled;
+}
+export interface NavigationClickedFormatter {
+    (props: NavigationClickedInput, event: NavigationClicked): NavigationClicked;
+}
+export interface PaymentInfoEnteredFormatter {
+    (props: PaymentInfoEnteredInput, event: PaymentInfoEntered): PaymentInfoEntered;
+}
+export interface ChordAnalyticsFormatters<T extends ObjectTypes = ObjectTypes> {
+    events?: {
+        cartViewed?: CartViewedFormatter<T>;
+        checkoutStarted?: CheckoutStartedFormatter<T>;
+        checkoutStepCompleted?: CheckoutStepCompletedFormatter;
+        checkoutStepViewed?: CheckoutStepViewedFormatter;
+        couponApplied?: CouponAppliedFormatter;
+        couponDenied?: CouponDeniedFormatter;
+        couponEntered?: CouponEnteredFormatter;
+        couponRemoved?: CouponRemovedFormatter;
+        emailCaptured?: EmailCapturedFormatter;
+        productAdded?: ProductAddedFormatter<T>;
+        productClicked?: ProductClickedFormatter<T>;
+        variantClicked?: VariantClickedFormatter<T>;
+        productListFiltered?: ProductListFilteredFormatter;
+        productListViewed?: ProductListViewedFormatter<T>;
+        productRemoved?: ProductRemovedFormatter<T>;
+        productViewed?: ProductViewedFormatter<T>;
+        productsSearched?: ProductsSearchedFormatter;
+        signedIn?: SignedInFormatter;
+        signedOut?: SignedOutFormatter;
+        signedUp?: SignedUpFormatter;
+        loginStarted?: LoginStartedFormatter;
+        subscriptionCancelled?: SubscriptionCancelledFormatter;
+        navigationClicked?: NavigationClickedFormatter;
+        paymentInfoEntered?: PaymentInfoEnteredFormatter;
+    };
+    objects: {
+        cart: CartFormatter<T['Cart']>;
+        checkout: CheckoutFormatter<T['Checkout']>;
+        lineItem: LineItemFormatter<T['LineItem']>;
+        product: ProductFormatter<T['Product']>;
+    };
+}

package/dist/types/formatters.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -3,3 +3,4 @@ export * from './objects.js';
 export * from './typewriter.js';
 export * from './client.js';
 export * from './input.js';
+export * from './formatters.js';

package/dist/types/index.js

@@ -2,3 +2,4 @@ export * from './objects.js';
 export * from './typewriter.js';
 export * from './client.js';
 export * from './input.js';
+export * from './formatters.js';

package/dist/types/input.d.ts

@@ -1,6 +1,6 @@
-import type { AnyCart, AnyCheckout, AnyId, AnyLineItem, AnyProduct } from './client.js';
-import type { Filter, Sort } from './typewriter.js';
-export interface ProductInput {
+import type { AnyId, ObjectTypes } from './client.js';
+import type { Filter, Sort, SubscriptionCancelledAddress } from './typewriter.js';
+export interface ProductInput<ProductType extends ObjectTypes['Product'] = ObjectTypes['Product']> {
     /**
      * The position in a list of the product that was added, if relevant.
      */
@@ -8,7 +8,7 @@ export interface ProductInput {
     /**
      * Product and variant details, like product name and variant SKUs.
      */
-    product: AnyProduct;
+    product: ProductType;
     /**
      * The quantity of the product involved in the tracking event. Sometimes quantity might
      * not be relevant to an event, and can be either omitted or defaulted to `1`.
@@ -22,35 +22,71 @@ export interface ProductInput {
      */
     variantId?: AnyId;
 }
-export interface CartInput {
+export interface CartInput<CartType extends ObjectTypes['Cart'] = ObjectTypes['Cart']> {
     /**
      * The current cart.
      */
-    cart: AnyCart;
+    cart: CartType;
 }
-export interface CheckoutInput {
+export interface CheckoutInput<CheckoutType extends ObjectTypes['Checkout'] = ObjectTypes['Checkout']> {
     /**
      * The current checkout.
      */
-    checkout: AnyCheckout;
+    checkout: CheckoutType;
 }
-export interface LineItemInput {
+export interface LineItemInput<LineItemType extends ObjectTypes['LineItem'] = ObjectTypes['LineItem']> {
     /**
      * The line item before it was removed.
      */
-    lineItem: AnyLineItem;
+    lineItem: LineItemType;
 }
-export interface CartViewedInput {
+export interface CartViewedInput<T extends ObjectTypes = ObjectTypes> {
     /**
      * The current cart.
      */
-    cart: AnyCart;
+    cart: T['Cart'];
 }
-export interface CheckoutStartedInput {
+export interface CheckoutStartedInput<T extends ObjectTypes = ObjectTypes> {
     /**
      * The current checkout.
      */
-    checkout: AnyCheckout;
+    checkout: T['Checkout'];
+}
+export interface CheckoutStepCompletedInput {
+    /**
+     * The current checkout.
+     */
+    checkoutId: string;
+    /**
+     * The step that was completed.
+     */
+    step: number;
+    /**
+     * String representing the payment method chosen
+     */
+    paymentMethod?: string;
+    /**
+     * String representing the shipping the method chosen
+     */
+    shippingMethod?: string;
+}
+export interface CheckoutStepViewedInput {
+    /**
+     * The current checkout.
+     */
+    checkoutId: string;
+    /**
+     * The step that was completed.
+     */
+    step: number;
+    /**
+     * String representing the payment method chosen
+     */
+    paymentMethod?: string;
+    /**
+     * String representing the shipping the method chosen
+     */
+    shippingMethod?: string;
 }
 /**
  * Coupon was applied on a user's shopping cart or order
@@ -154,21 +190,31 @@ export interface EmailCapturedInput {
     placementComponent?: string;
     placementPage?: string;
 }
-export interface ProductAddedInput {
+export interface ProductAddedInput<T extends ObjectTypes = ObjectTypes> {
     /**
      * The current cart, after the product is added.
      */
-    cart: AnyCart;
-    product: ProductInput;
+    cart: T['Cart'];
+    product: ProductInput<T['Product']>;
 }
-export interface ProductClickedInput {
+export interface ProductClickedInput<T extends ObjectTypes = ObjectTypes> {
     /**
      * The current cart.
      */
-    cart: AnyCart;
+    cart: T['Cart'];
     listId?: AnyId;
     listName?: string;
-    product: ProductInput;
+    product: ProductInput<T['Product']>;
+}
+export interface VariantClickedInput<T extends ObjectTypes = ObjectTypes> {
+    /**
+     * The current cart.
+     */
+    cart: T['Cart'];
+    coupon?: string;
+    lineItemId?: string;
+    product: ProductInput<T['Product']>;
+    couponId?: string;
 }
 export interface ProductListFilteredInput {
     category?: string;
@@ -177,31 +223,31 @@ export interface ProductListFilteredInput {
     filters?: Filter[];
     sorts?: Sort[];
 }
-export interface ProductListViewedInput {
+export interface ProductListViewedInput<T extends ObjectTypes = ObjectTypes> {
     category?: string;
     listId?: string;
     listName?: string;
-    products: ProductInput[];
+    products: ProductInput<T['Product']>[];
 }
-export interface ProductRemovedInput {
+export interface ProductRemovedInput<T extends ObjectTypes = ObjectTypes> {
     /**
      * The current cart.
      */
-    cart: AnyCart;
+    cart: T['Cart'];
     /**
      * The line item before it was removed.
      */
-    lineItem: AnyLineItem;
+    lineItem: T['LineItem'];
 }
-export interface ProductViewedInput {
+export interface ProductViewedInput<T extends ObjectTypes = ObjectTypes> {
     /**
      * The current cart.
      */
-    cart: AnyCart;
+    cart: T['Cart'];
     /**
      * The product being viewed.
      */
-    product: ProductInput;
+    product: ProductInput<T['Product']>;
 }
 export interface ProductsSearchedInput {
     currency?: string;
@@ -211,13 +257,140 @@ export interface ProductsSearchedInput {
     query?: string;
 }
 export interface SignedInInput {
+    /**
+     * The email of the user
+     */
     email?: string;
+    /**
+     * The method used to login
+     */
     method?: string;
 }
 export interface SignedOutInput {
+    /**
+     * The email of the user
+     */
     email?: string;
 }
 export interface SignedUpInput {
+    /**
+     * The email of the user
+     */
     email?: string;
+    /**
+     * The method used to login
+     */
     method?: string;
 }
+export interface LoginStartedInput {
+    /**
+     * The email of the user
+     */
+    email?: string;
+}
+export interface SubscriptionCancelledInput<T extends ObjectTypes = ObjectTypes> {
+    /**
+     * Next date when this subscription will be actionable (renewed, expired, etc.)
+     */
+    actionableDate?: string;
+    /**
+     * Shipping address for the subscription
+     */
+    address?: SubscriptionCancelledAddress;
+    /**
+     * Brand associated with the subscription
+     */
+    brand?: string;
+    /**
+     * Currency code of the transaction (for example, "USD")
+     */
+    currency?: string;
+    /**
+     * Email address associated with the subscription
+     */
+    email?: string;
+    /**
+     * Subscription will stop auto-renewing after this date
+     */
+    endDate?: string;
+    /**
+     * Interval number at which the subscription renews
+     */
+    intervalLength?: number;
+    /**
+     * Interval unit at which the subscription renews (for example, "month")
+     */
+    intervalUnits?: string;
+    /**
+     * Products in the subscription
+     */
+    products?: ProductInput<T['Product']>[];
+    /**
+     * The state of the subscription (for example, "active")
+     */
+    state?: string;
+    /**
+     * ID of the subscription
+     */
+    subscriptionId?: string;
+}
+export interface NavigationClickedInput {
+    /**
+     * Name of menu or category where navigation link was clicked (for example, "Support")
+     */
+    category?: string;
+    /**
+     * Navigation label clicked (for example, "Contact")
+     */
+    label?: string;
+    /**
+     * Navigation HTML component within the UX (for example, "footer")
+     */
+    navigationPlacement?: string;
+    /**
+     * Navigation label clicked (for example, "Contact")
+     */
+    navigationTitle?: string;
+    /**
+     * URL of navigation link destination
+     */
+    navigationUrl?: string;
+}
+export interface PaymentInfoEnteredInput<T extends ObjectTypes = ObjectTypes> {
+    /**
+     * Checkout transaction ID
+     */
+    checkoutId?: string;
+    /**
+     * Transaction coupon redeemed with the transaction
+     */
+    coupon?: string;
+    /**
+     * Currency code of the transaction (for example, "USD")
+     */
+    currency?: string;
+    /**
+     * Order ID
+     */
+    orderId?: string;
+    /**
+     * String representing the payment method chosen
+     */
+    paymentMethod?: string;
+    /**
+     * Products in the order
+     */
+    products: ProductInput<T['Product']>[];
+    /**
+     * String representing the shipping the method chosen
+     */
+    shippingMethod?: string;
+    /**
+     * Number representing a step in the checkout process
+     */
+    step: number;
+    /**
+     * Revenue ($) with discounts and coupons added in
+     */
+    value?: number;
+}

package/dist/validators/objects.d.ts

@@ -1,113 +1,113 @@
 import { z } from 'zod';
 export declare const identifyTraitsSchema: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodObject<{
-    address: z.ZodOptional<z.ZodObject<{
+    address: z.ZodOptional<z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodObject<{
         city: z.ZodOptional<z.ZodString>;
         country: z.ZodOptional<z.ZodString>;
-        postal_code: z.ZodOptional<z.ZodString>;
+        postalCode: z.ZodOptional<z.ZodString>;
         state: z.ZodOptional<z.ZodString>;
         street: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         city?: string;
         country?: string;
-        postal_code?: string;
+        postalCode?: string;
         state?: string;
         street?: string;
     }, {
         city?: string;
         country?: string;
-        postal_code?: string;
+        postalCode?: string;
         state?: string;
         street?: string;
-    }>>;
+    }>>>;
     age: z.ZodOptional<z.ZodNumber>;
     avatar: z.ZodOptional<z.ZodString>;
     birthday: z.ZodOptional<z.ZodString>;
-    company: z.ZodOptional<z.ZodObject<{
+    company: z.ZodOptional<z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodObject<{
         name: z.ZodOptional<z.ZodString>;
         id: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
         industry: z.ZodOptional<z.ZodString>;
-        employee_count: z.ZodOptional<z.ZodNumber>;
+        employeeCount: z.ZodOptional<z.ZodNumber>;
         plan: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         name?: string;
         id?: string | number;
         industry?: string;
-        employee_count?: number;
+        employeeCount?: number;
         plan?: string;
     }, {
         name?: string;
         id?: string | number;
         industry?: string;
-        employee_count?: number;
+        employeeCount?: number;
         plan?: string;
-    }>>;
-    created_at: z.ZodOptional<z.ZodString>;
+    }>>>;
+    createdAt: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
     email: z.ZodOptional<z.ZodString>;
-    first_name: z.ZodOptional<z.ZodString>;
+    firstName: z.ZodOptional<z.ZodString>;
     gender: z.ZodOptional<z.ZodString>;
     id: z.ZodOptional<z.ZodString>;
-    last_name: z.ZodOptional<z.ZodString>;
+    lastName: z.ZodOptional<z.ZodString>;
     name: z.ZodOptional<z.ZodString>;
     phone: z.ZodOptional<z.ZodString>;
     title: z.ZodOptional<z.ZodString>;
     username: z.ZodOptional<z.ZodString>;
     website: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    address?: {
+    address?: Record<string, any> & {
         city?: string;
         country?: string;
-        postal_code?: string;
+        postalCode?: string;
         state?: string;
         street?: string;
     };
     age?: number;
     avatar?: string;
     birthday?: string;
-    company?: {
+    company?: Record<string, any> & {
         name?: string;
         id?: string | number;
         industry?: string;
-        employee_count?: number;
+        employeeCount?: number;
         plan?: string;
     };
-    created_at?: string;
+    createdAt?: string;
     description?: string;
     email?: string;
-    first_name?: string;
+    firstName?: string;
     gender?: string;
     id?: string;
-    last_name?: string;
+    lastName?: string;
     name?: string;
     phone?: string;
     title?: string;
     username?: string;
     website?: string;
 }, {
-    address?: {
+    address?: Record<string, any> & {
         city?: string;
         country?: string;
-        postal_code?: string;
+        postalCode?: string;
         state?: string;
         street?: string;
     };
     age?: number;
     avatar?: string;
     birthday?: string;
-    company?: {
+    company?: Record<string, any> & {
         name?: string;
         id?: string | number;
         industry?: string;
-        employee_count?: number;
+        employeeCount?: number;
         plan?: string;
     };
-    created_at?: string;
+    createdAt?: string;
     description?: string;
     email?: string;
-    first_name?: string;
+    firstName?: string;
     gender?: string;
     id?: string;
-    last_name?: string;
+    lastName?: string;
     name?: string;
     phone?: string;
     title?: string;
@@ -515,6 +515,7 @@ export declare const checkoutSchema: z.ZodObject<{
     shipping: z.ZodOptional<z.ZodNumber>;
     tax: z.ZodOptional<z.ZodNumber>;
     value: z.ZodOptional<z.ZodNumber>;
+    step: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     affiliation?: string;
     checkout_type?: string;
@@ -547,6 +548,7 @@ export declare const checkoutSchema: z.ZodObject<{
     shipping?: number;
     tax?: number;
     value?: number;
+    step?: number;
 }, {
     affiliation?: string;
     checkout_type?: string;
@@ -579,6 +581,7 @@ export declare const checkoutSchema: z.ZodObject<{
     shipping?: number;
     tax?: number;
     value?: number;
+    step?: number;
 }>;
 export declare const cartSchema: z.ZodObject<{
     cart_id: z.ZodOptional<z.ZodString>;

package/dist/validators/objects.js

@@ -2,33 +2,35 @@
 import { z } from 'zod';
 export const identifyTraitsSchema = z.record(z.any()).and(z.object({
     address: z
-        .object({
+        .record(z.any())
+        .and(z.object({
         city: z.string().optional(),
         country: z.string().optional(),
-        postal_code: z.string().optional(),
+        postalCode: z.string().optional(),
         state: z.string().optional(),
         street: z.string().optional(),
-    })
+    }))
         .optional(),
     age: z.number().optional(),
     avatar: z.string().optional(),
     birthday: z.string().optional(),
     company: z
-        .object({
+        .record(z.any())
+        .and(z.object({
         name: z.string().optional(),
         id: z.union([z.string(), z.number()]).optional(),
         industry: z.string().optional(),
-        employee_count: z.number().optional(),
+        employeeCount: z.number().optional(),
         plan: z.string().optional(),
-    })
+    }))
         .optional(),
-    created_at: z.string().optional(),
+    createdAt: z.string().optional(),
     description: z.string().optional(),
     email: z.string().optional(),
-    first_name: z.string().optional(),
+    firstName: z.string().optional(),
     gender: z.string().optional(),
     id: z.string().optional(),
-    last_name: z.string().optional(),
+    lastName: z.string().optional(),
     name: z.string().optional(),
     phone: z.string().optional(),
     title: z.string().optional(),
@@ -113,6 +115,7 @@ export const checkoutSchema = z.object({
     shipping: z.number().optional(),
     tax: z.number().optional(),
     value: z.number().optional(),
+    step: z.number().optional(),
 });
 export const cartSchema = z.object({
     cart_id: z.string().optional(),