@chordcommerce/analytics 1.5.1

package/dist/types/client.d.ts

@@ -0,0 +1,86 @@
+import type { AnalyticsSnippet, Analytics, AnalyticsBrowser, Options } from '@segment/analytics-next';
+import type { Cart, Checkout, Product, LineItem } from './objects.js';
+import type { CartViewed, CheckoutStarted, CouponApplied, CouponDenied, CouponEntered, CouponRemoved, EmailCaptured, ProductAdded, ProductClicked, ProductListFiltered, ProductListViewed, ProductRemoved, ProductViewed, ProductsSearched, SignedIn, SignedOut, SignedUp } from './typewriter.js';
+import type { CartViewedInput, CheckoutStartedInput, EmailCapturedInput, ProductAddedInput, ProductClickedInput, ProductListFilteredInput, ProductListViewedInput, ProductRemovedInput, ProductViewedInput, ProductsSearchedInput, ProductInput, CartInput, CheckoutInput, LineItemInput, CouponAppliedInput, CouponDeniedInput, CouponEnteredInput, CouponRemovedInput, SignedInInput, SignedOutInput, SignedUpInput } from './input.js';
+export interface ValidateResult {
+    success: boolean;
+    error?: any[];
+    data?: any;
+}
+export type AnyAnalytics = AnalyticsSnippet | Analytics | AnalyticsBrowser;
+export type AnyOptions = Options;
+export type AnyProduct = {
+    [key: string]: unknown;
+};
+export type AnyCart = {
+    [key: string]: unknown;
+};
+export type AnyCheckout = {
+    [key: string]: unknown;
+};
+export type AnyId = string | number;
+export type AnyLineItem = {
+    [key: string]: unknown;
+};
+export interface ChordAnalyticsOptions {
+    cdp?: AnyAnalytics | (() => AnyAnalytics);
+    debug?: boolean;
+    enableLogging?: boolean;
+    formatters: {
+        events?: {
+            cartViewed?: (props: CartViewedInput, event: CartViewed) => CartViewed;
+            checkoutStarted?: (props: CheckoutStartedInput, event: CheckoutStarted) => CheckoutStarted;
+            couponApplied?: (props: CouponAppliedInput, event: CouponApplied) => CouponApplied;
+            couponDenied?: (props: CouponDeniedInput, event: CouponDenied) => CouponDenied;
+            couponEntered?: (props: CouponEnteredInput, event: CouponEntered) => CouponEntered;
+            couponRemoved?: (props: CouponRemovedInput, event: CouponRemoved) => CouponRemoved;
+            emailCaptured?: (props: EmailCapturedInput, event: EmailCaptured) => EmailCaptured;
+            productAdded?: (props: ProductAddedInput, event: ProductAdded) => ProductAdded;
+            productClicked?: (props: ProductClickedInput, event: ProductClicked) => ProductClicked;
+            productListFiltered?: (props: ProductListFilteredInput, event: ProductListFiltered) => ProductListFiltered;
+            productListViewed?: (props: ProductListViewedInput, event: ProductListViewed) => ProductListViewed;
+            productRemoved?: (props: ProductRemovedInput, event: ProductRemoved) => ProductRemoved;
+            productViewed?: (props: ProductViewedInput, event: ProductViewed) => ProductViewed;
+            productsSearched?: (props: ProductsSearchedInput, event: ProductsSearched) => ProductsSearched;
+            signedIn?: (props: SignedInInput, event: SignedIn) => SignedIn;
+            signedOut?: (props: SignedOutInput, event: SignedOut) => SignedOut;
+            signedUp?: (props: SignedUpInput, event: SignedUp) => SignedUp;
+        };
+        objects: {
+            cart: (props: CartInput) => Cart;
+            checkout: (props: CheckoutInput) => Checkout;
+            lineItem: (props: LineItemInput) => LineItem;
+            product: (props: ProductInput) => Product;
+        };
+    };
+    stripNull?: boolean;
+    metadata: EventMetadata;
+}
+export interface EventMetadata {
+    i18n: i18nMetadata;
+    ownership: ownershipMetadata;
+    platform: platformMetadata;
+    store: storeMetadata;
+    version?: versionMetadata;
+}
+export interface i18nMetadata {
+    currency: string;
+    locale: string;
+}
+export interface ownershipMetadata {
+    omsId: string;
+    storeId: string;
+    tenantId: string;
+}
+export interface platformMetadata {
+    name: string;
+    type: string;
+}
+export interface versionMetadata {
+    major: number;
+    minor: number;
+    patch: number;
+}
+export interface storeMetadata {
+    domain: string;
+}

