@levi-gemcommerce/analytics 2.1.0-test.0 → 3.0.1-dev.3

package/src/shared/reports/ui/ReportTable/utils/format.ts

@@ -0,0 +1,100 @@
+import type { IGetTextPrice } from '@/core/gemxql';
+
+import { formatReportTableDate } from '../helpers';
+import {
+  AnalyticInterval,
+  calcPercentageString,
+  getFormattedByInterval,
+  getTimeDurationLabel,
+  numberWithCommas,
+} from '@/utils';
+import { NONE_VALUE } from '@/core/gemxql';
+import { EReportColumnKey } from '../types/report-columns';
+import { EReportDataType, type ReportValueType } from '@/shared/reports/common/Visualization/types';
+
+export const formatReportData = ({
+  value,
+  formatter,
+  getTextPrice,
+  name,
+}: {
+  value: ReportValueType;
+  formatter?: string;
+  getTextPrice: IGetTextPrice;
+  name?: string;
+}): ReportValueType => {
+  const dataTypeIsObjectOrArray = value !== null && (typeof value === 'object' || Array.isArray(value));
+
+  if (dataTypeIsObjectOrArray) return value;
+
+  switch (formatter) {
+    case EReportDataType.INTEGER: {
+      return numberWithCommas((value ?? 0).toString());
+    }
+
+    case EReportDataType.CURRENCY: {
+      return getTextPrice(value, false);
+    }
+
+    case EReportDataType.DATE: {
+      return formatReportTableDate(value);
+    }
+
+    case EReportDataType.PERCENT: {
+      if (typeof value !== 'number') return calcPercentageString(0, 1, 2) ?? '';
+      return calcPercentageString(value / 100, 1, 2) ?? '';
+    }
+
+    case EReportDataType.DURATION: {
+      return getTimeDurationLabel(Number(value));
+    }
+
+    case EReportDataType.STRING: {
+      const fallbackValue = name === EReportColumnKey.CAMPAIGNS ? '' : NONE_VALUE;
+
+      return value ?? fallbackValue;
+    }
+
+    case EReportDataType.DAY: {
+      return getFormattedByInterval(value, AnalyticInterval.DAY, {
+        isExpandDetail: true,
+      });
+    }
+
+    case EReportDataType.HOUR: {
+      return getFormattedByInterval(value, AnalyticInterval.HOUR, {
+        isExpandDetail: true,
+      });
+    }
+
+    case EReportDataType.MONTH: {
+      return getFormattedByInterval(value, AnalyticInterval.MONTH, {
+        isExpandDetail: true,
+      });
+    }
+
+    case EReportDataType.YEAR: {
+      return getFormattedByInterval(value, AnalyticInterval.YEAR);
+    }
+
+    case EReportDataType.WEEK: {
+      return getFormattedByInterval(value, AnalyticInterval.WEEK, {
+        isExpandDetail: true,
+      });
+    }
+
+    case EReportDataType.QUARTER: {
+      return getFormattedByInterval(value, AnalyticInterval.QUARTER, {
+        isExpandDetail: true,
+      });
+    }
+
+    case EReportDataType.OBJECT:
+    case EReportDataType.ARRAY: {
+      return value;
+    }
+
+    default:
+      return `${value}`;
+  }
+};

package/src/shared/reports/ui/ReportTable/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './table';
+export * from './format';

package/src/shared/reports/ui/ReportTable/utils/order.ts

@@ -0,0 +1,8 @@
+import type { OrderDirectionType } from '../types';
+
+import { reportOrderTooltip, DEFAULT_TOOLTIP } from '../constants';
+export const getOrderTooltip = (field: string, direction: OrderDirectionType) => {
+  if (!reportOrderTooltip[field]) return DEFAULT_TOOLTIP[direction];
+
+  return reportOrderTooltip[field][direction];
+};

package/src/shared/reports/ui/ReportTable/utils/table.ts

