fast-simon-sdk 1.6.119 → 1.6.121

package/lib/utils/callbackArg.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeCallbackArg = void 0;
+/**
+ * Most SDK entry points take a single options object ({callback, ...}), but getAllCategories /
+ * getAllPopularProducts historically took a positional callback. Integrators reasonably guess the
+ * object form and get "e is not a function". This accepts either shape:
+ *   fn(cb)                       -> {callback: cb, options: {}}
+ *   fn({callback: cb, ...rest})  -> {callback: cb, options: {callback, ...rest}}
+ */
+var normalizeCallbackArg = function (arg) {
+    if (typeof arg === "function") {
+        return { callback: arg, options: {} };
+    }
+    if (arg && typeof arg === "object") {
+        return { callback: typeof arg.callback === "function" ? arg.callback : undefined, options: arg };
+    }
+    return { options: {} };
+};
+exports.normalizeCallbackArg = normalizeCallbackArg;
+//# sourceMappingURL=callbackArg.js.map

package/lib/utils/callbackArg.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"callbackArg.js","sourceRoot":"","sources":["../../src/utils/callbackArg.ts"],"names":[],"mappings":";;;AAMA;;;;;;GAMG;AACI,IAAM,oBAAoB,GAAG,UAChC,GAAuB;IAEvB,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE,CAAC;QAC5B,OAAO,EAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,EAAgB,EAAC,CAAC;IACtD,CAAC;IAED,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,EAAC,QAAQ,EAAE,OAAO,GAAG,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,EAAC,CAAC;IACnG,CAAC;IAED,OAAO,EAAC,OAAO,EAAE,EAAgB,EAAC,CAAC;AACvC,CAAC,CAAC;AAZW,QAAA,oBAAoB,wBAY/B"}

package/lib/utils/shopifyCustomerId.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns the logged-in Shopify customer ID, or undefined for a guest / non-Shopify.
+ *
+ * Reads window.ShopifyAnalytics.meta.page.customerId, which Shopify's own theme
+ * script populates on logged-in storefronts. Attached to /post_load reporting so
+ * browse events can be tied to a shopper across devices (RPI attribution).
+ */
+export declare function getShopifyCustomerId(): string | undefined;

package/lib/utils/shopifyCustomerId.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getShopifyCustomerId = getShopifyCustomerId;
+/**
+ * Returns the logged-in Shopify customer ID, or undefined for a guest / non-Shopify.
+ *
+ * Reads window.ShopifyAnalytics.meta.page.customerId, which Shopify's own theme
+ * script populates on logged-in storefronts. Attached to /post_load reporting so
+ * browse events can be tied to a shopper across devices (RPI attribution).
+ */
+function getShopifyCustomerId() {
+    var _a, _b, _c;
+    try {
+        var customerId = (_c = (_b = (_a = window === null || window === void 0 ? void 0 : window.ShopifyAnalytics) === null || _a === void 0 ? void 0 : _a.meta) === null || _b === void 0 ? void 0 : _b.page) === null || _c === void 0 ? void 0 : _c.customerId;
+        if (customerId != null) {
+            return customerId.toString();
+        }
+    }
+    catch (error) {
+        // Fail silently so the shopper experience isn't affected
+        console.warn("Unable to retrieve Shopify Customer ID:", error);
+    }
+    return undefined;
+}
+//# sourceMappingURL=shopifyCustomerId.js.map

package/lib/utils/shopifyCustomerId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shopifyCustomerId.js","sourceRoot":"","sources":["../../src/utils/shopifyCustomerId.ts"],"names":[],"mappings":";;AAOA,oDAYC;AAnBD;;;;;;GAMG;AACH,SAAgB,oBAAoB;;IAChC,IAAI,CAAC;QACD,IAAM,UAAU,GAAG,MAAA,MAAA,MAAC,MAAc,aAAd,MAAM,uBAAN,MAAM,CAAU,gBAAgB,0CAAE,IAAI,0CAAE,IAAI,0CAAE,UAAU,CAAC;QAC7E,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC;QACjC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,yDAAyD;QACzD,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC"}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/autocomplete.d.ts

