@levi-gemcommerce/analytics 1.0.0-dev.12 → 1.0.0-dev.14

package/dist/esm/gemxql.js

@@ -1,63 +1,10 @@
-import { useQuery } from '@tanstack/react-query';
 import dayjs from 'dayjs';
 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 { 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];
-
 const NONE_VALUE = 'None';
 const PLACEHOLDER_VALUE = '-';
 
@@ -94,42 +41,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,32 +478,123 @@ 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 dayjsTzToLocalTZ = (date) => {
-    if (!date)
-        return dayjs(dayjsTz().format(DEFAULT_DATE_FORMAT));
-    return dayjs(dayjsTz(date).format(DEFAULT_DATE_FORMAT));
+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 toDate = (value) => (typeof value === 'string' ? dayjsTz(value) : value);
@@ -746,112 +754,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';
@@ -992,6 +894,59 @@ const createNumericRowReader = (row, mode = ERowReaderMode.DEFAULT) => (key) =>
     return 0;
 };
 
+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];
+
 const useAnalyticData = (getTextPrice) => {
     const formatData = ({ value, formatter, name }) => {
         return formatAnalyticData({ value, formatter, getTextPrice, name });
@@ -1048,4 +1003,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, dayjsTzToLocalTZ, 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 };