@gem-sdk/analytics 1.0.0-dev.21 → 1.0.0-dev.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/dist/esm/api/graphql/fragments/pathAnalytic.generated.d.ts +25 -0
  2. package/dist/esm/components/CardPathAnalysis/CardJourneyAnalysis.d.ts +9 -0
  3. package/dist/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardAnalyticEmpty.d.ts +8 -0
  4. package/dist/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysis.d.ts +15 -0
  5. package/dist/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysisContent.d.ts +6 -0
  6. package/dist/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysisEmpty.d.ts +5 -0
  7. package/dist/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysisSkeleton.d.ts +1 -0
  8. package/dist/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysisWrapper.d.ts +13 -0
  9. package/dist/esm/components/CardPathAnalysis/components/CardPathAnalysis/index.d.ts +1 -0
  10. package/dist/esm/components/CardPathAnalysis/components/PathAnalysisChart.d.ts +8 -0
  11. package/dist/esm/components/CardPathAnalysis/components/index.d.ts +1 -0
  12. package/dist/esm/components/CardPathAnalysis/configs/index.d.ts +2 -0
  13. package/dist/esm/components/CardPathAnalysis/constants/index.d.ts +1 -0
  14. package/dist/esm/components/CardPathAnalysis/constants/path-analysis.d.ts +73 -0
  15. package/dist/esm/components/CardPathAnalysis/contexts/PathAnalysisConfigProvider.d.ts +23 -0
  16. package/dist/esm/components/CardPathAnalysis/contexts/PathAnalysisProvider.d.ts +59 -0
  17. package/dist/esm/components/CardPathAnalysis/contexts/index.d.ts +2 -0
  18. package/dist/esm/components/CardPathAnalysis/helpers/index.d.ts +2 -0
  19. package/dist/esm/components/CardPathAnalysis/helpers/metricHelpers.d.ts +16 -0
  20. package/dist/esm/components/CardPathAnalysis/helpers/pathAnalysis.d.ts +12 -0
  21. package/dist/esm/components/CardPathAnalysis/helpers/pathAnalysisChart.d.ts +17 -0
  22. package/dist/esm/components/CardPathAnalysis/helpers/treeUtils.d.ts +7 -0
  23. package/dist/esm/components/CardPathAnalysis/hooks/usePathAnalysisChart.d.ts +15 -0
  24. package/dist/esm/components/CardPathAnalysis/hooks/usePathAnalysisFunnel.d.ts +22 -0
  25. package/dist/esm/components/CardPathAnalysis/hooks/usePathAnalyticsMerger.d.ts +10 -0
  26. package/dist/esm/components/CardPathAnalysis/index.d.ts +5 -0
  27. package/dist/esm/components/CardPathAnalysis/stores/funnel-chart.d.ts +12 -0
  28. package/dist/esm/components/CardPathAnalysis/stores/index.d.ts +3 -0
  29. package/dist/esm/components/CardPathAnalysis/stores/path-analysis-campaign.d.ts +10 -0
  30. package/dist/esm/components/CardPathAnalysis/stores/path-analysis.d.ts +6 -0
  31. package/dist/esm/components/CardPathAnalysis/types/index.d.ts +1 -0
  32. package/dist/esm/components/CardPathAnalysis/types/path-analysis.d.ts +6 -0
  33. package/dist/esm/components/index.d.ts +1 -0
  34. package/dist/esm/gemxql.js +64 -1
  35. package/dist/esm/gemxql.mjs +64 -1
  36. package/dist/esm/hooks/useSearchParams.d.ts +1 -0
  37. package/dist/esm/index.js +21622 -108
  38. package/dist/esm/index.mjs +21622 -108
  39. package/dist/esm/modules/analytics/constants/index.d.ts +15 -0
  40. package/dist/esm/modules/analytics/index.d.ts +3 -0
  41. package/dist/esm/modules/analytics/types/index.d.ts +41 -0
  42. package/dist/esm/modules/analytics/utils/formatMetric.d.ts +8 -0
  43. package/dist/esm/modules/analytics/utils/getPAMetricValue.d.ts +3 -0
  44. package/dist/esm/modules/analytics/utils/index.d.ts +3 -0
  45. package/dist/esm/modules/analytics/utils/metric.d.ts +26 -0
  46. package/dist/esm/providers/ConvertMoneyProvider.d.ts +1 -1
  47. package/dist/esm/shared/charts/components/GPolarisViz/components/FunnelChartNext/components/TooltipWithPortal.d.ts +1 -1
  48. package/dist/esm/shared/charts/components/GPolarisViz/hooks/useRootContainer.d.ts +1 -1
  49. package/dist/esm/shared/components/GBox/GBox.d.ts +9 -0
  50. package/dist/esm/shared/components/GBox/index.d.ts +1 -0
  51. package/dist/esm/shared/components/GFeatureLocked/GFeatureLocked.d.ts +14 -0
  52. package/dist/esm/shared/components/GFeatureLocked/constants.d.ts +3 -0
  53. package/dist/esm/shared/components/GFeatureLocked/index.d.ts +2 -0
  54. package/dist/esm/shared/components/GFeatureLocked/types.d.ts +15 -0
  55. package/dist/esm/shared/components/index.d.ts +2 -0
  56. package/dist/esm/types/index.d.ts +1 -0
  57. package/dist/esm/types/metric.d.ts +20 -1
  58. package/dist/esm/types/pricing.d.ts +33 -0
  59. package/dist/esm/types/template.d.ts +19 -0
  60. package/dist/esm/types.js +39 -1
  61. package/dist/esm/types.mjs +39 -1
  62. package/dist/esm/utils/deep-copy.d.ts +1 -0
  63. package/dist/esm/utils/index.d.ts +2 -0
  64. package/dist/esm/utils/template-type.d.ts +2 -0
  65. package/dist/style.css +1 -1
  66. package/dist/umd/esm/api/graphql/fragments/pathAnalytic.generated.d.ts +25 -0
  67. package/dist/umd/esm/components/CardPathAnalysis/CardJourneyAnalysis.d.ts +9 -0
  68. package/dist/umd/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardAnalyticEmpty.d.ts +8 -0
  69. package/dist/umd/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysis.d.ts +15 -0
  70. package/dist/umd/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysisContent.d.ts +6 -0
  71. package/dist/umd/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysisEmpty.d.ts +5 -0
  72. package/dist/umd/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysisSkeleton.d.ts +1 -0
  73. package/dist/umd/esm/components/CardPathAnalysis/components/CardPathAnalysis/CardPathAnalysisWrapper.d.ts +13 -0
  74. package/dist/umd/esm/components/CardPathAnalysis/components/CardPathAnalysis/index.d.ts +1 -0
  75. package/dist/umd/esm/components/CardPathAnalysis/components/PathAnalysisChart.d.ts +8 -0
  76. package/dist/umd/esm/components/CardPathAnalysis/components/index.d.ts +1 -0
  77. package/dist/umd/esm/components/CardPathAnalysis/configs/index.d.ts +2 -0
  78. package/dist/umd/esm/components/CardPathAnalysis/constants/index.d.ts +1 -0
  79. package/dist/umd/esm/components/CardPathAnalysis/constants/path-analysis.d.ts +73 -0
  80. package/dist/umd/esm/components/CardPathAnalysis/contexts/PathAnalysisConfigProvider.d.ts +23 -0
  81. package/dist/umd/esm/components/CardPathAnalysis/contexts/PathAnalysisProvider.d.ts +59 -0
  82. package/dist/umd/esm/components/CardPathAnalysis/contexts/index.d.ts +2 -0
  83. package/dist/umd/esm/components/CardPathAnalysis/helpers/index.d.ts +2 -0
  84. package/dist/umd/esm/components/CardPathAnalysis/helpers/metricHelpers.d.ts +16 -0
  85. package/dist/umd/esm/components/CardPathAnalysis/helpers/pathAnalysis.d.ts +12 -0
  86. package/dist/umd/esm/components/CardPathAnalysis/helpers/pathAnalysisChart.d.ts +17 -0
  87. package/dist/umd/esm/components/CardPathAnalysis/helpers/treeUtils.d.ts +7 -0
  88. package/dist/umd/esm/components/CardPathAnalysis/hooks/usePathAnalysisChart.d.ts +15 -0
  89. package/dist/umd/esm/components/CardPathAnalysis/hooks/usePathAnalysisFunnel.d.ts +22 -0
  90. package/dist/umd/esm/components/CardPathAnalysis/hooks/usePathAnalyticsMerger.d.ts +10 -0
  91. package/dist/umd/esm/components/CardPathAnalysis/index.d.ts +5 -0
  92. package/dist/umd/esm/components/CardPathAnalysis/stores/funnel-chart.d.ts +12 -0
  93. package/dist/umd/esm/components/CardPathAnalysis/stores/index.d.ts +3 -0
  94. package/dist/umd/esm/components/CardPathAnalysis/stores/path-analysis-campaign.d.ts +10 -0
  95. package/dist/umd/esm/components/CardPathAnalysis/stores/path-analysis.d.ts +6 -0
  96. package/dist/umd/esm/components/CardPathAnalysis/types/index.d.ts +1 -0
  97. package/dist/umd/esm/components/CardPathAnalysis/types/path-analysis.d.ts +6 -0
  98. package/dist/umd/esm/components/index.d.ts +1 -0
  99. package/dist/umd/esm/hooks/useSearchParams.d.ts +1 -0
  100. package/dist/umd/esm/modules/analytics/constants/index.d.ts +15 -0
  101. package/dist/umd/esm/modules/analytics/index.d.ts +3 -0
  102. package/dist/umd/esm/modules/analytics/types/index.d.ts +41 -0
  103. package/dist/umd/esm/modules/analytics/utils/formatMetric.d.ts +8 -0
  104. package/dist/umd/esm/modules/analytics/utils/getPAMetricValue.d.ts +3 -0
  105. package/dist/umd/esm/modules/analytics/utils/index.d.ts +3 -0
  106. package/dist/umd/esm/modules/analytics/utils/metric.d.ts +26 -0
  107. package/dist/umd/esm/providers/ConvertMoneyProvider.d.ts +1 -1
  108. package/dist/umd/esm/shared/charts/components/GPolarisViz/components/FunnelChartNext/components/TooltipWithPortal.d.ts +1 -1
  109. package/dist/umd/esm/shared/charts/components/GPolarisViz/hooks/useRootContainer.d.ts +1 -1
  110. package/dist/umd/esm/shared/components/GBox/GBox.d.ts +9 -0
  111. package/dist/umd/esm/shared/components/GBox/index.d.ts +1 -0
  112. package/dist/umd/esm/shared/components/GFeatureLocked/GFeatureLocked.d.ts +14 -0
  113. package/dist/umd/esm/shared/components/GFeatureLocked/constants.d.ts +3 -0
  114. package/dist/umd/esm/shared/components/GFeatureLocked/index.d.ts +2 -0
  115. package/dist/umd/esm/shared/components/GFeatureLocked/types.d.ts +15 -0
  116. package/dist/umd/esm/shared/components/index.d.ts +2 -0
  117. package/dist/umd/esm/types/index.d.ts +1 -0
  118. package/dist/umd/esm/types/metric.d.ts +20 -1
  119. package/dist/umd/esm/types/pricing.d.ts +33 -0
  120. package/dist/umd/esm/types/template.d.ts +19 -0
  121. package/dist/umd/esm/utils/deep-copy.d.ts +1 -0
  122. package/dist/umd/esm/utils/index.d.ts +2 -0
  123. package/dist/umd/esm/utils/template-type.d.ts +2 -0
  124. package/dist/umd/gemxql.js +1 -1
  125. package/dist/umd/index.js +1 -1
  126. package/dist/umd/types.js +1 -1
  127. package/package.json +5 -3