package/dist/types/client.js

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

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export type { AnalyticsSnippet, Analytics, AnalyticsBrowser, EventProperties, Options, } from '@segment/analytics-next';
+export * from './objects.js';
+export * from './typewriter.js';
+export * from './client.js';
+export * from './input.js';

package/dist/types/index.js

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

package/dist/types/input.d.ts

@@ -0,0 +1,223 @@
+import type { AnyCart, AnyCheckout, AnyId, AnyLineItem, AnyProduct } from './client.js';
+import type { Filter, Sort } from './typewriter.js';
+export interface ProductInput {
+    /**
+     * The position in a list of the product that was added, if relevant.
+     */
+    position?: number;
+    /**
+     * Product and variant details, like product name and variant SKUs.
+     */
+    product: AnyProduct;
+    /**
+     * 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`.
+     */
+    quantity?: number;
+    /**
+     * The unique identifier of the product variant. This should allow you to look up the
+     * selected variant details from the `product` object. If not provided, it's typical
+     * to default to the first product variant, or default product variant if that's a concept
+     * that exists in your product catalog.
+     */
+    variantId?: AnyId;
+}
+export interface CartInput {
+    /**
+     * The current cart.
+     */
+    cart: AnyCart;
+}
+export interface CheckoutInput {
+    /**
+     * The current checkout.
+     */
+    checkout: AnyCheckout;
+}
+export interface LineItemInput {
+    /**
+     * The line item before it was removed.
+     */
+    lineItem: AnyLineItem;
+}
+export interface CartViewedInput {
+    /**
+     * The current cart.
+     */
+    cart: AnyCart;
+}
+export interface CheckoutStartedInput {
+    /**
+     * The current checkout.
+     */
+    checkout: AnyCheckout;
+}
+/**
+ * Coupon was applied on a user's shopping cart or order
+ */
+export interface CouponAppliedInput {
+    /**
+     * Cart ID, if applicable
+     */
+    cartId?: string;
+    /**
+     * Coupon ID
+     */
+    couponId?: string;
+    /**
+     * Coupon name
+     */
+    couponName?: string;
+    /**
+     * Monetary discount applied through the coupon
+     */
+    discount?: number;
+    /**
+     * Order/transaction ID, if applicable
+     */
+    orderId?: string;
+}
+/**
+ * Coupon was denied from a user's shopping cart or order
+ */
+export interface CouponDeniedInput {
+    /**
+     * Cart ID, if applicable
+     */
+    cartId?: string;
+    /**
+     * Coupon ID
+     */
+    couponId?: string;
+    /**
+     * Coupon name
+     */
+    couponName?: string;
+    /**
+     * Order/transaction ID, if applicable
+     */
+    orderId?: string;
+    /**
+     * Reason the coupon was denied
+     */
+    reason?: string;
+}
+/**
+ * User entered a coupon on a shopping cart or order
+ */
+export interface CouponEnteredInput {
+    /**
+     * Cart ID, if applicable
+     */
+    cartId?: string;
+    /**
+     * Coupon ID
+     */
+    couponId?: string;
+    /**
+     * Coupon name
+     */
+    couponName?: string;
+    /**
+     * Order/transaction ID, if applicable
+     */
+    orderId?: string;
+}
+/**
+ * User removed a coupon from a cart or order
+ */
+export interface CouponRemovedInput {
+    /**
+     * Cart ID, if applicable
+     */
+    cartId?: string;
+    /**
+     * Coupon ID
+     */
+    couponId?: string;
+    /**
+     * Coupon name
+     */
+    couponName?: string;
+    /**
+     * Monetary discount applied through the coupon
+     */
+    discount?: number;
+    /**
+     * Order/transaction ID, if applicable
+     */
+    orderId?: string;
+    [property: string]: any;
+}
+export interface EmailCapturedInput {
+    email?: string;
+    placementComponent?: string;
+    placementPage?: string;
+}
+export interface ProductAddedInput {
+    /**
+     * The current cart, after the product is added.
+     */
+    cart: AnyCart;
+    product: ProductInput;
+}
+export interface ProductClickedInput {
+    /**
+     * The current cart.
+     */
+    cart: AnyCart;
+    listId?: AnyId;
+    listName?: string;
+    product: ProductInput;
+}
+export interface ProductListFilteredInput {
+    category?: string;
+    listId?: string;
+    listName?: string;
+    filters?: Filter[];
+    sorts?: Sort[];
+}
+export interface ProductListViewedInput {
+    category?: string;
+    listId?: string;
+    listName?: string;
+    products: ProductInput[];
+}
+export interface ProductRemovedInput {
+    /**
+     * The current cart.
+     */
+    cart: AnyCart;
+    /**
+     * The line item before it was removed.
+     */
+    lineItem: AnyLineItem;
+}
+export interface ProductViewedInput {
+    /**
+     * The current cart.
+     */
+    cart: AnyCart;
+    /**
+     * The product being viewed.
+     */
+    product: ProductInput;
+}
+export interface ProductsSearchedInput {
+    currency?: string;
+    price?: number;
+    productId?: AnyId;
+    quantity?: number;
+    query?: string;
+}
+export interface SignedInInput {
+    email?: string;
+    method?: string;
+}
+export interface SignedOutInput {
+    email?: string;
+}
+export interface SignedUpInput {
+    email?: string;
+    method?: string;
+}

