flowgrid-sdk 1.2.0 → 1.3.0

package/dist/EXAMPLE.d.ts

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

package/dist/EXAMPLE.js

@@ -0,0 +1,55 @@
+import { FlowGrid } from "./lib/flowgrid";
+const fg = FlowGrid.init({
+    webId: "your_web_id",
+    apiKey: "your_api_key",
+    endpoint: "https://core.flow-grid.xyz"
+});
+const experiment = fg.experiments;
+experiment.define({
+    experimentId: "button_color_test",
+    name: "Button Color Test",
+    description: "Testing different button colors to improve conversion rates",
+    primaryMetric: "conversion_rate",
+    variants: [
+        { id: "blue", name: "Blue Button", weight: 50 },
+        { id: "green", name: "Green Button", weight: 50 }
+    ]
+});
+experiment.init([
+    {
+        id: "button_color_test",
+        variants: [
+            { id: "blue", weight: 50 },
+            { id: "green", weight: 50 }
+        ]
+    }
+]);
+const variant = experiment.variant("button_color_test");
+console.log(`User is in variant: ${variant}`);
+experiment.assign("button_color_test", "user_123", variant, "random");
+experiment.exposure("button_color_test", "user_123", variant);
+experiment.conversion("button_color_test", "user_123", variant, "signup");
+// const search = fg.search
+// const batch = [
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// 	"example",
+// ];
+// batch.forEach(async (query, index) => {
+// 	await search.query(query, 10, { userId: `user_${index}`, sessionId: `session_${index}` });
+// })
+//# sourceMappingURL=EXAMPLE.js.map

package/dist/EXAMPLE.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EXAMPLE.js","sourceRoot":"","sources":["../src/EXAMPLE.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC;IACxB,KAAK,EAAE,aAAa;IACpB,MAAM,EAAE,cAAc;IACtB,QAAQ,EAAE,4BAA4B;CACtC,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,EAAE,CAAC,WAAW,CAAC;AAElC,UAAU,CAAC,MAAM,CAAC;IACjB,YAAY,EAAE,mBAAmB;IACjC,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE,6DAA6D;IAC1E,aAAa,EAAE,iBAAiB;IAChC,QAAQ,EAAE;QACT,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,EAAE;QAC/C,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE;KACjD;CACD,CAAC,CAAC;AAEH,UAAU,CAAC,IAAI,CAAC;IACf;QACC,EAAE,EAAE,mBAAmB;QACvB,QAAQ,EAAE;YACT,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE;YAC1B,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE;SAC3B;KACD;CACD,CAAC,CAAC;AAEH,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AACxD,OAAO,CAAC,GAAG,CAAC,uBAAuB,OAAO,EAAE,CAAC,CAAC;AAE9C,UAAU,CAAC,MAAM,CAAC,mBAAmB,EAAE,UAAU,EAAE,OAAQ,EAAE,QAAQ,CAAC,CAAC;AACvE,UAAU,CAAC,QAAQ,CAAC,mBAAmB,EAAE,UAAU,EAAE,OAAQ,CAAC,CAAC;AAC/D,UAAU,CAAC,UAAU,CAAC,mBAAmB,EAAE,UAAU,EAAE,OAAQ,EAAE,QAAQ,CAAC,CAAC;AAE3E,2BAA2B;AAE3B,kBAAkB;AAClB,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,KAAK;AAEL,0CAA0C;AAC1C,8FAA8F;AAC9F,KAAK"}

package/dist/browser.d.ts

@@ -3,116 +3,59 @@
  * @module browser
  *
  * @description
- * Browser-friendly bundle for including FlowGrid SDK via script tag.
- * Works with vanilla HTML, WordPress, Shopify, and any website.
+ * Minimal script-tag facade over the unified FlowGrid SDK. Browser users get a
+ * tiny top-level API for the common path, while advanced users can call
+ * `FlowGrid.instance()` and use the full SDK namespaces.
  *
  * @example
  * ```html
  * <script src="https://cdn.flowgrid.com/sdk/v1/flowgrid.min.js"></script>
  * <script>
- *   flowgrid.init({
- *     webId: 'your-web-id',
- *     endpoint: 'api.flowgrid.com/v1',
- *     apiKey: 'your-api-key'
- *   });
- *
- *   // Track events
- *   flowgrid.track('button_click', { button: 'signup' });
- *   flowgrid.page();
- *   flowgrid.identify('user_123', { email: 'user@example.com' });
+ *   FlowGrid.init({ webId: 'your-web-id', apiKey: 'your-api-key' });
+ *   FlowGrid.track('button_click', { button: 'signup' });
+ *   FlowGrid.page();
+ *   FlowGrid.identify('user_123', { plan: 'pro' });
  * </script>
  * ```
  */