@@ -4,8 +4,8 @@ import timezone from 'dayjs/plugin/timezone.js';
4
4
  import utc from 'dayjs/plugin/utc.js';
5
5
  import { useQuery } from '@tanstack/react-query';
6
6
  import { jsxs, Fragment, jsx } from 'react/jsx-runtime';
7
- import { create } from 'zustand';
8
7
  import { createContext, useContext, useState, useRef, useCallback, useEffect } from 'react';
8
+ import { create } from 'zustand';
9
9
 
10
10
  const NONE_VALUE = 'None';
11
11
  const PLACEHOLDER_VALUE = '-';
@@ -599,6 +599,27 @@ const getFormattedByInterval = (value, interval, options) => {
599
599
  return dayjsTz(value).format(optionFormat.formatMonth);
600
600
  };
601
601
 
602
+ var TemplateType;
603
+ (function (TemplateType) {
604
+ TemplateType["ALL"] = "all";
605
+ TemplateType["HOME"] = "index";
606
+ TemplateType["COLLECTION"] = "collection";
607
+ TemplateType["COLLECTION_LIST"] = "collection-list";
608
+ TemplateType["PRODUCT"] = "product";
609
+ TemplateType["ARTICLE"] = "article";
610
+ TemplateType["PAGE"] = "page";
611
+ TemplateType["CART"] = "cart";
612
+ TemplateType["SEARCH"] = "search";
613
+ TemplateType["NOT_FOUND"] = "404";
614
+ TemplateType["BLOG"] = "blog";
615
+ TemplateType["PASSWORD"] = "password";
616
+ TemplateType["CONTACT"] = "contact";
617
+ TemplateType["GIF_CART"] = "gif-cart";
618
+ TemplateType["ACCOUNT"] = "account";
619
+ TemplateType["CHECKOUT"] = "checkout";
620
+ TemplateType["GIFT_CARD"] = "gift-card";
621
+ })(TemplateType || (TemplateType = {}));
622
+
602
623
  const toDate = (value) => (typeof value === 'string' ? dayjsTz(value) : value);