@@ -0,0 +1,27 @@
+import { GTAGItem } from "./serp";
+export interface reportProductClickedAutocompleteProps {
+    id: string;
+    original_search_query: string;
+    h: string;
+    host: string;
+    q: string;
+    gtag_product_items?: GTAGItem[];
+}
+export interface reportCategoryClickedProps {
+    original_search_query: string;
+    id: string;
+    h: string;
+    host: string;
+    gtag_data?: any;
+}
+export interface reportTurbolinkClickedProps {
+    original_search_query: string;
+    h: string;
+    host: string;
+    gtag_data?: any;
+}
+export interface reportPopularSearchClicked {
+    q: string;
+    original_search_query: string;
+    gtag_data?: any;
+}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/autocomplete.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=autocomplete.js.map

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/autocomplete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"autocomplete.js","sourceRoot":"","sources":["../../src/@types/autocomplete.ts"],"names":[],"mappings":""}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/platfrom.d.ts

@@ -0,0 +1 @@
+export type Platform = "Shopify" | "BigCommerce" | "Magento" | "WooCommerce" | "Dynamics";

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/platfrom.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=platfrom.js.map

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/platfrom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platfrom.js","sourceRoot":"","sources":["../../src/@types/platfrom.ts"],"names":[],"mappings":""}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/recommendations.d.ts

@@ -0,0 +1,18 @@
+import { GTAGItem } from "./serp";
+export interface reportProductRecommendationsClicked {
+    pos: number;
+    from_product: string;
+    id: string;
+    rec?: number;
+    rec_src?: number;
+    gtag_product_items?: GTAGItem[];
+    widget_id?: string;
+}
+export interface reportProductsRecommendationsShown {
+    id: string;
+    related_sources?: string;
+    found_related?: number;
+    callback?: string;
+    gtag_product_items?: GTAGItem[];
+    st?: string | undefined;
+}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/recommendations.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=recommendations.js.map

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/recommendations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendations.js","sourceRoot":"","sources":["../../src/@types/recommendations.ts"],"names":[],"mappings":""}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/reporting.d.ts

@@ -0,0 +1,23 @@
+import { Platform } from "./platfrom";
+export interface SessionToken {
+    start: number;
+    lastActive: number;
+}
+export interface AppKey {
+    uuid: string;
+    storeID: number;
+}
+export interface ReportBaseProps extends AppKey {
+    userSession: string;
+    sessionToken: SessionToken;
+    cartToken: string;
+    site?: boolean;
+    platform: Platform;
+    segments?: boolean;
+    personalizationSegment?: string;
+}
+export interface FastSimonReportingProps {
+    uuid: string;
+    storeID: number;
+    platform: Platform;
+}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/reporting.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=reporting.js.map

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/reporting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporting.js","sourceRoot":"","sources":["../../src/@types/reporting.ts"],"names":[],"mappings":""}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/serp.d.ts