-interface BrowserConfig {
-    webId: string;
-    endpoint: string;
-    apiKey: string;
-    visitorId?: string;
-    autoTrack?: {
-        pageViews?: boolean;
-        sessions?: boolean;
-    };
-}
-declare class FlowGridBrowser {
-    private config;
-    private activation;
-    private trackFeature;
-    private experiment;
-    private pageViews;
-    private sessions;
-    private events;
-    private identifyModule;
-    private products;
-    private cart;
-    private checkout;
-    private purchases;
-    private sessionId;
-    private visitorId;
-    private identity;
-    /**
-     * Initialize FlowGrid SDK for browser use.
-     */
-    init(config: BrowserConfig): void;
-    /**
-     * Track a custom event.
-     */
-    track(eventName: string, properties?: Record<string, unknown>): Promise<void>;
-    /**
-     * Track a page view.
-     */
-    page(url?: string, title?: string): Promise<void>;
-    /**
-     * Identify a user.
-     */
-    identify(userId: string, traits?: Record<string, unknown>): Promise<void>;
-    /**
-     * Track product view.
-     */
-    productView(product: {
-        productId: string;
-        name: string;
-        price: number;
-        currency?: string;
-        category?: string;
-        brand?: string;
-    }): Promise<void>;
-    /**
-     * Track add to cart.
-     */
-    addToCart(product: {
-        productId: string;
-        name: string;
-        price: number;
+import { FlowGrid, FlowGridInitConfig } from "./lib/flowgrid";
+import type { ConsentCategory } from "./lib/client/transport";
+import type { Product } from "./lib/types";
+type BrowserProduct = Pick<Product, "productId" | "name" | "price"> & Partial<Product>;
+type BrowserOrder = {
+    orderId: string;
+    total: number;
+    currency?: Product["currency"];
+    items: Array<Pick<Product, "productId" | "name" | "price"> & Partial<Product> & {
         quantity: number;
-        currency?: string;
-    }, cartId?: string): Promise<void>;
-    /**
-     * Track purchase/conversion.
-     */
-    purchase(order: {
-        orderId: string;
-        total: number;
-        currency?: string;
-        items: Array<{
-            productId: string;
-            name: string;
-            price: number;
-            quantity: number;
-        }>;
-    }): Promise<void>;
-    /**
-     * Start a session (called automatically on init).
-     */
-    private startSession;
-    /**
-     * Get or create cart ID via identity manager storage.
-     */
-    private getOrCreateCartId;
-    /**
-     * Read UTM attribution from __flowgrid_* cookies
-     * set by track.js / flowgrid_oss_client_sdk.js.
-     */
-    private parseUTM;
+    }>;
+    subtotal?: number;
+    discountTotal?: number;
+    shippingTotal?: number;
+    taxTotal?: number;
+};
+type BrowserFacade = {
+    init(config: FlowGridInitConfig): FlowGrid;
+    instance(): FlowGrid | null;
+    reset(): void;
+    setConsent(consent: Partial<Record<ConsentCategory, boolean>>): void;
+    hasConsent(category: ConsentCategory): boolean;
+    autoTrack(options?: Parameters<FlowGrid["autoTrack"]>[0]): () => void;
+    track: FlowGrid["track"];
+    page: FlowGrid["page"];
+    identify: FlowGrid["identifyUser"];
+    experiment: FlowGrid["experiment"];
+    productView(product: BrowserProduct, properties?: Record<string, unknown>): ReturnType<FlowGrid["products"]["view"]>;
+    addToCart(product: BrowserProduct, quantity?: number, cartId?: string): ReturnType<FlowGrid["cart"]["add"]>;
+    purchase(order: BrowserOrder): ReturnType<FlowGrid["purchases"]["complete"]>;
+};
+declare const browserFlowGrid: BrowserFacade;
+declare global {
+    interface Window {
+        FlowGrid: BrowserFacade;
+        flowgrid: BrowserFacade;
+    }
 }
-declare const flowgridInstance: FlowGridBrowser;
-export default flowgridInstance;
+export { FlowGrid };
+export type { BrowserFacade, BrowserOrder, BrowserProduct };
+export default browserFlowGrid;

package/dist/browser.js

@@ -0,0 +1,102 @@
+/**
+ * @fileoverview FlowGrid SDK - Browser Bundle
+ * @module browser
+ *
+ * @description
+ * Minimal script-tag facade over the unified FlowGrid SDK. Browser users get a
+ * tiny top-level API for the common path, while advanced users can call
+ * `FlowGrid.instance()` and use the full SDK namespaces.
+ *
+ * @example
+ * ```html
+ * <script src="https://cdn.flowgrid.com/sdk/v1/flowgrid.min.js"></script>
+ * <script>
+ *   FlowGrid.init({ webId: 'your-web-id', apiKey: 'your-api-key' });
+ *   FlowGrid.track('button_click', { button: 'signup' });
+ *   FlowGrid.page();
+ *   FlowGrid.identify('user_123', { plan: 'pro' });
+ * </script>
+ * ```
+ */
+import { FlowGrid } from "./lib/flowgrid";
+function getInstance() {
+    const instance = FlowGrid.instance();
+    if (!instance) {
+        throw new Error("FlowGrid not initialized. Call FlowGrid.init() first.");
+    }
+    return instance;
+}
+function normalizeProduct(product) {
+    return {
+        ...product,
+        currency: product.currency ?? "USD",
+    };
+}
+function normalizeOrder(order) {
+    const currency = order.currency ?? "USD";
+    const items = order.items.map((item) => ({
+        ...item,
+        currency: item.currency ?? currency,
+        quantity: item.quantity,
+        lineTotal: item.price * item.quantity,
+    }));
+    const subtotal = order.subtotal ?? items.reduce((sum, item) => sum + item.lineTotal, 0);
+    return {
+        orderId: order.orderId,
+        items,
+        subtotal,
+        discountTotal: order.discountTotal ?? 0,
+        shippingTotal: order.shippingTotal ?? 0,
+        taxTotal: order.taxTotal ?? 0,
+        total: order.total,
+        currency,
+    };
+}
+const browserFlowGrid = {
+    init(config) {
+        return FlowGrid.init(config);
+    },
+    instance() {
+        return FlowGrid.instance();
+    },
+    reset() {
+        FlowGrid.reset();
+    },
+    setConsent(consent) {
+        FlowGrid.setConsent(consent);
+    },
+    hasConsent(category) {
+        return FlowGrid.hasConsent(category);
+    },
+    autoTrack(options) {
+        return getInstance().autoTrack(options);
+    },
+    track(eventName, properties, options) {
+        return getInstance().track(eventName, properties, options);
+    },
+    page(pathOrUrl, properties, options) {
+        return getInstance().page(pathOrUrl, properties, options);
+    },
+    identify(userId, traits, anonymousId) {
+        return getInstance().identifyUser(userId, traits, anonymousId);
+    },
+    experiment(experimentId, options) {
+        return getInstance().experiment(experimentId, options);
+    },
+    productView(product, properties) {
+        return getInstance().products.view(normalizeProduct(product), properties);
+    },
+    addToCart(product, quantity = 1, cartId) {
+        return getInstance().cart.add(normalizeProduct(product), quantity, cartId);
+    },
+    purchase(order) {
+        return getInstance().purchases.complete(normalizeOrder(order));
+    },
+};
+if (typeof window !== "undefined") {
+    window.FlowGrid = browserFlowGrid;
+    window.flowgrid = browserFlowGrid;
+}
+export { FlowGrid };
+export default browserFlowGrid;
+//# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,QAAQ,EAAsB,MAAM,gBAAgB,CAAC;AAiC9D,SAAS,WAAW;IAClB,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACrC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAuB;IAC/C,OAAO;QACL,GAAG,OAAO;QACV,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK;KACpC,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,KAAmB;IACzC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC;IACzC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACvC,GAAG,IAAI;QACP,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ;QACnC,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,SAAS,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ;KACtC,CAAC,CAAC,CAAC;IACJ,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAExF,OAAO;QACL,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,KAAK;QACL,QAAQ;QACR,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,CAAC;QACvC,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,CAAC;QACvC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,CAAC;QAC7B,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAkB;IACrC,IAAI,CAAC,MAAM;QACT,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,QAAQ;QACN,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED,KAAK;QACH,QAAQ,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;IAED,UAAU,CAAC,OAAO;QAChB,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,UAAU,CAAC,QAAQ;QACjB,OAAO,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,SAAS,CAAC,OAAO;QACf,OAAO,WAAW,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO;QAClC,OAAO,WAAW,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO;QACjC,OAAO,WAAW,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW;QAClC,OAAO,WAAW,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACjE,CAAC;IAED,UAAU,CAAC,YAAY,EAAE,OAAO;QAC9B,OAAO,WAAW,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED,WAAW,CAAC,OAAO,EAAE,UAAU;QAC7B,OAAO,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC;IAC5E,CAAC;IAED,SAAS,CAAC,OAAO,EAAE,QAAQ,GAAG,CAAC,EAAE,MAAM;QACrC,OAAO,WAAW,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED,QAAQ,CAAC,KAAK;QACZ,OAAO,WAAW,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACjE,CAAC;CACF,CAAC;AASF,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;IAClC,MAAM,CAAC,QAAQ,GAAG,eAAe,CAAC;IAClC,MAAM,CAAC,QAAQ,GAAG,eAAe,CAAC;AACpC,CAAC;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC;AAEpB,eAAe,eAAe,CAAC"}