@@ -0,0 +1,19 @@
+import type { ReportColumnLayout } from '../types';
+import type { CSSProperties } from 'react';
+
+export const getColumnLayoutStyles = (columnLayout: ReportColumnLayout, hasTooltipCard?: boolean) => {
+  return {
+    '--column-cell-min-width': columnLayout.minWidth,
+    '--column-cell-max-width': columnLayout.maxWidth,
+    '--column-cell-justify-content': columnLayout.align,
+    '--column-cell-padding-inline': columnLayout.paddingInline,
+    '--column-first-padding-inline': columnLayout.columnFirstPaddingInline,
+    '--column-wrapper-width': columnLayout.columnWrapperWidth,
+    '--column-cell-padding-right': !hasTooltipCard ? columnLayout.paddingRight : columnLayout.paddingInline,
+    '--column-header-cell-padding-right': !hasTooltipCard
+      ? columnLayout.headerPaddingRight
+      : columnLayout.paddingInline,
+    '--column-dimension-box-shadow': columnLayout.dimensionBoxShadow,
+    '--column-border-right-width': columnLayout.borderRightWidth,
+  } as CSSProperties;
+};

package/src/shared/reports/ui/ReportTable/utils/visualization.ts

@@ -0,0 +1,56 @@
+import {
+  COLUMN_SEPARATOR,
+  DIMENSION_SEPARATOR,
+  COMPARISON_PREFIX,
+  PREVIOUS_PERIOD_KEY,
+  TOTAL_SUFFIX,
+} from '@/shared/reports/common';
+import type { IRMetricKey, ReportRowType } from '@/shared/reports/common/Visualization/types';
+
+const joinColumnParts = (...parts: string[]) => parts.join(COLUMN_SEPARATOR);
+const getDimensionPathKey = (dimensions: string[], dimensionIndex: number) =>
+  dimensions.slice(0, dimensionIndex + 1).join(DIMENSION_SEPARATOR);
+
+export function getPreviousColumnName(key: IRMetricKey | string) {
+  return joinColumnParts(COMPARISON_PREFIX, key, PREVIOUS_PERIOD_KEY);
+}
+
+export function getPreviousTotalColumnName(key: IRMetricKey | string) {
+  return joinColumnParts(COMPARISON_PREFIX, key, PREVIOUS_PERIOD_KEY, TOTAL_SUFFIX);
+}
+
+export function getTotalColumnName(key: IRMetricKey | string) {
+  return joinColumnParts(key, TOTAL_SUFFIX);
+}
+
+export function getTotalColumnNameByDimensions(dimensions: string[], key: string, dimensionIndex: number) {
+  return joinColumnParts(key, getDimensionPathKey(dimensions, dimensionIndex), TOTAL_SUFFIX);
+}
+
+export function getPreviousTotalColumnNameByDimensions(dimensions: string[], key: string, dimensionIndex: number) {
+  return joinColumnParts(
+    COMPARISON_PREFIX,
+    key,
+    PREVIOUS_PERIOD_KEY,
+    getDimensionPathKey(dimensions, dimensionIndex),
+    TOTAL_SUFFIX,
+  );
+}
+
+export function getMetricValue(row: ReportRowType, key: IRMetricKey | string) {
+  return row[key] || 0;
+}
+
+export function getMetricPreviousValue(row: ReportRowType, key: IRMetricKey | string) {
+  return row[getPreviousColumnName(key)];
+}
+
+export function getMetricTotalValue(row: ReportRowType, key: IRMetricKey | string) {
+  return Number(row[getTotalColumnName(key)]) || 0;
+}
+
+export function getMetricPreviousTotalValue(row: ReportRowType, key: IRMetricKey | string) {
+  return Number(row[getPreviousTotalColumnName(key)]) || 0;
+}
+
+export const isMainColumn = (columnName: string) => !columnName.includes(COLUMN_SEPARATOR);

package/src/stores/currencyRatesStore.ts

@@ -0,0 +1,13 @@
+import { create } from 'zustand';
+
+export type ICurrencyRates = Record<string, number>;
+
+interface ICurrencyRatesStore {
+  currencyRates: ICurrencyRates | null;
+  setCurrencyRates: (rates: ICurrencyRates) => void;
+}
+
+export const useCurrencyRatesStore = create<ICurrencyRatesStore>((set) => ({
+  currencyRates: null,
+  setCurrencyRates: (rates) => set({ currencyRates: rates }),
+}));

