@gem-sdk/analytics 1.0.0-dev.21

package/dist/umd/esm/shared/components/GActivatorPopover/GActivatorPopover.d.ts

@@ -0,0 +1,23 @@
+import type { BoxProps, IconSource, TextProps } from '@shopify/polaris';
+interface GActivatorPopoverProps {
+    onClick: () => void;
+    active: boolean;
+    content: string;
+    /**
+     * @param tone
+     *  - @default: `base` when inactive, `subdued` when active
+     *  - Overrides both states when provided
+     * @param variant
+     *  - @default: `bodyMd`
+     */
+    textProps?: Pick<TextProps, 'tone' | 'variant' | 'truncate'>;
+    /**
+     * @param disabled
+     *  - @default: `false`
+     */
+    boxProps?: BoxProps;
+    icon?: IconSource;
+    disabled?: boolean;
+}
+export declare const GActivatorPopover: ({ onClick, active, content, textProps, boxProps: customBoxProps, disabled, icon: customIcon, }: GActivatorPopoverProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/umd/esm/shared/components/GActivatorPopover/index.d.ts

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

package/dist/umd/esm/shared/components/GBlockCenter/GBlockCenter.d.ts

@@ -0,0 +1,15 @@
+import { type CSSProperties } from 'react';
+import type { BoxProps } from '@shopify/polaris';
+import './GBlockCenter.scss';
+export type SpaceScale = '0' | '025' | '050' | '100' | '150' | '200' | '300' | '400' | '500' | '600' | '800' | '1000' | '1200' | '1600' | '2000' | '2400' | '2800' | '3200';
+export interface GBlockCenterProps extends Omit<BoxProps, 'insetInlineStart' | 'insetInlineEnd' | 'insetBlockStart' | 'insetBlockEnd'> {
+    height?: string;
+    align?: 'center' | 'start' | 'end';
+    inlineAlign?: 'center' | 'start' | 'end';
+    display?: CSSProperties['display'];
+    insetInlineStart?: SpaceScale;
+    insetInlineEnd?: SpaceScale;
+    insetBlockStart?: SpaceScale;
+    insetBlockEnd?: SpaceScale;
+}
+export declare const GBlockCenter: ({ height, align, inlineAlign, display, ...props }: GBlockCenterProps) => import("react/jsx-runtime").JSX.Element;

package/dist/umd/esm/shared/components/GBlockCenter/index.d.ts

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

package/dist/umd/esm/shared/components/GButton/GButton.d.ts

@@ -0,0 +1,19 @@
+import type { ButtonProps, LinkProps } from '@shopify/polaris';
+import type { GTooltipProps } from '../GTooltip';
+import './GButton.scss';
+export interface GButtonProps extends Omit<ButtonProps, 'variant'> {
+    linkAction?: LinkProps;
+    activatorWrapper?: 'div' | 'span';
+    iconRight?: boolean;
+    stopPropagation?: boolean;
+    tooltip?: GTooltipProps;
+    themeTone?: 'dark' | 'light';
+    /**
+     * Adds padding="100" wrapper to compensate for tertiary variant's -4px margin.
+     * Also applies display="flex" automatically.
+     * Use this when placing tertiary buttons in tight layouts.
+     */
+    inset?: boolean;
+    variant?: ButtonProps['variant'] | 'neutral';
+}
+export declare const GButton: React.FC<GButtonProps>;

package/dist/umd/esm/shared/components/GButton/index.d.ts

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

package/dist/umd/esm/shared/components/GCheckbox/GCheckbox.d.ts

@@ -0,0 +1,39 @@
+import type { CheckboxProps, RadioButtonProps } from '@shopify/polaris';
+import type { GTooltipProps } from '@/shared';
+interface GCheckboxOptionBase {
+    value: string;
+    label: string;
+    selected: boolean;
+    tooltip?: GTooltipProps;
+    description?: string;
+}
+export interface GCheckboxSingleOption extends GCheckboxOptionBase, Omit<CheckboxProps, 'value' | 'onChange' | 'label'> {
+}
+export interface GCheckboxMultipleOption extends GCheckboxOptionBase, Omit<RadioButtonProps, 'value' | 'onChange' | 'label'> {
+}
+interface GCheckboxSingleProps {
+    multiple?: false;
+    options: GCheckboxSingleOption[];
+    onChange: (value: string) => void;
+    id?: string;
+}
+interface GCheckboxMultipleProps {
+    multiple: true;
+    /**
+     * @default false
+     */
+    emptySelected?: boolean;
+    selected?: string[];
+    options: GCheckboxMultipleOption[];
+    onChange: (values: string[]) => void;
+    onChangeSingleValue?: (value: string) => void;
+    id?: string;
+    itemHovered?: string;
+    onHover?: (value?: string) => void;
+    dependentDisabledValues?: Set<string>;
+}
+type GCheckboxProps = GCheckboxSingleProps | GCheckboxMultipleProps;
+export declare const GCheckbox: ({ ...props }: GCheckboxProps) => import("react/jsx-runtime").JSX.Element;
+export declare const GCheckboxMultiple: ({ options, onChange, onChangeSingleValue, emptySelected, selected, onHover, itemHovered, dependentDisabledValues, }: GCheckboxMultipleProps) => import("react/jsx-runtime").JSX.Element;
+export declare const GCheckboxSingle: ({ options, onChange }: GCheckboxSingleProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/umd/esm/shared/components/GCheckbox/index.d.ts

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

package/dist/umd/esm/shared/components/GChoice/ChoiceHelpText.d.ts

@@ -0,0 +1,4 @@
+import type { GChoiceProps } from './GChoice';
+export declare const ChoiceHelpText: ({ item }: {
+    item: GChoiceProps["item"];
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/umd/esm/shared/components/GChoice/GChoice.d.ts

@@ -0,0 +1,44 @@
+import type { BoxProps, TextProps } from '@shopify/polaris';
+export interface ChoiceOptionItem<T = string> {
+    label: string;
+    value: T;
+    type?: string;
+    description?: string;
+    icon?: React.ReactNode;
+    disabled?: boolean;
+    inlineAction?: {
+        content: string;
+        url?: string;
+        target?: string;
+        onAction?: () => void;
+    };
+    options?: {
+        children?: React.ReactNode;
+        position?: 'left' | 'right';
+    };
+}
+export interface StyleByState {
+    box: Pick<BoxProps, 'outlineWidth' | 'outlineColor' | 'background' | 'shadow' | 'paddingBlockStart' | 'paddingBlockEnd'>;
+    text: Pick<TextProps, 'fontWeight'>;
+}
+export type GChoiceBoxPaddingBase = Pick<BoxProps, 'padding' | 'paddingBlock' | 'paddingBlockStart' | 'paddingBlockEnd' | 'paddingInline' | 'paddingInlineStart' | 'paddingInlineEnd'>;
+export interface GChoiceProps {
+    item: ChoiceOptionItem;
+    isActive?: boolean;
+    disabled?: boolean;
+    isMultipleSelect?: boolean;
+    /**
+     * @default: { paddingBlockStart: '200', paddingBlockEnd: '200', paddingInlineStart: '400', paddingInlineEnd: '400' }
+     */
+    children?: React.ReactNode;
+    suffix?: React.ReactNode;
+    /**
+     * Position of children in GChoice
+     * @default: 'left'
+     */
+    position?: 'left' | 'right';
+    boxProps?: BoxProps;
+    activeStyle?: StyleByState;
+    onClick?: (value: string, type?: string) => void;
+}
+export declare const GChoice: ({ item, disabled, isActive, suffix, isMultipleSelect, onClick, children, position, boxProps, activeStyle, }: GChoiceProps) => import("react/jsx-runtime").JSX.Element;

package/dist/umd/esm/shared/components/GChoice/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GChoice';
+export * from './ChoiceHelpText';

package/dist/umd/esm/shared/components/GClickable/GClickable.d.ts

@@ -0,0 +1,10 @@
+interface GClickableProps {
+    children: React.ReactNode;
+    fullWidth?: boolean;
+    cursor?: 'pointer' | 'default' | 'not-allowed';
+    onClick: () => void;
+    onMouseEnter?: () => void;
+    onMouseLeave?: () => void;
+}
+export declare const GClickable: ({ children, fullWidth, cursor, onClick, onMouseEnter, onMouseLeave, }: GClickableProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/umd/esm/shared/components/GClickable/index.d.ts

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

package/dist/umd/esm/shared/components/GDiv/GDiv.d.ts

@@ -0,0 +1,7 @@
+import type { HTMLAttributes } from 'react';
+interface IProps extends HTMLAttributes<HTMLDivElement> {
+    children: React.ReactNode;
+    onClick?: (e?: React.MouseEvent<HTMLDivElement>) => void;
+}
+export declare const GDiv: import("react").ForwardRefExoticComponent<IProps & import("react").RefAttributes<HTMLDivElement>>;
+export {};

package/dist/umd/esm/shared/components/GDiv/index.d.ts

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

package/dist/umd/esm/shared/components/GI18NText/GI18NText.d.ts

@@ -0,0 +1,2 @@
+import type { IGI18NTextProps } from './types';
+export declare const GI18NText: (props: IGI18NTextProps) => import("react/jsx-runtime").JSX.Element;

package/dist/umd/esm/shared/components/GI18NText/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GI18NText';
+export * from './types';

package/dist/umd/esm/shared/components/GI18NText/types.d.ts

@@ -0,0 +1,6 @@
+import type { TextProps } from '@shopify/polaris';
+import type { ReactNode } from 'react';
+export interface IGI18NTextProps extends TextProps {
+    transformers?: Record<string, (childrenContent: string) => ReactNode>;
+    children: ReactNode;
+}

package/dist/umd/esm/shared/components/GOptionList/GOptionList.d.ts

@@ -0,0 +1,11 @@
+import type React from 'react';
+export interface GOptionListOption {
+    value: string;
+    label: React.ReactNode;
+}
+export interface GOptionListProps {
+    options: GOptionListOption[];
+    selected: string[];
+    onChange: (selected: string[]) => void;
+}
+export declare function GOptionList({ options, selected, onChange }: GOptionListProps): import("react/jsx-runtime").JSX.Element;

package/dist/umd/esm/shared/components/GOptionList/index.d.ts

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

package/dist/umd/esm/shared/components/GSelector/GSelector.d.ts

@@ -0,0 +1,27 @@
+import type { ActionListItemDescriptor } from '@shopify/polaris';
+export interface GSelectorOption extends ActionListItemDescriptor {
+    id: string;
+}
+export interface GSelectorBaseProps {
+    minWidth?: string;
+    maxWidth?: string;
+    activatorText: string;
+    options: GSelectorOption[];
+    preferredAlignment?: 'left' | 'right';
+    emptyLabel?: string;
+    formatActivatorContent?: (text: string[]) => string;
+}
+export interface GSelectorChoiceProps extends GSelectorBaseProps {
+    variant: 'choice';
+    selected?: string[];
+    clearable?: boolean;
+    onSelect: (value: string[]) => void;
+}
+export interface GSelectorActionListProps extends GSelectorBaseProps {
+    variant: 'action-list';
+    helpText?: React.ReactNode;
+    selected?: string;
+    onSelect: (value: string) => void;
+}
+export type GSelectorProps = GSelectorChoiceProps | GSelectorActionListProps;
+export declare const GSelector: React.FC<GSelectorProps>;

package/dist/umd/esm/shared/components/GSelector/index.d.ts

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

package/dist/umd/esm/shared/components/GSkeletonDisplayText/GSkeletonDisplayText.d.ts

@@ -0,0 +1,4 @@
+export interface GSkeletonDisplayTextProps {
+    height?: `${number}ch` | `${number}%` | `${number}px`;
+}
+export declare const GSkeletonDisplayText: React.FC<GSkeletonDisplayTextProps>;

package/dist/umd/esm/shared/components/GSkeletonDisplayText/index.d.ts

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

package/dist/umd/esm/shared/components/GTextLink/GTextLink.d.ts

@@ -0,0 +1,9 @@
+import type { LinkProps } from '@shopify/polaris';
+import type { ReactNode } from 'react';
+export interface GTextLinkProps {
+    children: ReactNode;
+    linkAction?: LinkProps;
+    isDisabled?: boolean;
+    disabledFocus?: boolean;
+}
+export declare const GTextLink: ({ linkAction, isDisabled, disabledFocus, children }: GTextLinkProps) => import("react/jsx-runtime").JSX.Element;

package/dist/umd/esm/shared/components/GTextLink/index.d.ts

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

package/dist/umd/esm/shared/components/GThumbnail/GThumbnail.d.ts

@@ -0,0 +1,20 @@
+import type { ThumbnailProps } from '@shopify/polaris';
+export interface GThumbnailProps extends ThumbnailProps {
+    defaultSource?: string;
+    width?: string;
+    height?: string;
+    classRemoved?: boolean;
+    isInactive?: boolean;
+    /**
+     * @description Filter to apply grayscale to the image
+     */
+    grayscale?: `${number}%`;
+}
+/**
+ * Helper function to generate a variation class name.
+ * @param name - Base name of the class.
+ * @param value - Variation value to append.
+ * @returns Combined class name.
+ */
+export declare function variationName(name: string, value: string): string;
+export declare const GThumbnail: ({ source, alt, size, grayscale, defaultSource, width, height, classRemoved, }: GThumbnailProps) => import("react/jsx-runtime").JSX.Element;

package/dist/umd/esm/shared/components/GThumbnail/index.d.ts

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

package/dist/umd/esm/shared/components/GTooltip/GTooltip.d.ts

@@ -0,0 +1,22 @@
+import type { TooltipProps } from '@shopify/polaris';
+export interface GTooltipProps extends Omit<TooltipProps, 'content'> {
+    /**
+     * @default true
+     */
+    isEnabled?: boolean;
+    content?: React.ReactNode | string;
+    /**
+     * - large: 285px
+     * - extra-large: 340px
+     * - double-extra-large: 360px
+     * @param maxWidth 'large' | 'extra-large' | 'double-extra-large'
+     * @default undefined
+     */
+    maxWidth?: 'large' | 'extra-large' | 'double-extra-large';
+    activatorWrapper?: 'tooltip-content' | 'g-tooltip-card' | string;
+    /**
+     * @default 500ms
+     */
+    hoverDelay?: number;
+}
+export declare const GTooltip: ({ isEnabled, content, maxWidth, ...props }: GTooltipProps) => React.ReactNode;

package/dist/umd/esm/shared/components/GTooltip/index.d.ts

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

package/dist/umd/esm/shared/components/GTooltipCard/GTooltipCard.d.ts

@@ -0,0 +1,32 @@
+import type { BoxProps } from '@shopify/polaris';
+type CloseTarget = 'activator' | 'next-node';
+export interface PopoverPublicAPI {
+    forceUpdatePosition(): void;
+    close(target?: CloseTarget): void;
+}
+export interface GTooltipCardPublicAPI {
+    onClose(): void;
+}
+type Width = 'default' | 'wide' | 'large';
+export interface GTooltipCardData {
+    title: string;
+    content: string | TrustedHTML;
+    formula?: React.ReactNode;
+    contentList?: string[];
+    width?: Width;
+}
+export interface IProps {
+    children: React.ReactNode;
+    delay?: number;
+    tooltip?: GTooltipCardData;
+    activatorProps?: BoxProps;
+    wrapper?: 'span' | 'div';
+    isHideBorder?: boolean;
+    alignment?: 'start' | 'center' | 'end';
+    textDecoration?: 'underline' | 'none';
+    preferredAlignment?: 'left' | 'center' | 'right';
+    popoverRef?: React.RefObject<PopoverPublicAPI>;
+    showArrow?: boolean;
+}
+export declare const GTooltipCard: import("react").ForwardRefExoticComponent<IProps & import("react").RefAttributes<GTooltipCardPublicAPI>>;
+export {};

package/dist/umd/esm/shared/components/GTooltipCard/index.d.ts

@@ -0,0 +1,2 @@
+export { GTooltipCard } from './GTooltipCard';
+export type { GTooltipCardData, GTooltipCardPublicAPI, IProps as IGTooltipCardProps, PopoverPublicAPI, } from './GTooltipCard';

package/dist/umd/esm/shared/components/GViewBySelector/GViewBySelector.d.ts

@@ -0,0 +1,17 @@
+export interface GViewBySelectorOption {
+    id: string;
+    title?: string;
+    content: string;
+    helpText: string;
+    icon: string;
+}
+export interface GViewBySelectorProps {
+    minWidth?: string;
+    maxWidth?: string;
+    activatorText: string;
+    options: GViewBySelectorOption[];
+    selected?: string;
+    onSelect: (value: string) => void;
+    preferredAlignment?: 'left' | 'right';
+}
+export declare const GViewBySelector: React.FC<GViewBySelectorProps>;

package/dist/umd/esm/shared/components/GViewBySelector/index.d.ts

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

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

@@ -0,0 +1,16 @@
+export * from './GActivatorPopover';
+export * from './GBlockCenter';
+export * from './GButton';
+export * from './GCheckbox';
+export * from './GClickable';
+export * from './GDiv';
+export * from './GI18NText';
+export * from './GOptionList';
+export * from './GSelector';
+export * from './GTextLink';
+export * from './GSkeletonDisplayText';
+export * from './GThumbnail';
+export * from './GTooltip';
+export * from './GTooltipCard';
+export * from './GViewBySelector';
+export * from './GChoice';

package/dist/umd/esm/shared/index.d.ts

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

package/dist/umd/esm/stores/currencyRatesStore.d.ts

@@ -0,0 +1,7 @@
+export type ICurrencyRates = Record<string, number>;
+interface ICurrencyRatesStore {
+    currencyRates: ICurrencyRates | null;
+    setCurrencyRates: (rates: ICurrencyRates) => void;
+}
+export declare const useCurrencyRatesStore: import("zustand").UseBoundStore<import("zustand").StoreApi<ICurrencyRatesStore>>;
+export {};

package/dist/umd/esm/stores/index.d.ts

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

package/dist/umd/esm/types/analytic-mode.d.ts

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

package/dist/umd/esm/types/breakdown-items.d.ts

@@ -0,0 +1,19 @@
+export declare enum EVisitorType {
+    NEW = "new",
+    RETURNING = "returning"
+}
+export declare enum EDeviceType {
+    DESKTOP = "desktop",
+    MOBILE = "mobile",
+    TABLET = "tablet"
+}
+export declare 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/dist/umd/esm/types/chart.d.ts

@@ -0,0 +1,33 @@
+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[];
+}>;