603
624
  const isMidnight = (date) => date.hour() === 0 && date.minute() === 0;
604
625
  const formatDateForQuery = (date, isEndDay = false) => {
@@ -970,6 +991,7 @@ var EMetricKey;
970
991
  EMetricKey["VISITOR_ITEMS"] = "visitor_items";
971
992
  EMetricKey["DEVICE_ITEMS"] = "device_items";
972
993
  EMetricKey["TRAFFIC_SOURCE_ITEMS"] = "traffic_source_items";
994
+ EMetricKey["PAGE_PATH_ANALYSIS"] = "PAGE_PATH_ANALYSIS";
973
995
  })(EMetricKey || (EMetricKey = {}));
974
996
 
975
997
  ({
@@ -1061,6 +1083,10 @@ var EMetricKey;
1061
1083
  title: 'Sessions by traffic source',
1062
1084
  content: 'Sessions on your page by where visitors come from',
1063
1085
  },
1086
+ [EMetricKey.PAGE_PATH_ANALYSIS]: {
1087
+ title: 'Journey analysis',
1088
+ content: 'Journey analysis tracks the journey from entry to purchase and shows where visitors leave the store',
1089
+ },
1064
1090
  });
1065
1091
 
1066
1092
  var EAnalyticMode;
@@ -1093,6 +1119,43 @@ var ETrafficSourceType;
1093
1119
  ETrafficSourceType["SMS"] = "sms";