@@ -0,0 +1,138 @@
+interface BaseProps {
+    sort_by?: string;
+    narrow_by?: string;
+    narrow_by_filters?: string;
+    pagenum: number;
+    pp?: string;
+    sp?: string;
+    spv?: string;
+    products_per_page?: number;
+}
+export interface ReportSearchPreformedProps extends BaseProps {
+    original_search_query: string;
+    serp: string;
+    no_results?: boolean;
+    gtag_product_items?: GTAGItem[];
+    products?: string;
+    rescount?: number;
+    promo_tiles?: string;
+    gtag_product_promotions?: GTAGPromotionItem[];
+    gtag_has_narrow?: boolean | undefined;
+    landing_page?: boolean;
+}
+export interface ReportSearchPageViewedProps {
+    query: string;
+    totalResults: number;
+}
+export interface ReportCategoryPreformedProps extends BaseProps {
+    original_smart_navigation: string;
+    serp: string;
+    original_category_id: string;
+    gtag_product_items?: GTAGItem[];
+    products?: string;
+    rescount?: number;
+    promo_tiles?: string;
+    gtag_product_promotions?: GTAGPromotionItem[];
+    gtag_has_narrow?: boolean | undefined;
+    original_search_query?: string;
+}
+export interface ReportPopUpSeenFromSearch extends BaseProps {
+    original_search_query: string;
+    serp: string;
+    pos: number;
+    id: string;
+}
+export interface ReportPopUpSeenFromCategory extends BaseProps {
+    original_smart_navigation: string;
+    original_category_id: number;
+    pos: number;
+    id: string;
+}
+export interface ReportProductClickedSearchProps extends BaseProps {
+    id: string;
+    original_search_query: string;
+    pos: number;
+    rec?: number;
+    gtag_product_items?: GTAGItem[];
+    image_id?: string;
+    variant_id?: string;
+}
+export interface ReportProductClickedLandingPageProps extends BaseProps {
+    id: string;
+    pos: number;
+    lp_slug: string;
+    rec?: number;
+    gtag_product_items?: GTAGItem[];
+    image_id?: string;
+    variant_id?: string;
+}
+export interface ReportProductClickedCategoryProps extends BaseProps {
+    id: string;
+    original_smart_navigation: string;
+    original_category_id: string;
+    pos: number;
+    gtag_product_items?: GTAGItem[];
+    image_id?: string;
+    variant_id?: string;
+}
+export interface GTAGItem {
+    item_list_id: string;
+    item_list_name: string;
+    item_id: string | number;
+    item_name: string;
+    item_brand: string;
+    currency: string;
+    price: number;
+    index: number;
+    id: string;
+}
+export interface GTAGPromotionItem {
+    promotionCreativeName: string;
+    promotionId: string;
+    promotionName: string | number;
+    promotionIndex: string;
+    promotionTitle?: string;
+    Id?: string;
+}
+export interface ReportProductAddedToCart {
+    cart_product: string;
+    variant_id: string;
+    original_smart_navigation?: string;
+    original_category_id?: string;
+    original_search_query?: string;
+    cart?: number;
+    hover_time?: number;
+    pos?: number;
+    gtag_product_items?: GTAGItem[];
+    widget_id?: string;
+}
+export interface ProductHover extends BaseProps {
+    original_smart_navigation?: string;
+    original_category_id?: number;
+    query?: string;
+    pos: number;
+    id: string;
+    hover_time?: number;
+    original_search_query?: string;
+}
+export interface VariantHover extends BaseProps {
+    original_smart_navigation?: string;
+    original_category_id?: number;
+    query?: string;
+    pos: number;
+    id: string;
+    hover_time?: number;
+    variant_id?: string;
+    original_search_query?: string;
+}
+export interface ReportProductSwatchSwitchProps extends BaseProps {
+    id: string;
+    from_product: string;
+    pos: number;
+    original_search_query?: string;
+    original_smart_navigation?: string;
+    original_category_id?: string;
+    lp_slug?: string;
+}
+export type SourceType = "jssdk" | "sdkd" | "sdkm" | "tapcart" | "v1" | "v-next" | "v-next-ssr";
+export {};

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/serp.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=serp.js.map

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/serp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serp.js","sourceRoot":"","sources":["../../src/@types/serp.ts"],"names":[],"mappings":""}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/shopperAssistant.d.ts