package/dist/types/input.js

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

package/dist/types/objects.d.ts

@@ -0,0 +1,379 @@
+export interface Cart {
+    /**
+     * Cart ID
+     */
+    cart_id?: string;
+    /**
+     * Currency code of the transaction (for example, "USD")
+     */
+    currency?: string;
+    /**
+     * Products in the cart
+     */
+    products: LineItem[];
+    /**
+     * Revenue ($) with discounts and coupons added in
+     */
+    value?: number;
+}
+export interface IdentifyTraits {
+    /**
+     * Street address of a user.
+     */
+    address?: {
+        city?: string;
+        country?: string;
+        postalCode?: string;
+        state?: string;
+        street?: string;
+        [property: string]: any;
+    };
+    /**
+     * Age of a user
+     */
+    age?: number;
+    /**
+     * URL to an avatar image for the user
+     */
+    avatar?: string;
+    /**
+     * User’s birthday. Segment recommends using ISO-8601 date strings.
+     */
+    birthday?: string;
+    /**
+     * Company the user represents
+     */
+    company?: {
+        name?: string;
+        id?: string | number;
+        industry?: string;
+        employeeCount?: number;
+        plan?: string;
+        [property: string]: any;
+    };
+    /**
+     * Date the user’s account was first created. Segment recommends using ISO-8601 date strings.
+     */
+    createdAt?: string;
+    /**
+     * Description of the user
+     */
+    description?: string;
+    /**
+     * Email address of a user
+     */
+    email?: string;
+    /**
+     * First name of a user
+     */
+    firstName?: string;
+    /**
+     * Gender of a user
+     */
+    gender?: string;
+    /**
+     * Unique ID in your database for a user
+     */
+    id?: string;
+    /**
+     * Last name of a user
+     */
+    lastName?: string;
+    /**
+     * Full name of a user. If you only pass a first and last name Segment automatically fills in the full name for you.
+     */
+    name?: string;
+    /**
+     * Phone number of a user
+     */
+    phone?: string;
+    /**
+     * Title of a user, usually related to their position at a specific company. Example: “VP of Engineering”
+     */
+    title?: string;
+    /**
+     * User’s username. This should be unique to each user, like the usernames of Twitter or GitHub.
+     */
+    username?: string;
+    /**
+     * Website of a user
+     */
+    website?: string;
+    /**
+     * Additional custom user traits.
+     */
+    [property: string]: any;
+}
+export interface LineItem extends Product {
+    /**
+     * Coupon code associated with a product (for example, "MAY_DEALS_3")
+     */
+    coupon?: string;
+    /**
+     * Database ID of the line item
+     */
+    line_item_id?: string;
+    /**
+     * Quantity of the product
+     */
+    quantity: number;
+}
+export interface Order {
+    /**
+     * Store or affiliation from which this transaction occurred (for example, "Google Store")
+     */
+    affiliation?: string;
+    /**
+     * Order metadata "campaign_id"
+     */
+    campaign_id?: number;
+    /**
+     * Channel where order was placed (for example, "chord")
+     */
+    channel?: string;
+    /**
+     * Checkout provider (for example, "stripe")
+     */
+    checkout_type?: 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
+     */
+    first_name?: string;
+    /**
+     * Order contains a subscription
+     */
+    has_subscription?: boolean;
+    /**
+     * Order contains a subscription
+     */
+    is_recurring?: boolean;
+    /**
+     * Last name in the shipping address for the order
+     */
+    last_name?: string;
+    /**
+     * Metadata of the order
+     */
+    metadata?: {
+        [k: string]: unknown;
+    };
+    /**
+     * Date and time order was placed
+     */
+    order_date?: string;
+    /**
+     * Order/transaction ID
+     */
+    order_id?: string;
+    /**
+     * Phone number associated with the order
+     */
+    phone?: string;
+    /**
+     * Products in the order
+     */
+    products?: (LineItem & {
+        /**
+         * Number of SKUs in the bundle
+         */
+        bundle_size?: number;
+        /**
+         * Quantity sold via cross-selling
+         */
+        cross_sold_quantity?: number;
+        /**
+         * Metadata of the product variant
+         */
+        variant_metadata?: {
+            [k: string]: unknown;
+        };
+    })[];
+    /**
+     * URL for customer to share to receive referral credit
+     */
+    purl_link?: string;
+    /**
+     * ID for referral that customer used to place the order
+     */
+    referral_identifier_id?: string;
+    /**
+     * 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
+     */
+    shipping_city?: string;
+    /**
+     * Country in the shipping address for the order
+     */
+    shipping_country?: string;
+    shipping_method_details?: {
+        /**
+         * Code of shipping method chosen for the order (for example, "standard_shipping")
+         */
+        shipping_code?: string;
+        /**
+         * Name of shipping method chosen for the order (for example, "Standard Shipping")
+         */
+        shipping_method?: string;
+    };
+    /**
+     * State in the shipping address for the order
+     */
+    shipping_state?: string;
+    /**
+     * Zipcode in the shipping address for the order
+     */
+    shipping_zipcode?: string;
+    /**
+     * Total tax associated with the transaction
+     */
+    tax?: number;
+    /**
+     * Order metadata "template_id"
+     */
+    template_id?: number;
+    /**
+     * Revenue ($) with discounts and coupons added in.
+     */
+    total?: number;
+    /**
+     * Tracking IDs for third party integrations
+     */
+    tracking_ids?: {
+        [k: string]: unknown;
+    };
+}
+export interface Product {
+    /**
+     * Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")
+     */
+    affiliation?: string;
+    /**
+     * Brand associated with the product
+     */
+    brand?: string;
+    /**
+     * Product belongs to a bundle
+     */
+    bundle?: boolean;
+    /**
+     * Product category
+     */
+    category?: string;
+    /**
+     * Short description of the product
+     */
+    description?: string;
+    /**
+     * Image URL of the product
+     */
+    image_url?: string;
+    /**
+     * Name of the product
+     */
+    name: string;
+    /**
+     * Option values of the product variant
+     */
+    option_values?: string[];
+    /**
+     * Position in the product list (for example, 3)
+     */
+    position?: number;
+    /**
+     * Price ($) of the product
+     */
+    price: number;
+    /**
+     * Database ID of the product
+     */
+    product_id: string;
+    /**
+     * SKU of the product variant
+     */
+    sku: string;
+    /**
+     * Slug of the product, often used in URLs (for example, "product-red")
+     */
+    slug?: string;
+    /**
+     * URL of the product page
+     */
+    url?: string;
+    /**
+     * Name of the product variant
+     */
+    variant?: string;
+}
+export interface Checkout {
+    /**
+     * Store or affiliation from which this transaction occurred (for example, "Google Store")
+     */
+    affiliation?: string;
+    /**
+     * Checkout provider (for example, "stripe")
+     */
+    checkout_type?: 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;
+    /**
+     * Order/transaction ID
+     */
+    order_id?: string;
+    /**
+     * Order number (for example, "CHORD-000111222")
+     */
+    order_name?: string;
+    /**
+     * Products in the checkout
+     */
+    products: LineItem[];
+    /**
+     * Revenue ($) associated with the transaction (excluding shipping and tax)
+     */
+    revenue?: number;
+    /**
+     * Shipping cost associated with the transaction
+     */
+    shipping?: number;
+    /**
+     * Total tax associated with the transaction
+     */
+    tax?: number;
+    /**
+     * Revenue ($) with discounts and coupons added in
+     */
+    value?: number;
+}

package/dist/types/objects.js

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