1094
1120
  })(ETrafficSourceType || (ETrafficSourceType = {}));
1095
1121
 
1122
+ /**
1123
+ * Pricing enums mirrored from the host app (`~/modules/pricing/types`).
1124
+ *
1125
+ * They are duplicated here so the SDK no longer needs to import the host's
1126
+ * pricing module directly. The host can import these enums back from
1127
+ * `@gem-sdk/analytics/types` to build the value passed to `PathAnalysisConfigProvider`,
1128
+ * which guarantees the string values stay in sync on both sides.
1129
+ */
1130
+ var IPlanKey;
1131
+ (function (IPlanKey) {
1132
+ /**
1133
+ * @deprecated This plan is available for users installed before release 1.3.0.
1134
+ */
1135
+ IPlanKey["CONTENT_TESTING"] = "content-testing";
1136
+ IPlanKey["PAGE_OPT"] = "page-optimize";
1137
+ IPlanKey["FUNNEL_OPT"] = "funnel-optimize";
1138
+ IPlanKey["PROFIT_OPT"] = "profit-optimize";
1139
+ // Trial plans
1140
+ IPlanKey["TRIAL_PAGE_OPT"] = "trial-page-optimize";
1141
+ IPlanKey["TRIAL_FUNNEL_OPT"] = "trial-funnel-optimize";
1142
+ IPlanKey["TRIAL_PROFIT_OPT"] = "trial-profit-optimize";
1143
+ })(IPlanKey || (IPlanKey = {}));
1144
+ var IShopPlanState;
1145
+ (function (IShopPlanState) {
1146
+ IShopPlanState["TRIAL_PAGE_OPT"] = "TRIAL_PAGE_OPT";
1147
+ IShopPlanState["TRIAL_FUNNEL_OPT"] = "TRIAL_FUNNEL_OPT";
1148
+ IShopPlanState["TRIAL_PROFIT_OPT"] = "TRIAL_PROFIT_OPT";
1149
+ IShopPlanState["ACTIVE_PAGE_OPT"] = "ACTIVE_PAGE_OPT";
1150
+ IShopPlanState["ACTIVE_FUNNEL_OPT"] = "ACTIVE_FUNNEL_OPT";
1151
+ IShopPlanState["ACTIVE_PROFIT_OPT"] = "ACTIVE_PROFIT_OPT";
1152
+ IShopPlanState["LOADING_PLAN"] = "LOADING_PLAN";
1153
+ IShopPlanState["TRIAL_EXPIRED"] = "TRIAL_EXPIRED";
1154
+ IShopPlanState["ACTIVE_PAGE_OPT_AND_TRIAL_PAGE_OPT"] = "ACTIVE_PAGE_OPT_AND_TRIAL_PAGE_OPT";
1155
+ IShopPlanState["ACTIVE_PAGE_OPT_AND_TRIAL_FUNNEL_OPT"] = "ACTIVE_PAGE_OPT_AND_TRIAL_FUNNEL_OPT";
1156
+ IShopPlanState["ACTIVE_FUNNEL_OPT_AND_TRIAL_FUNNEL_OPT"] = "ACTIVE_FUNNEL_OPT_AND_TRIAL_FUNNEL_OPT";
1157
+ })(IShopPlanState || (IShopPlanState = {}));
1158
+
1096
1159
  [
1097
1160
  { value: EVisitorType.NEW, label: 'New' },
1098
1161
  { value: EVisitorType.RETURNING, label: 'Returning' },
@@ -0,0 +1 @@
1
+ export declare const useSearchParams: () => [URLSearchParams];