flowgrid-sdk 1.0.0

package/dist/lib/types/ecommerce.d.ts

@@ -0,0 +1,309 @@
+/**
+ * @fileoverview Type definitions for ecommerce tracking.
+ * @module types/ecommerce
+ */
+import { CurrencyCode, MoneyValue, TimeSeriesData } from './common';
+/**
+ * Product information for tracking.
+ */
+export interface Product {
+    /** Unique product identifier (SKU or ID) */
+    productId: string;
+    /** Product name */
+    name: string;
+    /** Product brand */
+    brand?: string;
+    /** Product category (can be nested with /) */
+    category?: string;
+    /** Product variant (size, color, etc.) */
+    variant?: string;
+    /** Unit price */
+    price: number;
+    /** Currency code */
+    currency: CurrencyCode | string;
+    /** Quantity */
+    quantity?: number;
+    /** Discount amount applied */
+    discount?: number;
+    /** Coupon code applied */
+    coupon?: string;
+    /** Position in a list (for impressions) */
+    position?: number;
+    /** Product URL */
+    url?: string;
+    /** Product image URL */
+    imageUrl?: string;
+    /** Product rating (0-5) */
+    rating?: number;
+    /** Number of reviews */
+    reviewCount?: number;
+    /** Stock status */
+    stockStatus?: 'in_stock' | 'out_of_stock' | 'limited' | 'preorder' | 'backorder';
+    /** Custom attributes */
+    attributes?: Record<string, string | number | boolean>;
+}
+/**
+ * Product list/collection information.
+ */
+export interface ProductList {
+    /** List identifier */
+    listId: string;
+    /** List name (e.g., "Search Results", "Featured Products") */
+    listName: string;
+    /** Products in the list */
+    products: Product[];
+}
+/**
+ * Cart item with product and quantity.
+ */
+export interface CartItem extends Product {
+    /** Quantity in cart */
+    quantity: number;
+    /** Line item total (price * quantity - discount) */
+    lineTotal: number;
+}
+/**
+ * Shopping cart state.
+ */
+export interface Cart {
+    /** Cart identifier */
+    cartId: string;
+    /** Items in cart */
+    items: CartItem[];
+    /** Cart subtotal (before discounts/shipping/tax) */
+    subtotal: number;
+    /** Total discount amount */
+    discountTotal: number;
+    /** Shipping cost */
+    shippingTotal?: number;
+    /** Tax amount */
+    taxTotal?: number;
+    /** Cart grand total */
+    total: number;
+    /** Currency code */
+    currency: CurrencyCode | string;
+    /** Number of items */
+    itemCount: number;
+    /** Applied coupon codes */
+    coupons?: string[];
+}
+/**
+ * Shipping information.
+ */
+export interface ShippingInfo {
+    /** Shipping method (e.g., "standard", "express", "overnight") */
+    method: string;
+    /** Shipping carrier */
+    carrier?: string;
+    /** Shipping cost */
+    cost: number;
+    /** Estimated delivery date */
+    estimatedDelivery?: string;
+    /** Tracking number */
+    trackingNumber?: string;
+}
+/**
+ * Payment information (non-sensitive).
+ */
+export interface PaymentInfo {
+    /** Payment method (e.g., "credit_card", "paypal", "apple_pay") */
+    method: string;
+    /** Payment provider */
+    provider?: string;
+    /** Last 4 digits of card (if applicable) */
+    cardLast4?: string;
+    /** Card brand (if applicable) */
+    cardBrand?: string;
+}
+/**
+ * Order/transaction information.
+ */
+export interface Order {
+    /** Unique order/transaction ID */
+    orderId: string;
+    /** Order items */
+    items: CartItem[];
+    /** Order subtotal */
+    subtotal: number;
+    /** Discount total */
+    discountTotal: number;
+    /** Shipping total */
+    shippingTotal: number;
+    /** Tax total */
+    taxTotal: number;
+    /** Order grand total */
+    total: number;
+    /** Currency code */
+    currency: CurrencyCode | string;
+    /** Shipping information */
+    shipping?: ShippingInfo;
+    /** Payment information */
+    payment?: PaymentInfo;
+    /** Applied coupon codes */
+    coupons?: string[];
+    /** Affiliate/referral code */
+    affiliation?: string;
+    /** Order status */
+    status?: 'pending' | 'processing' | 'shipped' | 'delivered' | 'cancelled' | 'refunded';
+    /** Order creation timestamp */
+    createdAt?: string;
+}
+/**
+ * Refund information.
+ */
+export interface Refund {
+    /** Original order ID */
+    orderId: string;
+    /** Refund ID */
+    refundId: string;
+    /** Items being refunded */
+    items?: CartItem[];
+    /** Refund amount */
+    amount: number;
+    /** Currency code */
+    currency: CurrencyCode | string;
+    /** Refund reason */
+    reason?: string;
+    /** Whether it's a full refund */
+    isFullRefund: boolean;
+}
+/**
+ * Checkout step identifiers.
+ */
+export type CheckoutStep = 'view_cart' | 'begin_checkout' | 'add_shipping_info' | 'add_payment_info' | 'review_order' | 'purchase';
+/**
+ * Checkout progress information.
+ */
+export interface CheckoutProgress {
+    /** Current step */
+    step: CheckoutStep;
+    /** Step number (1-indexed) */
+    stepNumber: number;
+    /** Cart state at this step */
+    cart: Cart;
+    /** Optional checkout option (e.g., selected shipping method) */
+    option?: string;
+}
+/**
+ * Promotion/coupon information.
+ */
+export interface Promotion {
+    /** Promotion ID */
+    promotionId: string;
+    /** Promotion name */
+    name: string;
+    /** Creative/banner name */
+    creative?: string;
+    /** Position of the promotion */
+    position?: string;
+    /** Discount type */
+    discountType?: 'percentage' | 'fixed' | 'free_shipping' | 'buy_x_get_y';
+    /** Discount value */
+    discountValue?: number;
+    /** Minimum order value */
+    minimumOrderValue?: number;
+    /** Valid from date */
+    validFrom?: string;
+    /** Valid until date */
+    validUntil?: string;
+}
+/**
+ * Wishlist item.
+ */
+export interface WishlistItem extends Product {
+    /** Date added to wishlist */
+    addedAt: string;
+    /** Priority level */
+    priority?: 'high' | 'medium' | 'low';
+    /** Notes */
+    notes?: string;
+}
+/**
+ * Wishlist state.
+ */
+export interface Wishlist {
+    /** Wishlist ID */
+    wishlistId: string;
+    /** Wishlist name */
+    name?: string;
+    /** Items in wishlist */
+    items: WishlistItem[];
+    /** Whether the wishlist is public */
+    isPublic?: boolean;
+}
+/**
+ * Revenue metrics for dashboards.
+ */
+export interface RevenueMetrics {
+    /** Total revenue */
+    totalRevenue: MoneyValue;
+    /** Average order value */
+    averageOrderValue: MoneyValue;
+    /** Number of orders */
+    orderCount: number;
+    /** Number of items sold */
+    itemsSold: number;
+    /** Refund total */
+    refundTotal: MoneyValue;
+    /** Net revenue (total - refunds) */
+    netRevenue: MoneyValue;
+    /** Revenue by time period */
+    revenueTimeSeries: TimeSeriesData;
+}
+/**
+ * Conversion funnel metrics.
+ */
+export interface ConversionFunnel {
+    /** Product views */
+    productViews: number;
+    /** Add to cart events */
+    addToCarts: number;
+    /** Checkout initiations */
+    checkoutStarts: number;
+    /** Completed purchases */
+    purchases: number;
+    /** View to cart rate */
+    viewToCartRate: number;
+    /** Cart to checkout rate */
+    cartToCheckoutRate: number;
+    /** Checkout to purchase rate */
+    checkoutToPurchaseRate: number;
+    /** Overall conversion rate */
+    overallConversionRate: number;
+}
+/**
+ * Product performance metrics.
+ */
+export interface ProductPerformance {
+    /** Product information */
+    product: Pick<Product, 'productId' | 'name' | 'category' | 'brand'>;
+    /** Number of views */
+    views: number;
+    /** Add to cart count */
+    addToCarts: number;
+    /** Purchase count */
+    purchases: number;
+    /** Total revenue generated */
+    revenue: MoneyValue;
+    /** Conversion rate (views to purchases) */
+    conversionRate: number;
+    /** Cart abandonment rate */
+    cartAbandonmentRate: number;
+}
+/**
+ * Cart analytics.
+ */
+export interface CartAnalytics {
+    /** Total active carts */
+    activeCarts: number;
+    /** Average cart value */
+    averageCartValue: MoneyValue;
+    /** Cart abandonment rate */
+    abandonmentRate: number;
+    /** Average items per cart */
+    averageItemsPerCart: number;
+    /** Top abandoned products */
+    topAbandonedProducts: Array<Pick<Product, 'productId' | 'name'> & {
+        count: number;
+    }>;
+}