@@ -0,0 +1,126 @@
+import { GTAGItem } from "./serp";
+export type ProductSource = 'tool:search' | 'tool:similar' | 'tool:shop-the-look' | 'ui:visual-search' | 'ui:similar';
+export interface SearchParams {
+    query: string;
+    price_range?: string;
+}
+export interface SimilarParams {
+    product_id: string | number;
+    image_id?: string | number;
+}
+export type ProductParameters = SearchParams | SimilarParams;
+export interface ProductInfoEntry {
+    /** Where this recommendation came from */
+    source: ProductSource;
+    /** All parameter sets the assistant/UI used to pick this product */
+    parameters_used: ProductParameters[];
+}
+/** Maps each recommended product ID to one or more info entries */
+export type ProductsInfo = Record<string, ProductInfoEntry[]>;
+export type AssistantProductSuggestRef = "example-question" | "user-message" | "similar-button" | "visual-search";
+export type AssistantRef = "floating-button" | "assistant-hint" | "ai-stylist-picks" | "navbar-button";
+/**
+ * up_type: 49
+ * Fired once when a chat session ends. Provides a full summary of the user's engagement.
+ */
+export interface ReportChatSessionEnded {
+    /** The Unix timestamp for when the user opened the chat. */
+    session_start: number;
+    /** A counter for how many times the user clicked the 'New Chat' button. */
+    new_chat_clicks: number;
+    /** The unique ID of the final response from the assistant in that session. */
+    request_id: string;
+    ref: AssistantRef;
+}
+/**
+ * up_type: 50
+ * Fired when a chat session starts. This is the first report sent when the user opens the chat.
+ */
+export interface ReportChatSessionStarted {
+    ref: AssistantRef;
+}
+/**
+ * up_type: 51
+ * Fired when the assistant returns a list of products in response to a user's query.
+ */
+export interface ReportChatSuggestedProducts {
+    /** Comma-separated list of the suggested product IDs */
+    products: string;
+    /** Per-product provenance details (should be passed as string) */
+    product_sources: ProductsInfo | string;
+    ref: AssistantRef;
+    mode: AssistantProductSuggestRef;
+    original_search_query: string;
+    serp: string;
+    chat_response_text: string;
+    /** ID of the assistant response that contained these suggestions */
+    request_id: string;
+}
+/**
+ * up_type: 52
+ * Fired when a user adds a product to their cart that was suggested by the assistant.
+ */
+export interface ReportAssistantProductAddedToCart {
+    /** The ID of the product that was added to the cart. */
+    id: string;
+    /** The specific variant ID of the product, if one was selected. */
+    variant_id?: string;
+    /** The assistant feature that originally suggested the product. */
+    ref: AssistantRef;
+    mode: ProductSource;
+    /** The 1-based index (position) of the product in the list of suggestions. */
+    pos: number;
+    /** The assistant query or product_id if suggested by similar styles **/
+    query: string;
+    /** The unique ID for the specific chat response that contained this suggestion. */
+    request_id: string;
+    /** GA4 item payload — fires a standard `add_to_cart` to the merchant's GA/GTM. */
+    gtag_product_items?: GTAGItem[];
+}
+/**
+ * up_type: 53
+ * Fired when a user clicks on a product that was suggested by the assistant.
+ */
+export interface ReportAssistantProductClicked {
+    /** The ID of the product that was clicked. */
+    id: string;
+    /** The specific variant ID of the product, if one was selected. */
+    variant_id?: string;
+    /** The assistant feature that originally suggested the product. */
+    ref: AssistantRef;
+    mode: ProductSource;
+    /** The 1-based index (position) of the product in the list of suggestions. */
+    pos: number;
+    /** The assistant query or product_id if suggested by similar styles **/
+    query: string;
+    /** The unique ID for the specific chat response that contained this suggestion. */
+    request_id: string;
+    /** GA4 item payload — fires a standard `select_item` to the merchant's GA/GTM. */
+    gtag_product_items?: GTAGItem[];
+}
+/**
+ * The page context where a hint was shown.
+ * Examples: "product:12345", "collection:456", "search:jeans"
+ */
+export type HintContext = `collection:${string}` | `search:${string}` | `product:${string}`;
+/** Source of the hint: AI-generated or merchant-defined rule */
+export type HintSource = 'rule' | 'ai';
+/** How the hint was triggered to appear */
+export type HintTrigger = 'delay' | 'exit_intent' | 'immediate';
+/** Shared payload for all hint report events (shown, clicked, dismissed) */
+export interface HintReportParams {
+    /** Page context: "product:12345", "collection:456", "search:jeans" */
+    hint_context: HintContext;
+    /** Whether the hint was AI-generated or from a merchant rule */
+    hint_source: HintSource;
+    /** The actual hint message shown */
+    hint_text: string;
+    /** How the hint was triggered to appear */
+    hint_trigger: HintTrigger;
+}
+/** up_type: 55 — Fired when a hint bubble is rendered and visible to the user. */
+export type ReportHintShown = HintReportParams;
+/** up_type: 56 — Fired when a user clicks on the hint bubble (opens the chat). */
+export type ReportHintClicked = HintReportParams;
+/** up_type: 57 — Fired when a user dismisses the hint by clicking the X button. */
+export type ReportHintDismissed = HintReportParams;

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/shopperAssistant.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shopperAssistant.js.map

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/shopperAssistant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shopperAssistant.js","sourceRoot":"","sources":["../../src/@types/shopperAssistant.ts"],"names":[],"mappings":""}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/viewportImpressions.d.ts