package/src/stores/index.ts

@@ -0,0 +1,2 @@
+export { useCurrencyRatesStore } from './currencyRatesStore';
+export type { ICurrencyRates } from './currencyRatesStore';

package/src/styles/index.scss

@@ -0,0 +1,9 @@
+@use '../components/CardPathAnalysis/assets/styles/PathAnalysis';
+@use '../shared/charts/components/GPolarisViz/components/FunnelChartNext/components/FunnelTooltip/FunnelTooltip.scss';
+@use '../shared/charts/components/GPolarisViz/components/FunnelChartNext/components/Tooltip/Tooltip.scss';
+@use '../shared/components/GInlineCenter/GInlineCenter.scss';
+@use '../shared/components/GVariantBadge/GVariantBadge.scss';
+@use '../shared/reports/ui/ReportTable/assets/styles/ReportTable.scss';
+@use '../shared/components/GBox/GBox.scss';
+
+@tailwind utilities;

package/src/types/analytic-mode.ts

@@ -0,0 +1,5 @@
+export enum EAnalyticMode {
+  'ALL_SESSION' = 'ALL_SESSION',
+  'FIRST_SESSION' = 'FIRST_SESSION',
+  'PAGE_ONLY' = 'PAGE_ONLY',
+}

package/src/types/breakdown-items.ts

@@ -0,0 +1,21 @@
+export enum EVisitorType {
+  NEW = 'new',
+  RETURNING = 'returning',
+}
+
+export enum EDeviceType {
+  DESKTOP = 'desktop',
+  MOBILE = 'mobile',
+  TABLET = 'tablet',
+}
+
+export enum ETrafficSourceType {
+  DIRECT = 'direct',
+  EMAIL = 'email',
+  REFERRAL = 'referral',
+  ORGANIC_SOCIAL = 'organic-social',
+  ORGANIC_SEARCH = 'organic-search',
+  PAID_SOCIAL = 'paid-social',
+  PAID_SEARCH = 'paid-search',
+  SMS = 'sms',
+}

package/src/types/campaign.ts

@@ -0,0 +1,13 @@
+export enum ICampaignType {
+  // CONTENT = 'CONTENT',
+  PRICE = 'PRICE',
+  TEMPLATE = 'TEMPLATE',
+  TEMPLATE_BUNDLE = 'TEMPLATE_BUNDLE',
+  URL = 'URL',
+  // THEME = 'THEME',
+}
+
+export enum IVariantType {
+  VARIANT_A = 'A',
+  VARIANT_B = 'B',
+}

package/src/types/chart.ts

@@ -0,0 +1,42 @@
+import type { DataSeries, Trend } from '@shopify/polaris-viz-core';
+
+export interface IMetricDonutChartData extends DataSeries {
+  metadata: {
+    trend: {
+      value?: string;
+      direction: 'upward' | 'downward';
+      trend: 'positive' | 'negative';
+    };
+  };
+}
+
+export interface IDonutTarget<T extends string = string> {
+  value: T;
+  label: string;
+}
+
+export type IDonutMetricRow = Record<string, unknown>;
+
+export interface IPAChartLabel {
+  value: string;
+  tooltipValue: string;
+}
+export type IPAChartLabels = IPAChartLabel[];
+
+export interface IPAChartDataPoint {
+  key: string;
+  tooltipKey: string;
+  value: number;
+  trend?: {
+    value: string | undefined;
+    trend: Trend;
+  };
+}
+
+export type AllChartsDataMap = Record<
+  string,
+  {
+    current: IPAChartDataPoint[];
+    previous: IPAChartDataPoint[];
+  }
+>;

package/src/types/currency.ts