package/dist/lib/types/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @fileoverview Central export for all FlowGrid SDK types.
+ * @module types
+ */
+export * from './common';
+export * from './ecommerce';
+export * from './analytics';

package/dist/lib/utils/functions.d.ts

@@ -0,0 +1 @@
+export declare function _0x7777(): string;

package/package.json

@@ -0,0 +1,139 @@
+{
+  "name": "flowgrid-sdk",
+  "version": "1.0.0",
+  "description": "A TypeScript SDK for tracking user events, feature usage, experiments, and feature flags with Flowgrid.",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/lib/frameworks/react/index.d.ts",
+      "import": "./dist/lib/frameworks/react/index.mjs",
+      "require": "./dist/lib/frameworks/react/index.js"
+    },
+    "./vue": {
+      "types": "./dist/lib/frameworks/vue/index.d.ts",
+      "import": "./dist/lib/frameworks/vue/index.mjs",
+      "require": "./dist/lib/frameworks/vue/index.js"
+    },
+    "./nextjs": {
+      "types": "./dist/lib/frameworks/nextjs/index.d.ts",
+      "import": "./dist/lib/frameworks/nextjs/index.mjs",
+      "require": "./dist/lib/frameworks/nextjs/index.js"
+    },
+    "./nextjs/client": {
+      "types": "./dist/lib/frameworks/nextjs/client.d.ts",
+      "import": "./dist/lib/frameworks/nextjs/client.mjs",
+      "require": "./dist/lib/frameworks/nextjs/client.js"
+    },
+    "./nextjs/server": {
+      "types": "./dist/lib/frameworks/nextjs/server.d.ts",
+      "import": "./dist/lib/frameworks/nextjs/server.mjs",
+      "require": "./dist/lib/frameworks/nextjs/server.js"
+    },
+    "./nuxt": {
+      "types": "./dist/lib/frameworks/nuxt/index.d.ts",
+      "import": "./dist/lib/frameworks/nuxt/index.mjs",
+      "require": "./dist/lib/frameworks/nuxt/index.js"
+    },
+    "./node": {
+      "types": "./dist/lib/frameworks/node/index.d.ts",
+      "import": "./dist/lib/frameworks/node/index.mjs",
+      "require": "./dist/lib/frameworks/node/index.js"
+    },
+    "./analytics": {
+      "types": "./dist/lib/features/analytics/index.d.ts",
+      "import": "./dist/lib/features/analytics/index.mjs",
+      "require": "./dist/lib/features/analytics/index.js"
+    },
+    "./ecommerce": {
+      "types": "./dist/lib/features/ecommerce/index.d.ts",
+      "import": "./dist/lib/features/ecommerce/index.mjs",
+      "require": "./dist/lib/features/ecommerce/index.js"
+    },
+    "./core": {
+      "types": "./dist/lib/features/core/index.d.ts",
+      "import": "./dist/lib/features/core/index.mjs",
+      "require": "./dist/lib/features/core/index.js"
+    },
+    "./types": {
+      "types": "./dist/lib/types/index.d.ts",
+      "import": "./dist/lib/types/index.mjs",
+      "require": "./dist/lib/types/index.js"
+    }
+  },
+  "scripts": {
+    "build": "webpack --mode production && tsc --emitDeclarationOnly",
+    "build:browser": "webpack --config webpack.browser.config.js",
+    "build:all": "npm run build && npm run build:browser",
+    "build:types": "tsc --emitDeclarationOnly",
+    "test": "echo \"No tests specified\" && exit 0",
+    "lint": "echo \"No linting configured\" && exit 0",
+    "prepublishOnly": "npm run build:all"
+  },
+  "keywords": [
+    "sdk",
+    "analytics",
+    "tracking",
+    "flowgrid",
+    "events",
+    "feature-flags",
+    "experiments",
+    "ecommerce",
+    "product-analytics",
+    "react",
+    "vue",
+    "nextjs",
+    "nuxt",
+    "nodejs"
+  ],
+  "author": "Brandon Roulstone",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FrostXk9/flowgrid-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/FrostXk9/flowgrid-sdk/issues"
+  },
+  "homepage": "https://github.com/FrostXk9/flowgrid-sdk#readme",
+  "peerDependencies": {
+    "next": ">=13.0.0",
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0",
+    "vue": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.2.1",
+    "@types/react": "^18.0.0",
+    "react": "^18.3.1",
+    "ts-loader": "^9.5.1",
+    "typescript": "^5.9.2",
+    "vue": "^3.5.27",
+    "webpack": "^5.105.0",
+    "webpack-cli": "^6.0.1"
+  },
+  "engines": {
+    "node": ">=18.12.0"
+  }
+}