@gem-sdk/analytics 1.0.0-dev.9 → 2.0.0-dev.1

package/dist/esm/gemxql.js

@@ -1,62 +1,12 @@
-import { useQuery } from '@tanstack/react-query';
 import dayjs from 'dayjs';
-import quarterOfYear from 'dayjs/plugin/quarterOfYear';
-import timezone from 'dayjs/plugin/timezone';
-import utc from 'dayjs/plugin/utc';
-import { useState, useRef, useCallback, useEffect } from 'react';
-
-const ColumnSelectFragmentDoc = `
-    fragment ColumnSelect on Column {
-  dataType
-  displayName
-  name
-}
-    `;
-const TableDataSelectFragmentDoc = `
-    fragment TableDataSelect on TableData {
-  columns {
-    ...ColumnSelect
-  }
-  rows
-}
-    `;
-const GemXqlResultSelectFragmentDoc = `
-    fragment GemXQLResultSelect on GemxQLResult {
-  tableData {
-    ...TableDataSelect
-  }
-}
-    `;
-
-const GemxQlDocument = `
-    query GemxQL($input: String!) {
-  gemxQLQuery(query: $input) {
-    ...GemXQLResultSelect
-  }
-}
-    ${GemXqlResultSelectFragmentDoc}
-${TableDataSelectFragmentDoc}
-${ColumnSelectFragmentDoc}`;
-
-const useCustomGemXQlQuery = (variables, fetcher, options) => {
-    return useQuery({
-        queryKey: ['GemXQlCustom', variables],
-        queryFn: fetcher(GemxQlDocument, variables),
-        ...options,
-    });
-};
-useCustomGemXQlQuery.getKey = (variables) => ['GemXQlCustom', variables];
-
-const useGemxQlNamedQuery = ({ name, variables, fetcher }, options) => {
-    const document = GemxQlDocument.replace(/query\s+GemxQL\b/, `query ${name}`);
-    return useQuery({
-        queryKey: [name, variables],
-        queryFn: fetcher(document, variables),
-        retry: 0,
-        ...options,
-    });
-};
-useGemxQlNamedQuery.getKey = (name, variables) => [name, variables];
+import quarterOfYear from 'dayjs/plugin/quarterOfYear.js';
+import timezone from 'dayjs/plugin/timezone.js';
+import utc from 'dayjs/plugin/utc.js';
+import { useQuery } from '@tanstack/react-query';
+import { jsxs, Fragment, jsx } from 'react/jsx-runtime';
+import { createContext, useContext, useState, useRef, useCallback, useEffect } from 'react';
+import { create } from 'zustand';
+import '@shopify/polaris';
 
 const NONE_VALUE = 'None';
 const PLACEHOLDER_VALUE = '-';
@@ -94,42 +44,12 @@ var EAnalyticColumnKey;
     EAnalyticColumnKey["TRAFFIC_SOURCE_ITEMS"] = "traffic_source_items";
 })(EAnalyticColumnKey || (EAnalyticColumnKey = {}));
 
-var EAnalyticMode;
-(function (EAnalyticMode) {
-    EAnalyticMode["ALL_SESSION"] = "ALL_SESSION";
-    EAnalyticMode["FIRST_SESSION"] = "FIRST_SESSION";
-    EAnalyticMode["PAGE_ONLY"] = "PAGE_ONLY";
-})(EAnalyticMode || (EAnalyticMode = {}));
-
 var EAnalyticSource;
 (function (EAnalyticSource) {
     EAnalyticSource["SESSIONS"] = "sessions";
     EAnalyticSource["SALES"] = "sales";
 })(EAnalyticSource || (EAnalyticSource = {}));
 