@@ -0,0 +1,329 @@
+/**
+ * ISO 4217 currency codes supported by Shopify.
+ * Ported from the Shopify Admin API types so the analytics SDK stays host-agnostic.
+ */
+export type CurrencyCode =
+  /** United Arab Emirates Dirham (AED). */
+  | 'AED'
+  /** Afghan Afghani (AFN). */
+  | 'AFN'
+  /** Albanian Lek (ALL). */
+  | 'ALL'
+  /** Armenian Dram (AMD). */
+  | 'AMD'
+  /** Netherlands Antillean Guilder. */
+  | 'ANG'
+  /** Angolan Kwanza (AOA). */
+  | 'AOA'
+  /** Argentine Pesos (ARS). */
+  | 'ARS'
+  /** Australian Dollars (AUD). */
+  | 'AUD'
+  /** Aruban Florin (AWG). */
+  | 'AWG'
+  /** Azerbaijani Manat (AZN). */
+  | 'AZN'
+  /** Bosnia and Herzegovina Convertible Mark (BAM). */
+  | 'BAM'
+  /** Barbadian Dollar (BBD). */
+  | 'BBD'
+  /** Bangladesh Taka (BDT). */
+  | 'BDT'
+  /** Bulgarian Lev (BGN). */
+  | 'BGN'
+  /** Bahraini Dinar (BHD). */
+  | 'BHD'
+  /** Burundian Franc (BIF). */
+  | 'BIF'
+  /** Bermudian Dollar (BMD). */
+  | 'BMD'
+  /** Brunei Dollar (BND). */
+  | 'BND'
+  /** Bolivian Boliviano (BOB). */
+  | 'BOB'
+  /** Brazilian Real (BRL). */
+  | 'BRL'
+  /** Bahamian Dollar (BSD). */
+  | 'BSD'
+  /** Bhutanese Ngultrum (BTN). */
+  | 'BTN'
+  /** Botswana Pula (BWP). */
+  | 'BWP'
+  /** Belarusian Ruble (BYN). */
+  | 'BYN'
+  /** Belarusian Ruble (BYR). */
+  | 'BYR'
+  /** Belize Dollar (BZD). */
+  | 'BZD'
+  /** Canadian Dollars (CAD). */
+  | 'CAD'
+  /** Congolese franc (CDF). */
+  | 'CDF'
+  /** Swiss Francs (CHF). */
+  | 'CHF'
+  /** Chilean Peso (CLP). */
+  | 'CLP'
+  /** Chinese Yuan Renminbi (CNY). */
+  | 'CNY'
+  /** Colombian Peso (COP). */
+  | 'COP'
+  /** Costa Rican Colones (CRC). */
+  | 'CRC'
+  /** Cape Verdean escudo (CVE). */
+  | 'CVE'
+  /** Czech Koruny (CZK). */
+  | 'CZK'
+  /** Djiboutian Franc (DJF). */
+  | 'DJF'
+  /** Danish Kroner (DKK). */
+  | 'DKK'
+  /** Dominican Peso (DOP). */
+  | 'DOP'
+  /** Algerian Dinar (DZD). */
+  | 'DZD'
+  /** Egyptian Pound (EGP). */
+  | 'EGP'
+  /** Eritrean Nakfa (ERN). */
+  | 'ERN'
+  /** Ethiopian Birr (ETB). */
+  | 'ETB'
+  /** Euro (EUR). */
+  | 'EUR'
+  /** Fijian Dollars (FJD). */
+  | 'FJD'
+  /** Falkland Islands Pounds (FKP). */
+  | 'FKP'
+  /** United Kingdom Pounds (GBP). */
+  | 'GBP'
+  /** Georgian Lari (GEL). */
+  | 'GEL'
+  /** Ghanaian Cedi (GHS). */
+  | 'GHS'
+  /** Gibraltar Pounds (GIP). */
+  | 'GIP'
+  /** Gambian Dalasi (GMD). */
+  | 'GMD'
+  /** Guinean Franc (GNF). */
+  | 'GNF'
+  /** Guatemalan Quetzal (GTQ). */
+  | 'GTQ'
+  /** Guyanese Dollar (GYD). */
+  | 'GYD'
+  /** Hong Kong Dollars (HKD). */
+  | 'HKD'
+  /** Honduran Lempira (HNL). */
+  | 'HNL'
+  /** Croatian Kuna (HRK). */
+  | 'HRK'
+  /** Haitian Gourde (HTG). */
+  | 'HTG'
+  /** Hungarian Forint (HUF). */
+  | 'HUF'
+  /** Indonesian Rupiah (IDR). */
+  | 'IDR'
+  /** Israeli New Shekel (NIS). */
+  | 'ILS'
+  /** Indian Rupees (INR). */
+  | 'INR'
+  /** Iraqi Dinar (IQD). */
+  | 'IQD'
+  /** Iranian Rial (IRR). */
+  | 'IRR'
+  /** Icelandic Kronur (ISK). */
+  | 'ISK'
+  /** Jersey Pound. */
+  | 'JEP'
+  /** Jamaican Dollars (JMD). */
+  | 'JMD'
+  /** Jordanian Dinar (JOD). */
+  | 'JOD'
+  /** Japanese Yen (JPY). */
+  | 'JPY'
+  /** Kenyan Shilling (KES). */
+  | 'KES'
+  /** Kyrgyzstani Som (KGS). */
+  | 'KGS'
+  /** Cambodian Riel. */
+  | 'KHR'
+  /** Kiribati Dollar (KID). */
+  | 'KID'
+  /** Comorian Franc (KMF). */
+  | 'KMF'
+  /** South Korean Won (KRW). */
+  | 'KRW'
+  /** Kuwaiti Dinar (KWD). */
+  | 'KWD'
+  /** Cayman Dollars (KYD). */
+  | 'KYD'
+  /** Kazakhstani Tenge (KZT). */
+  | 'KZT'
+  /** Laotian Kip (LAK). */
+  | 'LAK'
+  /** Lebanese Pounds (LBP). */
+  | 'LBP'
+  /** Sri Lankan Rupees (LKR). */
+  | 'LKR'
+  /** Liberian Dollar (LRD). */
+  | 'LRD'
+  /** Lesotho Loti (LSL). */
+  | 'LSL'
+  /** Lithuanian Litai (LTL). */
+  | 'LTL'
+  /** Latvian Lati (LVL). */
+  | 'LVL'
+  /** Libyan Dinar (LYD). */
+  | 'LYD'
+  /** Moroccan Dirham. */
+  | 'MAD'
+  /** Moldovan Leu (MDL). */
+  | 'MDL'
+  /** Malagasy Ariary (MGA). */
+  | 'MGA'
+  /** Macedonia Denar (MKD). */
+  | 'MKD'
+  /** Burmese Kyat (MMK). */
+  | 'MMK'
+  /** Mongolian Tugrik. */
+  | 'MNT'
+  /** Macanese Pataca (MOP). */
+  | 'MOP'
+  /** Mauritanian Ouguiya (MRU). */
+  | 'MRU'
+  /** Mauritian Rupee (MUR). */
+  | 'MUR'
+  /** Maldivian Rufiyaa (MVR). */
+  | 'MVR'
+  /** Malawian Kwacha (MWK). */
+  | 'MWK'
+  /** Mexican Pesos (MXN). */
+  | 'MXN'
+  /** Malaysian Ringgits (MYR). */
+  | 'MYR'
+  /** Mozambican Metical. */
+  | 'MZN'
+  /** Namibian Dollar. */
+  | 'NAD'
+  /** Nigerian Naira (NGN). */
+  | 'NGN'
+  /** Nicaraguan Córdoba (NIO). */
+  | 'NIO'
+  /** Norwegian Kroner (NOK). */
+  | 'NOK'
+  /** Nepalese Rupee (NPR). */
+  | 'NPR'
+  /** New Zealand Dollars (NZD). */
+  | 'NZD'
+  /** Omani Rial (OMR). */
+  | 'OMR'
+  /** Panamian Balboa (PAB). */
+  | 'PAB'
+  /** Peruvian Nuevo Sol (PEN). */
+  | 'PEN'
+  /** Papua New Guinean Kina (PGK). */
+  | 'PGK'
+  /** Philippine Peso (PHP). */
+  | 'PHP'
+  /** Pakistani Rupee (PKR). */
+  | 'PKR'
+  /** Polish Zlotych (PLN). */
+  | 'PLN'
+  /** Paraguayan Guarani (PYG). */
+  | 'PYG'
+  /** Qatari Rial (QAR). */
+  | 'QAR'
+  /** Romanian Lei (RON). */
+  | 'RON'
+  /** Serbian dinar (RSD). */
+  | 'RSD'
+  /** Russian Rubles (RUB). */
+  | 'RUB'
+  /** Rwandan Franc (RWF). */
+  | 'RWF'
+  /** Saudi Riyal (SAR). */
+  | 'SAR'
+  /** Solomon Islands Dollar (SBD). */
+  | 'SBD'
+  /** Seychellois Rupee (SCR). */
+  | 'SCR'
+  /** Sudanese Pound (SDG). */
+  | 'SDG'
+  /** Swedish Kronor (SEK). */
+  | 'SEK'
+  /** Singapore Dollars (SGD). */
+  | 'SGD'
+  /** Saint Helena Pounds (SHP). */
+  | 'SHP'
+  /** Sierra Leonean Leone (SLL). */
+  | 'SLL'
+  /** Somali Shilling (SOS). */
+  | 'SOS'
+  /** Surinamese Dollar (SRD). */
+  | 'SRD'
+  /** South Sudanese Pound (SSP). */
+  | 'SSP'
+  /** Sao Tome And Principe Dobra (STD). */
+  | 'STD'
+  /** Sao Tome And Principe Dobra (STN). */
+  | 'STN'
+  /** Syrian Pound (SYP). */
+  | 'SYP'
+  /** Swazi Lilangeni (SZL). */
+  | 'SZL'
+  /** Thai baht (THB). */
+  | 'THB'
+  /** Tajikistani Somoni (TJS). */
+  | 'TJS'
+  /** Turkmenistani Manat (TMT). */
+  | 'TMT'
+  /** Tunisian Dinar (TND). */
+  | 'TND'
+  /** Tongan Pa'anga (TOP). */
+  | 'TOP'
+  /** Turkish Lira (TRY). */
+  | 'TRY'
+  /** Trinidad and Tobago Dollars (TTD). */
+  | 'TTD'
+  /** Taiwan Dollars (TWD). */
+  | 'TWD'
+  /** Tanzanian Shilling (TZS). */
+  | 'TZS'
+  /** Ukrainian Hryvnia (UAH). */
+  | 'UAH'
+  /** Ugandan Shilling (UGX). */
+  | 'UGX'
+  /** United States Dollars (USD). */
+  | 'USD'
+  /** United States Dollars Coin (USDC). */
+  | 'USDC'
+  /** Uruguayan Pesos (UYU). */
+  | 'UYU'
+  /** Uzbekistan som (UZS). */
+  | 'UZS'
+  /** Venezuelan Bolivares (VED). */
+  | 'VED'
+  /** Venezuelan Bolivares (VEF). */
+  | 'VEF'
+  /** Venezuelan Bolivares Soberanos (VES). */
+  | 'VES'
+  /** Vietnamese đồng (VND). */
+  | 'VND'
+  /** Vanuatu Vatu (VUV). */
+  | 'VUV'
+  /** Samoan Tala (WST). */
+  | 'WST'
+  /** Central African CFA Franc (XAF). */
+  | 'XAF'
+  /** East Caribbean Dollar (XCD). */
+  | 'XCD'
+  /** West African CFA franc (XOF). */
+  | 'XOF'
+  /** CFP Franc (XPF). */
+  | 'XPF'
+  /** Unrecognized currency. */
+  | 'XXX'
+  /** Yemeni Rial (YER). */
+  | 'YER'
+  /** South African Rand (ZAR). */
+  | 'ZAR'
+  /** Zambian Kwacha (ZMW). */
+  | 'ZMW';

package/src/types/index.ts

@@ -0,0 +1,8 @@
+export * from './analytic-mode';
+export * from './breakdown-items';
+export * from './campaign';
+export * from './chart';
+export * from './currency';
+export * from './metric';
+export * from './pricing';
+export * from './report-columns';