@@ -0,0 +1,34 @@
+import { ReportBaseProps } from "./reporting";
+export interface ImpressionMetadata {
+    elementID: string;
+    elementType: "product" | "promotile";
+    elementPosition: number;
+    query?: string;
+    categoryID?: string;
+    pagenum?: number;
+    sort_by?: string;
+    narrow_by?: string;
+}
+export interface ImpressionRecord extends ImpressionMetadata {
+    timestamp: number;
+    isReported: boolean;
+}
+export interface ViewportImpressionReport {
+    UUID: string;
+    store_id: number;
+    st: string;
+    session: number;
+    up_type: string;
+    page_load_timestamp: number;
+    request_timestamp: number;
+    viewport_products: Record<string, number>;
+    q?: string;
+    category_id?: string;
+    sort_by?: string;
+    narrow_by?: string;
+}
+export interface ReportViewportImpressionsProps extends ReportBaseProps {
+    impressions: ImpressionRecord[];
+    query?: string;
+    categoryID?: string;
+}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/viewportImpressions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=viewportImpressions.js.map

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/viewportImpressions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewportImpressions.js","sourceRoot":"","sources":["../../src/@types/viewportImpressions.ts"],"names":[],"mappings":""}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/visualDiscovery.d.ts

@@ -0,0 +1,75 @@
+import { GTAGItem } from "./serp";
+export declare enum AppReference {
+    POPUP = "popup",
+    WIDGET = "widget",
+    PDP = "pdp",
+    AUTOCOMPLETE = "ac"
+}
+/**
+ * Represents the details of a product added to the cart
+ */
+export interface ReportVisualProductAddedToCart {
+    id: string;
+    variant_id?: string;
+    original_smart_navigation?: string;
+    original_search_query?: string;
+    cart?: number;
+    cart_token?: string;
+    hover_time?: number;
+    pos: number;
+    type?: string;
+    gtag_product_items?: GTAGItem[];
+    ref?: string;
+}
+/**
+ * Represents a gallery image clicked event
+ */
+export interface ReportImageClickedFromGallery {
+    serp: string;
+    ref?: string;
+    type?: string;
+    products?: string;
+}
+/**
+ * Represents a discovery open event
+ */
+export interface ReportDiscoveryOpen {
+    ref?: string;
+}
+/**
+ * Represents details of a product visit triggered by discovery
+ */
+export interface ReportDiscoveryProductVisit {
+    cart_token?: string;
+    original_search_query?: string;
+    pos?: number;
+    id: string;
+    ref?: string;
+    type?: string;
+}
+/**
+ * Represent a visual search performed
+ */
+export interface ReportVisualSearchUsed {
+    image_id: string;
+    original_search_query: string;
+    products: string;
+    rescount: number;
+    ref: AppReference;
+    serp: string;
+    vs_method: string;
+    pagenum?: number;
+    page_load_to_serp_load_latency?: number;
+    qs?: string;
+}
+/**
+ * Represent a selected bounding box data - items and label
+ */
+export interface ReportBoundingBoxClicked {
+    id: string;
+    facet: string;
+    products: string;
+    rescount?: number;
+    type?: string;
+    ref: AppReference;
+}

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/visualDiscovery.js

@@ -0,0 +1,8 @@
+export var AppReference;
+(function (AppReference) {
+    AppReference["POPUP"] = "popup";
+    AppReference["WIDGET"] = "widget";
+    AppReference["PDP"] = "pdp";
+    AppReference["AUTOCOMPLETE"] = "ac";
+})(AppReference || (AppReference = {}));
+//# sourceMappingURL=visualDiscovery.js.map

package/node_modules/@fast-simon/fast-simon-reporting/lib/@types/visualDiscovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visualDiscovery.js","sourceRoot":"","sources":["../../src/@types/visualDiscovery.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,+BAAe,CAAA;IACf,iCAAiB,CAAA;IACjB,2BAAW,CAAA;IACX,mCAAmB,CAAA;AACvB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB"}