-var EVisitorType;
-(function (EVisitorType) {
-    EVisitorType["NEW"] = "new";
-    EVisitorType["RETURNING"] = "returning";
-})(EVisitorType || (EVisitorType = {}));
-var EDeviceType;
-(function (EDeviceType) {
-    EDeviceType["DESKTOP"] = "desktop";
-    EDeviceType["MOBILE"] = "mobile";
-    EDeviceType["TABLET"] = "tablet";
-})(EDeviceType || (EDeviceType = {}));
-var ETrafficSourceType;
-(function (ETrafficSourceType) {
-    ETrafficSourceType["DIRECT"] = "direct";
-    ETrafficSourceType["EMAIL"] = "email";
-    ETrafficSourceType["REFERRAL"] = "referral";
-    ETrafficSourceType["ORGANIC_SOCIAL"] = "organic-social";
-    ETrafficSourceType["ORGANIC_SEARCH"] = "organic-search";
-    ETrafficSourceType["PAID_SOCIAL"] = "paid-social";
-    ETrafficSourceType["PAID_SEARCH"] = "paid-search";
-    ETrafficSourceType["SMS"] = "sms";
-})(ETrafficSourceType || (ETrafficSourceType = {}));
-
 var EComparisonOperator;
 (function (EComparisonOperator) {
     EComparisonOperator["EQ"] = "=";
@@ -561,29 +481,146 @@ const parse$4 = (query) => {
         .filter(Boolean);
 };
 
+const TRIM_DECIMAL_ZEROS_REGEX = /\.0+$/;
+const DEFAULT_DECIMALS = 2;
+const trimDecimalZeros = (number) => {
+    return `${number}`.replace(TRIM_DECIMAL_ZEROS_REGEX, '');
+};
+const cleanDecimal = (number, decimals = DEFAULT_DECIMALS) => {
+    return trimDecimalZeros(number.toFixed(decimals));
+};
+const numberWithCommas = (x) => {
+    return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',');
+};
+
+/**
+ * Utility function to calculate percentage and format it.
+ * @param part - The part value.
+ * @param total - The total value.
+ * @param decimals - The number of decimal places to format the percentage to.
+ * @returns The formatted percentage as a string.
+ */
+const PERCENTAGE_THRESHOLD = 0.005;
+const PERCENTAGE_THRESHOLD_STRING = '~0%';
+const calcPercentage = (part, total, decimals = DEFAULT_DECIMALS) => {
+    if (typeof part !== 'number' || !total)
+        return undefined;
+    if (part === 0)
+        return 0;
+    const percentage = (part / total) * 100;
+    return parseFloat(cleanDecimal(percentage, decimals));
+};
+const isLessThanThreshold = (percentage) => percentage > 0 && percentage < PERCENTAGE_THRESHOLD;
+const calcPercentageString = (part, total, decimals = 2) => {
+    const percentage = calcPercentage(part, total, decimals);
+    if (typeof percentage !== 'number')
+        return undefined;
+    if (isLessThanThreshold(percentage)) {
+        return PERCENTAGE_THRESHOLD_STRING;
+    }
+    return `${percentage}%`;
+};
+
 dayjs.extend(utc);
 dayjs.extend(timezone);
 dayjs.extend(quarterOfYear);
 let tz = 'UTC';
-const DEFAULT_DATE_FORMAT = 'YYYY-MM-DD HH:mm:ss';
 function getInitialTimezone() {
     return tz;
 }
-function setTz(value) {
-    tz = value;
-    dayjs.tz.setDefault(value);
-}
 const dayjsTz = (date) => {
     if (!date)
         return dayjs().tz(tz);
     return dayjs(date).tz(tz);
 };
-const convertDateToTz = (date) => {
-    if (!date)
-        return dayjs.tz(dayjs().format(DEFAULT_DATE_FORMAT), tz);
-    return dayjs.tz(dayjs(date).format(DEFAULT_DATE_FORMAT), tz);
+
+var AnalyticInterval;
+(function (AnalyticInterval) {
+    AnalyticInterval["DAY"] = "DAY";
+    AnalyticInterval["HOUR"] = "HOUR";
+    AnalyticInterval["MONTH"] = "MONTH";
+    AnalyticInterval["QUARTER"] = "QUARTER";
+    AnalyticInterval["WEEK"] = "WEEK";
+    AnalyticInterval["YEAR"] = "YEAR";
+})(AnalyticInterval || (AnalyticInterval = {}));
+const SECONDS_IN_MINUTE = 60;
+const SECONDS_IN_HOUR = SECONDS_IN_MINUTE * SECONDS_IN_MINUTE;
+const getTimeDurationLabel = (valueInSeconds) => {
+    let data = valueInSeconds;
+    if (!Number.isFinite(valueInSeconds) || valueInSeconds == null) {
+        data = 0;
+    }
+    const fixedValue = cleanDecimal(data);
+    if (data >= SECONDS_IN_HOUR) {
+        const hours = Math.floor(data / SECONDS_IN_HOUR);
+        const minutes = Math.floor((data % SECONDS_IN_HOUR) / SECONDS_IN_MINUTE);
+        const seconds = Math.floor(data % SECONDS_IN_MINUTE);
+        return `${hours}h ${minutes}m ${seconds}s`;
+    }
+    else if (data >= SECONDS_IN_MINUTE) {
+        const minutes = Math.floor(data / SECONDS_IN_MINUTE);
+        const seconds = Math.floor(data % SECONDS_IN_MINUTE);
+        return `${minutes}m ${seconds}s`;
+    }
+    else {
+        return `${fixedValue}s`;
+    }
+};
+const getFormattedByInterval = (value, interval, options) => {
+    if (!value)
+        return '';
+    const optionFormat = options?.isExpandDetail
+        ? {
+            formatHouse: 'MMM D, h:mm A',
+            formatDay: 'MMM D, YYYY',
+            formatMonth: 'MMM YYYY',
+            formatYear: 'MMM YYYY',
+        }
+        : {
+            formatHouse: 'h A',
+            formatDay: 'MMM D',
+            formatMonth: 'MMM YYYY',
+            formatYear: 'YYYY',
+        };
+    switch (interval) {
+        case AnalyticInterval.HOUR:
+            return dayjsTz(value).format(optionFormat.formatHouse);
+        case AnalyticInterval.DAY:
+        case AnalyticInterval.WEEK:
+            return dayjsTz(value).format(optionFormat.formatDay);
+        case AnalyticInterval.MONTH:
+            return dayjsTz(value).format(optionFormat.formatMonth);
+        case AnalyticInterval.QUARTER: {
+            const d = dayjsTz(value);
+            return `Q${d.quarter()} ${d.format('YYYY')}`;
+        }
+        case AnalyticInterval.YEAR:
+            return dayjsTz(value).format(optionFormat.formatYear);
+    }
+    return dayjsTz(value).format(optionFormat.formatMonth);
 };
 
+var TemplateType;
+(function (TemplateType) {
+    TemplateType["ALL"] = "all";
+    TemplateType["HOME"] = "index";
+    TemplateType["COLLECTION"] = "collection";
+    TemplateType["COLLECTION_LIST"] = "collection-list";
+    TemplateType["PRODUCT"] = "product";
+    TemplateType["ARTICLE"] = "article";
+    TemplateType["PAGE"] = "page";
+    TemplateType["CART"] = "cart";
+    TemplateType["SEARCH"] = "search";
+    TemplateType["NOT_FOUND"] = "404";
+    TemplateType["BLOG"] = "blog";
+    TemplateType["PASSWORD"] = "password";
+    TemplateType["CONTACT"] = "contact";
+    TemplateType["GIF_CART"] = "gif-cart";
+    TemplateType["ACCOUNT"] = "account";
+    TemplateType["CHECKOUT"] = "checkout";
+    TemplateType["GIFT_CARD"] = "gift-card";
+})(TemplateType || (TemplateType = {}));
+
 const toDate = (value) => (typeof value === 'string' ? dayjsTz(value) : value);
 const isMidnight = (date) => date.hour() === 0 && date.minute() === 0;
 const formatDateForQuery = (date, isEndDay = false) => {
@@ -741,112 +778,6 @@ const extractColumnTypes = (response) => {
     return columnTypes;
 };
 
-const TRIM_DECIMAL_ZEROS_REGEX = /\.0+$/;
-const DEFAULT_DECIMALS = 2;
-const trimDecimalZeros = (number) => {
-    return `${number}`.replace(TRIM_DECIMAL_ZEROS_REGEX, '');
-};
-const cleanDecimal = (number, decimals = DEFAULT_DECIMALS) => {
-    return trimDecimalZeros(number.toFixed(decimals));
-};
-
-/**
- * Utility function to calculate percentage and format it.
- * @param part - The part value.
- * @param total - The total value.
- * @param decimals - The number of decimal places to format the percentage to.
- * @returns The formatted percentage as a string.
- */
-const PERCENTAGE_THRESHOLD = 0.005;
-const PERCENTAGE_THRESHOLD_STRING = '~0%';
-const calcPercentage = (part, total, decimals = DEFAULT_DECIMALS) => {
-    if (typeof part !== 'number' || !total)
-        return undefined;
-    if (part === 0)
-        return 0;
-    const percentage = (part / total) * 100;
-    return parseFloat(cleanDecimal(percentage, decimals));
-};
-const isLessThanThreshold = (percentage) => percentage > 0 && percentage < PERCENTAGE_THRESHOLD;
-const calcPercentageString = (part, total, decimals = 2) => {
-    const percentage = calcPercentage(part, total, decimals);
-    if (typeof percentage !== 'number')
-        return undefined;
-    if (isLessThanThreshold(percentage)) {
-        return PERCENTAGE_THRESHOLD_STRING;
-    }
-    return `${percentage}%`;
-};
-
-var AnalyticInterval;
-(function (AnalyticInterval) {
-    AnalyticInterval["DAY"] = "DAY";
-    AnalyticInterval["HOUR"] = "HOUR";
-    AnalyticInterval["MONTH"] = "MONTH";
-    AnalyticInterval["QUARTER"] = "QUARTER";
-    AnalyticInterval["WEEK"] = "WEEK";
-    AnalyticInterval["YEAR"] = "YEAR";
-})(AnalyticInterval || (AnalyticInterval = {}));
-function numberWithCommas(x) {
-    return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',');
-}
-const SECONDS_IN_MINUTE = 60;
-const SECONDS_IN_HOUR = SECONDS_IN_MINUTE * SECONDS_IN_MINUTE;
-const getTimeDurationLabel = (valueInSeconds) => {
-    let data = valueInSeconds;
-    if (!Number.isFinite(valueInSeconds) || valueInSeconds == null) {
-        data = 0;
-    }
-    const fixedValue = cleanDecimal(data);
-    if (data >= SECONDS_IN_HOUR) {
-        const hours = Math.floor(data / SECONDS_IN_HOUR);
-        const minutes = Math.floor((data % SECONDS_IN_HOUR) / SECONDS_IN_MINUTE);
-        const seconds = Math.floor(data % SECONDS_IN_MINUTE);
-        return `${hours}h ${minutes}m ${seconds}s`;
-    }
-    else if (data >= SECONDS_IN_MINUTE) {
-        const minutes = Math.floor(data / SECONDS_IN_MINUTE);
-        const seconds = Math.floor(data % SECONDS_IN_MINUTE);
-        return `${minutes}m ${seconds}s`;
-    }
-    else {
-        return `${fixedValue}s`;
-    }
-};
-const getFormattedByInterval = (value, interval, options) => {
-    if (!value)
-        return '';
-    const optionFormat = options?.isExpandDetail
-        ? {
-            formatHouse: 'MMM D, h:mm A',
-            formatDay: 'MMM D, YYYY',
-            formatMonth: 'MMM YYYY',
-            formatYear: 'MMM YYYY',
-        }
-        : {
-            formatHouse: 'h A',
-            formatDay: 'MMM D',
-            formatMonth: 'MMM YYYY',
-            formatYear: 'YYYY',
-        };
-    switch (interval) {
-        case AnalyticInterval.HOUR:
-            return dayjsTz(value).format(optionFormat.formatHouse);
-        case AnalyticInterval.DAY:
-        case AnalyticInterval.WEEK:
-            return dayjsTz(value).format(optionFormat.formatDay);
-        case AnalyticInterval.MONTH:
-            return dayjsTz(value).format(optionFormat.formatMonth);
-        case AnalyticInterval.QUARTER: {
-            const d = dayjsTz(value);
-            return `Q${d.quarter()} ${d.format('YYYY')}`;
-        }
-        case AnalyticInterval.YEAR:
-            return dayjsTz(value).format(optionFormat.formatYear);
-    }
-    return dayjsTz(value).format(optionFormat.formatMonth);
-};
-
 const formatAnalyticDate = (dateString) => {
     if (!dateString)
         return 'None';
@@ -987,7 +918,291 @@ const createNumericRowReader = (row, mode = ERowReaderMode.DEFAULT) => (key) =>
     return 0;
 };
 
-const useAnalyticData = (getTextPrice) => {
+const ColumnSelectFragmentDoc = `
+    fragment ColumnSelect on Column {
+  dataType
+  displayName
+  name
+}
+    `;
+const TableDataSelectFragmentDoc = `
+    fragment TableDataSelect on TableData {
+  columns {
+    ...ColumnSelect
+  }
+  rows
+}
+    `;
+const GemXqlResultSelectFragmentDoc = `
+    fragment GemXQLResultSelect on GemxQLResult {
+  tableData {
+    ...TableDataSelect
+  }
+}
+    `;
+
+const GemxQlDocument = `
+    query GemxQL($input: String!) {
+  gemxQLQuery(query: $input) {
+    ...GemXQLResultSelect
+  }
+}
+    ${GemXqlResultSelectFragmentDoc}
+${TableDataSelectFragmentDoc}
+${ColumnSelectFragmentDoc}`;
+
+const useCustomGemXQlQuery = (variables, fetcher, options) => {
+    return useQuery({
+        queryKey: ['GemXQlCustom', variables],
+        queryFn: fetcher(GemxQlDocument, variables),
+        ...options,
+    });
+};
+useCustomGemXQlQuery.getKey = (variables) => ['GemXQlCustom', variables];
+
+const useGemxQlNamedQuery = ({ name, variables, fetcher }, options) => {
+    const document = GemxQlDocument.replace(/query\s+GemxQL\b/, `query ${name}`);
+    return useQuery({
+        queryKey: [name, variables],
+        queryFn: fetcher(document, variables),
+        retry: 0,
+        ...options,
+    });
+};
+useGemxQlNamedQuery.getKey = (name, variables) => [name, variables];
+
+var EMetricKey;
+(function (EMetricKey) {
+    EMetricKey["SESSION"] = "sessions";
+    EMetricKey["ORDERS"] = "orders";
+    EMetricKey["PAGE_VIEWS"] = "pageviews";
+    EMetricKey["VISITORS"] = "visitors";
+    EMetricKey["BOUNCE_RATE"] = "bounce_rate";
+    EMetricKey["CTR"] = "ctr";
+    EMetricKey["CONVERSION_RATE"] = "conversion_rate";
+    EMetricKey["AVG_TIME_ON_PAGE"] = "average_time_on_page";
+    EMetricKey["ADDED_TO_CART"] = "added_to_cart";
+    EMetricKey["ADD_TO_CART_RATE"] = "added_to_cart_rate";
+    EMetricKey["REACHED_CHECKOUT"] = "sessions_that_reached_checkout";
+    EMetricKey["COMPLETE_CHECKOUT"] = "sessions_that_completed_checkout";
+    EMetricKey["CART_ADDITION"] = "sessions_with_cart_additions";
+    EMetricKey["AOV"] = "aov";
+    EMetricKey["REVENUE"] = "revenue";
+    EMetricKey["RPV"] = "revenue_per_visitor";
+    EMetricKey["VISITOR_ITEMS"] = "visitor_items";
+    EMetricKey["DEVICE_ITEMS"] = "device_items";
+    EMetricKey["TRAFFIC_SOURCE_ITEMS"] = "traffic_source_items";
+    EMetricKey["PAGE_PATH_ANALYSIS"] = "PAGE_PATH_ANALYSIS";
+})(EMetricKey || (EMetricKey = {}));
+
+({
+    [EMetricKey.SESSION]: {
+        title: 'Sessions',
+        content: 'A period during which a visitor interacts with your online store',
+    },
+    [EMetricKey.VISITORS]: {
+        title: 'Visitors',
+        content: 'Number of unique individuals who visit your online store',
+    },
+    [EMetricKey.BOUNCE_RATE]: {
+        title: 'Bounce rate',
+        content: 'Percentage of visitors who leave your store after viewing only one page, without interacting further',
+        formula: (jsxs(Fragment, { children: [jsx("span", { className: "formula-variable", children: "Bounce rate" }), jsx("span", { children: " = " }), jsx("span", { className: "formula-input", children: "sessions with a pageview" }), jsx("span", { className: "formula-operator", children: " / " }), jsx("span", { className: "formula-input", children: "total sessions" })] })),
+    },
+    [EMetricKey.CTR]: {
+        title: 'Click-through rate',
+        content: 'Percentage of clicks to open new page, compared to the number of times the page was viewed',
+        formula: (jsxs(Fragment, { children: [jsx("span", { className: "formula-variable", children: "Click-through rate" }), jsx("span", { children: " = " }), jsx("span", { className: "formula-input", children: "total clicks" }), jsx("span", { className: "formula-operator", children: " / " }), jsx("span", { className: "formula-input", children: "total pageviews" })] })),
+    },
+    [EMetricKey.AVG_TIME_ON_PAGE]: {
+        title: 'Average time on page',
+        content: 'Average duration that visitors spend on a page before clicking to open new page',
+        formula: (jsxs(Fragment, { children: [jsx("span", { className: "formula-variable", children: "Average time on page" }), jsx("span", { children: " = " }), jsx("span", { className: "formula-input", children: "total time on page" }), jsx("span", { className: "formula-operator", children: " / " }), jsx("span", { className: "formula-input", children: "(total pageviews - total exits)" })] })),
+    },
+    [EMetricKey.PAGE_VIEWS]: {
+        title: 'Pageviews',
+        content: 'Number of times a page on your online store has been viewed by visitors',
+    },
+    [EMetricKey.RPV]: {
+        title: 'Revenue per visitor',
+        content: 'Average revenue generated from each visitor',
+        formula: (jsxs(Fragment, { children: [jsx("span", { className: "formula-variable", children: "Revenue per visitor" }), jsx("span", { children: " = " }), jsx("span", { className: "formula-input", children: "total revenue" }), jsx("span", { className: "formula-operator", children: " / " }), jsx("span", { className: "formula-input", children: "total visitors" })] })),
+    },
+    [EMetricKey.ADDED_TO_CART]: {
+        title: 'Added to cart',
+        content: 'Total number of the event when a customer adds a product to their cart on your online store',
+    },
+    [EMetricKey.REACHED_CHECKOUT]: {
+        title: 'Sessions that reached checkout',
+        content: 'Sessions in your online store in which the checkout page was reached',
+    },
+    [EMetricKey.COMPLETE_CHECKOUT]: {
+        title: 'Sessions that completed checkout',
+        content: 'Sessions in your online store in which a purchase was completed',
+    },
+    [EMetricKey.ORDERS]: {
+        title: 'Orders',
+        content: 'Number of orders that went through this pages',
+    },
+    [EMetricKey.CONVERSION_RATE]: {
+        title: 'Conversion rate',
+        content: 'Percentage of online store sessions that completed an order',
+        formula: (jsxs(Fragment, { children: [jsx("span", { className: "formula-variable", children: "Conversion rate" }), jsx("span", { children: " = " }), jsx("span", { className: "formula-input", children: "sessions that completed checkout" }), jsx("span", { className: "formula-operator", children: " / " }), jsx("span", { className: "formula-input", children: "total sessions" })] })),
+    },
+    [EMetricKey.AOV]: {
+        title: 'Average order value',
+        content: 'Average value of orders placed in your online store',
+        formula: (jsxs(Fragment, { children: [jsx("span", { className: "formula-variable", children: "Average order value" }), jsx("span", { children: " = " }), jsx("span", { className: "formula-input", children: "total revenue" }), jsx("span", { className: "formula-operator", children: " / " }), jsx("span", { className: "formula-input", children: "total orders" })] })),
+    },
+    [EMetricKey.REVENUE]: {
+        title: 'Revenue',
+        content: 'Total income generated from sales after discounts',
+        formula: (jsxs(Fragment, { children: [jsx("span", { className: "formula-variable", children: "Revenue" }), jsx("span", { children: " = " }), jsx("span", { className: "formula-input", children: "gross sales" }), jsx("span", { className: "formula-operator", children: " - " }), jsx("span", { className: "formula-input", children: "discounts" })] })),
+    },
+    [EMetricKey.ADD_TO_CART_RATE]: {
+        title: 'Add to cart rate',
+        content: 'Percentage of sessions in which the customer added item to the cart',
+        formula: (jsxs(Fragment, { children: [jsx("span", { className: "formula-variable", children: "Added to cart rate" }), jsx("span", { children: " = " }), jsx("span", { className: "formula-input", children: "sessions with cart additions" }), jsx("span", { className: "formula-operator", children: " / " }), jsx("span", { className: "formula-input", children: "total sessions" })] })),
+    },
+    [EMetricKey.CART_ADDITION]: {
+        title: 'Sessions with cart additions',
+        content: 'Sessions in your online store in which a visitor added item to the cart',
+    },
+    [EMetricKey.VISITOR_ITEMS]: {
+        title: 'Sessions by visitor type',
+        content: '<p>Numbers of new and returning visitors</p>',
+        contentList: [
+            'New visitor: who accesses your store for the first time after GemX installation',
+            'Returning visitor: who comes back to your store after GemX installation',
+        ],
+    },
+    [EMetricKey.DEVICE_ITEMS]: {
+        title: 'Sessions by device type',
+        content: `Sessions in your online store by the visitor's device type`,
+    },
+    [EMetricKey.TRAFFIC_SOURCE_ITEMS]: {
+        title: 'Sessions by traffic source',
+        content: 'Sessions on your page by where visitors come from',
+    },
+    [EMetricKey.PAGE_PATH_ANALYSIS]: {
+        title: 'Journey analysis',
+        content: 'Journey analysis tracks the journey from entry to purchase and shows where visitors leave the store',
+    },
+});
+
+var EAnalyticMode;
+(function (EAnalyticMode) {
+    EAnalyticMode["ALL_SESSION"] = "ALL_SESSION";
+    EAnalyticMode["FIRST_SESSION"] = "FIRST_SESSION";
+    EAnalyticMode["PAGE_ONLY"] = "PAGE_ONLY";
+})(EAnalyticMode || (EAnalyticMode = {}));
+
+var EVisitorType;
+(function (EVisitorType) {
+    EVisitorType["NEW"] = "new";
+    EVisitorType["RETURNING"] = "returning";
+})(EVisitorType || (EVisitorType = {}));
+var EDeviceType;
+(function (EDeviceType) {
+    EDeviceType["DESKTOP"] = "desktop";
+    EDeviceType["MOBILE"] = "mobile";
+    EDeviceType["TABLET"] = "tablet";
+})(EDeviceType || (EDeviceType = {}));
+var ETrafficSourceType;
+(function (ETrafficSourceType) {
+    ETrafficSourceType["DIRECT"] = "direct";
+    ETrafficSourceType["EMAIL"] = "email";
+    ETrafficSourceType["REFERRAL"] = "referral";
+    ETrafficSourceType["ORGANIC_SOCIAL"] = "organic-social";
+    ETrafficSourceType["ORGANIC_SEARCH"] = "organic-search";
+    ETrafficSourceType["PAID_SOCIAL"] = "paid-social";
+    ETrafficSourceType["PAID_SEARCH"] = "paid-search";
+    ETrafficSourceType["SMS"] = "sms";
+})(ETrafficSourceType || (ETrafficSourceType = {}));
+
+/**
+ * Pricing enums mirrored from the host app (`~/modules/pricing/types`).
+ *
+ * They are duplicated here so the SDK no longer needs to import the host's
+ * pricing module directly. The host can import these enums back from
+ * `@gem-sdk/analytics/types` to build the value passed to `PathAnalysisConfigProvider`,
+ * which guarantees the string values stay in sync on both sides.
+ */
+var IPlanKey;
+(function (IPlanKey) {
+    /**
+     * @deprecated This plan is available for users installed before release 1.3.0.
+     */
+    IPlanKey["CONTENT_TESTING"] = "content-testing";
+    IPlanKey["PAGE_OPT"] = "page-optimize";
+    IPlanKey["FUNNEL_OPT"] = "funnel-optimize";
+    IPlanKey["PROFIT_OPT"] = "profit-optimize";
+    // Trial plans
+    IPlanKey["TRIAL_PAGE_OPT"] = "trial-page-optimize";
+    IPlanKey["TRIAL_FUNNEL_OPT"] = "trial-funnel-optimize";
+    IPlanKey["TRIAL_PROFIT_OPT"] = "trial-profit-optimize";
+})(IPlanKey || (IPlanKey = {}));
+var IShopPlanState;
+(function (IShopPlanState) {
+    IShopPlanState["TRIAL_PAGE_OPT"] = "TRIAL_PAGE_OPT";
+    IShopPlanState["TRIAL_FUNNEL_OPT"] = "TRIAL_FUNNEL_OPT";
+    IShopPlanState["TRIAL_PROFIT_OPT"] = "TRIAL_PROFIT_OPT";
+    IShopPlanState["ACTIVE_PAGE_OPT"] = "ACTIVE_PAGE_OPT";
+    IShopPlanState["ACTIVE_FUNNEL_OPT"] = "ACTIVE_FUNNEL_OPT";
+    IShopPlanState["ACTIVE_PROFIT_OPT"] = "ACTIVE_PROFIT_OPT";
+    IShopPlanState["LOADING_PLAN"] = "LOADING_PLAN";
+    IShopPlanState["TRIAL_EXPIRED"] = "TRIAL_EXPIRED";
+    IShopPlanState["ACTIVE_PAGE_OPT_AND_TRIAL_PAGE_OPT"] = "ACTIVE_PAGE_OPT_AND_TRIAL_PAGE_OPT";
+    IShopPlanState["ACTIVE_PAGE_OPT_AND_TRIAL_FUNNEL_OPT"] = "ACTIVE_PAGE_OPT_AND_TRIAL_FUNNEL_OPT";
+    IShopPlanState["ACTIVE_FUNNEL_OPT_AND_TRIAL_FUNNEL_OPT"] = "ACTIVE_FUNNEL_OPT_AND_TRIAL_FUNNEL_OPT";
+})(IShopPlanState || (IShopPlanState = {}));
+
+var ICampaignType;
+(function (ICampaignType) {
+    // CONTENT = 'CONTENT',
+    ICampaignType["PRICE"] = "PRICE";
+    ICampaignType["TEMPLATE"] = "TEMPLATE";
+    ICampaignType["TEMPLATE_BUNDLE"] = "TEMPLATE_BUNDLE";
+    // THEME = 'THEME',
+})(ICampaignType || (ICampaignType = {}));
+
+[
+    { value: EVisitorType.NEW, label: 'New' },
+    { value: EVisitorType.RETURNING, label: 'Returning' },
+];
+[
+    { value: EDeviceType.DESKTOP, label: 'Desktop' },
+    { value: EDeviceType.TABLET, label: 'Tablet' },
+    { value: EDeviceType.MOBILE, label: 'Mobile' },
+];
+[
+    { value: ETrafficSourceType.DIRECT, label: 'Direct' },
+    { value: ETrafficSourceType.EMAIL, label: 'Email' },
+    { value: ETrafficSourceType.REFERRAL, label: 'Referral' },
+    { value: ETrafficSourceType.ORGANIC_SOCIAL, label: 'Organic social' },
+    { value: ETrafficSourceType.ORGANIC_SEARCH, label: 'Organic search' },
+    { value: ETrafficSourceType.PAID_SOCIAL, label: 'Paid social' },
+    { value: ETrafficSourceType.PAID_SEARCH, label: 'Paid search' },
+    { value: ETrafficSourceType.SMS, label: 'SMS' },
+];
+
+create((set) => ({
+    currencyRates: null,
+    setCurrencyRates: (rates) => set({ currencyRates: rates }),
+}));
+
+const ConvertMoneyContext = createContext({
+    getTextPrice: (price) => {
+        if (typeof price === 'string')
+            return price;
+        return `${price ?? 0}`;
+    },
+});
+const useConvertMoneyContext = () => useContext(ConvertMoneyContext);
+
+const useAnalyticData = ({ getTextPrice: getTextPriceParam, } = {}) => {
+    const { getTextPrice: getTextPriceCtx } = useConvertMoneyContext();
+    const getTextPrice = getTextPriceParam ?? getTextPriceCtx;
     const formatData = ({ value, formatter, name }) => {
         return formatAnalyticData({ value, formatter, getTextPrice, name });
     };
@@ -1010,8 +1225,9 @@ const useAnalyticData = (getTextPrice) => {
 var GPaginationDirection;
 (function (GPaginationDirection) {
     GPaginationDirection["NEXT"] = "NEXT";
-    GPaginationDirection["PREV"] = "PREV";
+    GPaginationDirection["PREVIOUS"] = "PREVIOUS";
 })(GPaginationDirection || (GPaginationDirection = {}));
+
 const useGemXQlPagination = ({ resetKey, itemsPerPage, }) => {
     const [currentPage, setCurrentPage] = useState(1);
     const previousResetKeyRef = useRef();
@@ -1043,4 +1259,4 @@ const useGemXQlPagination = ({ resetKey, itemsPerPage, }) => {
     return { currentPage: effectivePage, offset, buildPagination };
 };
 
-export { AnalyticInterval, CLAUSE_KEYWORDS, CLAUSE_KEYWORD_BOUNDARY, COMPARE_PREFIX, COMPARE_SUFFIX, COMPARE_TOTALS_SUFFIX, ColumnSelectFragmentDoc, DATE_QUERY_FORMAT, DEFAULT_QUERY_LIMIT, EAnalyticColumnKey, EAnalyticDataType, EAnalyticMode, EAnalyticSource, EComparisonOperator, EDeviceType, EFilterField, EGroupOperator, EGroupWithClause, EOperatorField, EOrderDirectionType, EPageDimension, EPageField, EPageMetric, ERowReaderMode, ETimeDimension, ETrafficSourceType, EVisitorType, GPaginationDirection, GemXqlResultSelectFragmentDoc, GemxQlDocument, NONE_VALUE, OPERATOR_IS, OPERATOR_IS_ONE_OF, PLACEHOLDER_VALUE, ROW_READER_MODE_CONFIG, TOTALS_SUFFIX, TableDataSelectFragmentDoc, build$a as buildConditionQuery, buildExtraCondition, buildExtraConditions, build$9 as buildFromQuery, buildGemXQlQuery, build$8 as buildGroupQuery, build$7 as buildLimitQuery, build$6 as buildModeQuery, build$5 as buildOffsetQuery, build$4 as buildOrderByQuery, build$3 as buildShowQuery, build$2 as buildTimeQuery, build$1 as buildTimeSeriesQuery, build as buildTimezoneQuery, buildVersionIdCondition, convertDateToTz, createNumericRowReader, dayjsTz, extractColumnTypes, extractQueryColumns, extractQueryRows, filterConfigs, formatAnalyticData, formatAnalyticDate, generateFilterConditions, getComparisonKey, getComparisonTotalsKey, getFirstMetricInOrderBy, getFormattedByInterval, getInitialTimezone, getTimeDimensionByDate, getTimeDurationLabel, getTotalsKey, hasMetricData, isValidQueryInput, numberWithCommas, parseBreakdownItems, parse$b as parseConditionQuery, parse$a as parseFromQuery, parse as parseGemXQlQuery, parse$9 as parseGroupQuery, parseJsonArray, parseJsonObject, parse$8 as parseLimitQuery, parse$7 as parseModeQuery, parse$6 as parseOffsetQuery, parse$5 as parseOrderByQuery, parsePageItems, parse$4 as parseShowQuery, parse$3 as parseTimeQuery, parse$2 as parseTimeSeriesQuery, parse$1 as parseTimezoneQuery, readNumeric, setTz, useAnalyticData, useCustomGemXQlQuery, useGemXQlPagination, useGemxQlNamedQuery };
+export { CLAUSE_KEYWORDS, CLAUSE_KEYWORD_BOUNDARY, COMPARE_PREFIX, COMPARE_SUFFIX, COMPARE_TOTALS_SUFFIX, ColumnSelectFragmentDoc, DATE_QUERY_FORMAT, DEFAULT_QUERY_LIMIT, EAnalyticColumnKey, EAnalyticDataType, EAnalyticSource, EComparisonOperator, EFilterField, EGroupOperator, EGroupWithClause, EOperatorField, EOrderDirectionType, EPageDimension, EPageField, EPageMetric, ERowReaderMode, ETimeDimension, GPaginationDirection, GemXqlResultSelectFragmentDoc, GemxQlDocument, NONE_VALUE, OPERATOR_IS, OPERATOR_IS_ONE_OF, PLACEHOLDER_VALUE, ROW_READER_MODE_CONFIG, TOTALS_SUFFIX, TableDataSelectFragmentDoc, build$a as buildConditionQuery, buildExtraCondition, buildExtraConditions, build$9 as buildFromQuery, buildGemXQlQuery, build$8 as buildGroupQuery, build$7 as buildLimitQuery, build$6 as buildModeQuery, build$5 as buildOffsetQuery, build$4 as buildOrderByQuery, build$3 as buildShowQuery, build$2 as buildTimeQuery, build$1 as buildTimeSeriesQuery, build as buildTimezoneQuery, buildVersionIdCondition, createNumericRowReader, extractColumnTypes, extractQueryColumns, extractQueryRows, filterConfigs, formatAnalyticData, formatAnalyticDate, generateFilterConditions, getComparisonKey, getComparisonTotalsKey, getFirstMetricInOrderBy, getTimeDimensionByDate, getTotalsKey, hasMetricData, isValidQueryInput, parseBreakdownItems, parse$b as parseConditionQuery, parse$a as parseFromQuery, parse as parseGemXQlQuery, parse$9 as parseGroupQuery, parseJsonArray, parseJsonObject, parse$8 as parseLimitQuery, parse$7 as parseModeQuery, parse$6 as parseOffsetQuery, parse$5 as parseOrderByQuery, parsePageItems, parse$4 as parseShowQuery, parse$3 as parseTimeQuery, parse$2 as parseTimeSeriesQuery, parse$1 as parseTimezoneQuery, readNumeric, useAnalyticData, useCustomGemXQlQuery, useGemXQlPagination, useGemxQlNamedQuery };