@levi-gemcommerce/analytics 0.0.1-dev.7 → 1.0.0-dev.10

package/dist/esm/components/AnalyticMode/AnalyticModeSelector.d.ts

@@ -0,0 +1,13 @@
+import { EAnalyticMode } from '@/types';
+export interface AnalyticModeSelectorProps {
+    activatorText?: string;
+    value?: EAnalyticMode;
+    onChange: (value: EAnalyticMode) => void;
+}
+export declare const VIEW_BY_OPTIONS: {
+    id: EAnalyticMode;
+    content: string;
+    helpText: string;
+    icon: string;
+}[];
+export declare const AnalyticModeSelector: ({ activatorText, value, onChange }: AnalyticModeSelectorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/esm/components/AnalyticMode/index.d.ts

@@ -0,0 +1,2 @@
+export { AnalyticModeSelector } from './AnalyticModeSelector';
+export type { AnalyticModeSelectorProps } from './AnalyticModeSelector';

package/dist/esm/components/CurrencySelector/CurrencySelector.d.ts

@@ -0,0 +1,10 @@
+import type { GSelectorProps } from '@/shared';
+import type { CurrencyCode } from '@/types';
+export interface CurrencySelectorProps {
+    currencies?: CurrencyCode[];
+    selected?: CurrencyCode;
+    preferredAlignment?: GSelectorProps['preferredAlignment'];
+    activatorText?: string;
+    onSelect?: (value: CurrencyCode) => void;
+}
+export declare const CurrencySelector: ({ currencies, selected, preferredAlignment, activatorText, onSelect, }: CurrencySelectorProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/esm/components/CurrencySelector/index.d.ts

@@ -0,0 +1,2 @@
+export { CurrencySelector } from './CurrencySelector';
+export type { CurrencySelectorProps } from './CurrencySelector';

package/dist/esm/components/GSelectableMetricChartCard/GSelectableMetricChartCard.d.ts

@@ -1,14 +1,16 @@
-import type { AllChartsDataMap, IMetricCardItem } from '@/types';
+import type { ColumnTypesMap } from '@/core/gemxql';
+import type { AllChartsDataMap, EMetricKey, IMetricCardItem } from '@/types';
 import type { ReactElement } from 'react';
 export interface IProps {
     metricInfo: IMetricCardItem[];
     dataChart: AllChartsDataMap;
-    defaultActiveTab?: string;
+    defaultActiveTab?: EMetricKey;
     isLoading?: boolean;
     isEmptyMetricData?: boolean;
     hideComparison?: boolean;
     currentPeriodLabel?: string;
     previousPeriodLabel?: string;
+    columnTypes?: ColumnTypesMap;
     onclickMetric?: (key: string) => void;
 }
-export declare const GSelectableMetricChartCard: ({ metricInfo, dataChart, defaultActiveTab, isLoading, isEmptyMetricData, hideComparison, currentPeriodLabel, previousPeriodLabel, }: IProps) => ReactElement;
+export declare const GSelectableMetricChartCard: ({ metricInfo, dataChart, defaultActiveTab, isLoading, isEmptyMetricData, hideComparison, currentPeriodLabel, previousPeriodLabel, columnTypes, }: IProps) => ReactElement;

package/dist/esm/components/GSelectableMetricChartCard/MetricChartTab.d.ts

@@ -1,11 +1,11 @@
 import type { ReactElement } from 'react';
-import type { IMetricCardItem } from '../../types';
+import type { EMetricKey, IMetricCardItem } from '../../types';
 export interface IProps {
     item: IMetricCardItem;
     isActive: boolean;
     isLoading?: boolean;
     hideComparison?: boolean;
-    onSelect: (key: string) => void;
+    onSelect: (key: EMetricKey) => void;
     onClickTitle?: (key: string) => void;
 }
 export declare const MetricChartTab: ({ item, isActive, isLoading, hideComparison, onSelect, onClickTitle, }: IProps) => ReactElement;

package/dist/esm/components/MetricDonutChartCard/MetricDonutChartCard.d.ts

@@ -0,0 +1,16 @@
+import type { IDonutMetricRow, IDonutTarget } from '@/types';
+import type { EMetricKey } from '@/types';
+import type { ReactElement } from 'react';
+export interface IProps {
+    label: string;
+    metricKey: EMetricKey;
+    targets: IDonutTarget[];
+    totalsRow?: IDonutMetricRow;
+    comparisonTotalsRow?: IDonutMetricRow;
+    sort?: boolean;
+    isLoading?: boolean;
+    isEmptyMetricData?: boolean;
+    minHeight?: number;
+    onClick: () => void;
+}
+export declare const MetricDonutChartCard: ({ label, metricKey, targets, totalsRow, comparisonTotalsRow, sort, isLoading, isEmptyMetricData, minHeight, onClick, }: IProps) => ReactElement;

package/dist/esm/components/MetricDonutChartCard/index.d.ts

@@ -0,0 +1,2 @@
+export { MetricDonutChartCard } from './MetricDonutChartCard';
+export type { IProps as IMetricDonutChartCardProps } from './MetricDonutChartCard';

package/dist/esm/components/MetricDonutChartCard/utils/donut-chart.d.ts

@@ -0,0 +1,20 @@
+import type { EMetricKey, IDonutMetricRow, IDonutTarget, IMetricDonutChartData } from '@/types';
+import type { IBreakdownItem } from '@/core/gemxql';
+interface IComputeDonutDataParams {
+    name: string;
+    currentValue: number;
+    prevValue: number;
+    hasPreviousData: boolean;
+}
+interface IBuildBreakdownDonutDataParams<T extends string> {
+    targets: IDonutTarget<T>[];
+    metricKey: EMetricKey;
+    totalsRow?: IDonutMetricRow;
+    comparisonTotalsRow?: IDonutMetricRow;
+    sort?: boolean;
+}
+export declare const calculatePercentageChange: (current: number, previous: number) => string | undefined;
+export declare const computeDonutData: ({ name, currentValue, prevValue, hasPreviousData, }: IComputeDonutDataParams) => IMetricDonutChartData;
+export declare const getTotalCountByType: (stats: IBreakdownItem[] | undefined, type: string) => number;
+export declare const buildBreakdownDonutData: <T extends string>({ targets, metricKey, totalsRow, comparisonTotalsRow, sort, }: IBuildBreakdownDonutDataParams<T>) => IMetricDonutChartData[];
+export {};

package/dist/esm/components/MetricDonutChartCard/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './donut-chart';

package/dist/esm/components/SingleMetricChartCard/SingleMetricChartCard.d.ts

@@ -1,12 +1,14 @@
 import type { DataSeries } from '@shopify/polaris-viz-core';
 import type { ReactElement } from 'react';
 import type { IMetricCardItem } from '../../types';
+import type { ColumnTypesMap } from '@/core/gemxql';
 export interface IProps {
     metricInfo: IMetricCardItem;
     isLoading?: boolean;
     hideComparison?: boolean;
     isEmptyMetricData?: boolean;
     lineChartData: DataSeries[];
+    columnTypes?: ColumnTypesMap;
     onClickTitle?: (key: string) => void;
 }
-export declare const SingleMetricChartCard: ({ metricInfo, lineChartData, isLoading, hideComparison, isEmptyMetricData, onClickTitle, }: IProps) => ReactElement;
+export declare const SingleMetricChartCard: ({ metricInfo, lineChartData, isLoading, hideComparison, columnTypes, isEmptyMetricData, onClickTitle, }: IProps) => ReactElement;

package/dist/esm/components/common/chart/MetricChart.d.ts

@@ -1,8 +1,12 @@
 import type { DataSeries } from '@shopify/polaris-viz';
 import type { ReactElement } from 'react';
+import type { ColumnTypesMap } from '@/core/gemxql';
+import type { EMetricKey } from '@/types';
 export interface IProps {
     lineChartData: DataSeries[];
     isLoading?: boolean;
     isEmptyMetricData?: boolean;
+    columnTypes?: ColumnTypesMap;
+    metricKey?: EMetricKey;
 }
-export declare const MetricChart: ({ lineChartData, isLoading, isEmptyMetricData }: IProps) => ReactElement;
+export declare const MetricChart: ({ lineChartData, isLoading, isEmptyMetricData, columnTypes, metricKey, }: IProps) => ReactElement;

package/dist/esm/components/common/chart/MetricDonutChartSkeleton.d.ts

@@ -0,0 +1 @@
+export declare const MetricDonutChartSkeleton: () => import("react/jsx-runtime").JSX.Element;

package/dist/esm/components/common/chart/index.d.ts

@@ -2,6 +2,7 @@ export { GChartSkeleton } from './GChartSkeleton';
 export { MetricChart } from './MetricChart';
 export { MetricChartEmpty } from './MetricChartEmpty';
 export { MetricChartTooltip } from './MetricChartTooltip';
+export { MetricDonutChartSkeleton } from './MetricDonutChartSkeleton';
 export { MetricInfoBlock } from './MetricInfoBlock';
 export { MetricInfoSkeleton } from './MetricInfoSkeleton';
 export { MetricValueSummary } from './MetricValueSummary';

package/dist/esm/components/index.d.ts

@@ -1,2 +1,5 @@
 export * from './GSelectableMetricChartCard';
+export * from './MetricDonutChartCard';
 export * from './SingleMetricChartCard';
+export * from './AnalyticMode';
+export * from './CurrencySelector';

package/dist/esm/constants/breakdown-targets.d.ts

@@ -0,0 +1,5 @@
+import type { IDonutTarget } from '@/types';
+import { EDeviceType, ETrafficSourceType, EVisitorType } from '@/core/gemxql';
+export declare const TARGET_VISITOR: IDonutTarget<EVisitorType>[];
+export declare const TARGET_DEVICES: IDonutTarget<EDeviceType>[];
+export declare const TARGET_CHANNEL: IDonutTarget<ETrafficSourceType>[];

package/dist/esm/constants/campaign.d.ts

@@ -0,0 +1 @@
+export declare const CAMPAIGN_BACKGROUND_MAIN: Record<string, string>;

package/dist/esm/constants/currency.d.ts

@@ -0,0 +1,2 @@
+import type { CurrencyCode } from '@/types';
+export declare const DEFAULT_CURRENCY_ANALYTIC: CurrencyCode;

package/dist/esm/constants/index.d.ts

@@ -1,3 +1,6 @@
 export * from './analytic-metric-tooltip';
+export * from './breakdown-targets';
+export * from './campaign';
 export * from './chart';
+export * from './currency';
 export * from './thumbnail';

package/dist/esm/core/gemxql/helpers/extractQueryData.d.ts

@@ -1,5 +1,5 @@
 import type { GemxQlQueryResponse, TableDataType } from '../graphql';
 export type ColumnTypesMap = Record<string, TableDataType>;
 export declare const extractQueryRows: (response?: GemxQlQueryResponse) => Record<string, unknown>[];
-export declare const extractQueryColumns: (response?: GemxQlQueryResponse) => import("../graphql").Maybe<Pick<import("../graphql").IColumn, "displayName" | "dataType" | "name">>[];
+export declare const extractQueryColumns: (response?: GemxQlQueryResponse) => import("../graphql").Maybe<Pick<import("../graphql").IColumn, "dataType" | "displayName" | "name">>[];
 export declare const extractColumnTypes: (response?: GemxQlQueryResponse) => ColumnTypesMap;

package/dist/esm/core/gemxql/utils/dayjs.d.ts

@@ -4,5 +4,7 @@ export declare function getInitialTimezone(): string;
 export declare function setTz(value: string): void;
 export declare const dayjsTz: (date?: ConfigType) => Dayjs;
 export declare const convertDateToTz: (date?: ConfigType) => Dayjs;
+export declare const dayjsTzToLocalTZ: (date?: ConfigType) => Dayjs;
+export declare const dayjsTzToDate: (date?: ConfigType) => Date;
 export { dayjs };
 export type { Dayjs };

package/dist/esm/hooks/index.d.ts

@@ -0,0 +1,5 @@
+export { useEnhancedEffect } from './useEnhancedEffect';
+export { useToggle } from './useToggle';
+export { useFormatLineChartData } from './useFormatLineChartData';
+export { usePopoverResizeObserver } from './usePopoverResizeObserver';
+export { useWindowSize } from './useWindowSize';

package/dist/esm/hooks/useEnhancedEffect.d.ts

@@ -0,0 +1,2 @@
+import * as React from 'react';
+export declare const useEnhancedEffect: typeof React.useEffect;

package/dist/esm/hooks/useFormatLineChartData.d.ts

@@ -0,0 +1,11 @@
+import type { EMetricKey } from '@/types/metric';
+import type { ColumnTypesMap } from '@/core/gemxql';
+interface IProps {
+    metricKey?: EMetricKey;
+    columnTypes: ColumnTypesMap;
+}
+export declare const useFormatLineChartData: ({ metricKey, columnTypes }: IProps) => {
+    formatValue: (value: number) => string;
+    yAxisOptions: Partial<import("@shopify/polaris-viz-core").YAxisOptions>;
+};
+export {};

package/dist/esm/hooks/usePopoverResizeObserver.d.ts

@@ -0,0 +1,7 @@
+interface IUsePopoverResizeObserverOptions {
+    active: boolean;
+    onHeightChange?: (height: number) => void;
+    selector?: string;
+}
+export declare const usePopoverResizeObserver: ({ active, onHeightChange, selector, }: IUsePopoverResizeObserverOptions) => void;
+export {};

package/dist/esm/hooks/useToggle.d.ts

@@ -0,0 +1,12 @@
+interface IUseToggleReturn {
+    value: boolean;
+    toggle: () => void;
+    setTrue: () => void;
+    setFalse: () => void;
+}
+/**
+ * Returns a stateful value, and a set of memoized functions to toggle it,
+ * set it to true and set it to false
+ */
+export declare function useToggle(initialState: boolean): IUseToggleReturn;
+export {};

package/dist/esm/hooks/useWindowSize.d.ts

@@ -0,0 +1,18 @@
+export interface IWindowSize {
+    width: number;
+    height: number;
+}
+export interface IUseWindowSizeResult {
+    windowSize: IWindowSize;
+    windowWidth: {
+        xs: boolean;
+        md: boolean;
+        lg: boolean;
+        xsDown: boolean;
+        '1200Down': boolean;
+        '1040Down': boolean;
+    };
+    isMobileTabletView: boolean;
+    isMobileView: boolean;
+}
+export declare const useWindowSize: () => IUseWindowSizeResult;

package/dist/esm/index.d.ts

@@ -1,2 +1,5 @@
 export * from './components';
+export * from './constants';
 export * from './types';
+export * from './shared';
+export { EAnalyticColumnKey, EDeviceType, ETrafficSourceType, EVisitorType } from './core/gemxql';