@gem-sdk/analytics 1.0.0-dev.21

package/dist/esm/core/gemxql/types/extra-condition.d.ts

@@ -0,0 +1,28 @@
+export declare enum EComparisonOperator {
+    EQ = "=",
+    IN = "IN",
+    LIKE = "LIKE"
+}
+export declare enum EGroupOperator {
+    OR = "OR",
+    AND = "AND"
+}
+export type IExtraConditionEq = {
+    operator: EComparisonOperator.EQ;
+    fields: string[];
+    value: string | number;
+    groupOperator?: EGroupOperator;
+};
+export type IExtraConditionIn = {
+    operator: EComparisonOperator.IN;
+    fields: string[];
+    values: Array<string | number>;
+    groupOperator?: EGroupOperator;
+};
+export type IExtraConditionLike = {
+    operator: EComparisonOperator.LIKE;
+    fields: string[];
+    value: string;
+    groupOperator?: EGroupOperator;
+};
+export type IExtraCondition = IExtraConditionEq | IExtraConditionIn | IExtraConditionLike;

package/dist/esm/core/gemxql/types/field-filters.d.ts

@@ -0,0 +1,18 @@
+export declare enum EFilterField {
+    DEVICE = "device",
+    DEVICES = "devices",
+    VISITOR = "visitor_type",
+    VISITORS = "visitor_types",
+    TRAFFIC_SOURCE = "traffic_source",
+    TRAFFIC_SOURCES = "traffic_sources",
+    VERSION = "version",
+    VERSIONS = "versions",
+    SINGLE_PAGE = "page_path",
+    LIST_PAGE = "page_paths",
+    GROUP_CAMPAIGN_ITEM = "group_campaign_item",
+    GROUP_CAMPAIGN_ITEMS = "group_campaign_items",
+    SINGLE_CAMPAIGN = "experiment_id",
+    GROUP_CAMPAIGN = "experiment_group_id",
+    CAMPAIGN_VERSION_ID = "version_id",
+    GROUP_CAMPAIGN_VERSION_ID = "group_version_id"
+}

package/dist/esm/core/gemxql/types/field-operators.d.ts

@@ -0,0 +1,8 @@
+export declare enum EOperatorField {
+    DEVICE_OPERATOR = "deviceOperator",
+    VISITOR_OPERATOR = "visitorOperator",
+    TRAFFIC_SOURCE_OPERATOR = "trafficSourceOperator",
+    VERSION_OPERATOR = "versionOperator",
+    PAGE_OPERATOR = "pageOperator",
+    CAMPAIGN_ITEM_OPERATOR = "campaignItemOperator"
+}

package/dist/esm/core/gemxql/types/filter-types.d.ts

@@ -0,0 +1,28 @@
+import type { EFilterField } from './field-filters';
+import type { EOperatorField } from './field-operators';
+export type GemXQlFilters = {
+    [EFilterField.DEVICE]?: string;
+    [EFilterField.VISITOR]?: string;
+    [EFilterField.TRAFFIC_SOURCE]?: string;
+    [EFilterField.VERSION]?: string;
+    [EFilterField.SINGLE_PAGE]?: string;
+    [EFilterField.GROUP_CAMPAIGN_ITEM]?: string;
+    [EFilterField.SINGLE_CAMPAIGN]?: string;
+    [EFilterField.CAMPAIGN_VERSION_ID]?: string;
+    [EFilterField.GROUP_CAMPAIGN_VERSION_ID]?: string;
+    [EFilterField.DEVICES]?: string[];
+    [EFilterField.VISITORS]?: string[];
+    [EFilterField.TRAFFIC_SOURCES]?: string[];
+    [EFilterField.VERSIONS]?: string[];
+    [EFilterField.LIST_PAGE]?: string[];
+    [EFilterField.GROUP_CAMPAIGN_ITEMS]?: string[];
+    [EFilterField.GROUP_CAMPAIGN]?: string[];
+    [EOperatorField.DEVICE_OPERATOR]?: string;
+    [EOperatorField.VISITOR_OPERATOR]?: string;
+    [EOperatorField.TRAFFIC_SOURCE_OPERATOR]?: string;
+    [EOperatorField.VERSION_OPERATOR]?: string;
+    [EOperatorField.PAGE_OPERATOR]?: string;
+    [EOperatorField.CAMPAIGN_ITEM_OPERATOR]?: string;
+};
+export type GemXQlOverrideFilters = GemXQlFilters;
+export type GemXQlVersionIds = Record<string, string | undefined>;

package/dist/esm/core/gemxql/types/group-with-clause.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Controls which totals columns are appended to the query result.
+ *
+ * - NONE   → no totals, GROUP BY only.
+ * - TOTALS → adds `<metric>___totals` (grand total only). Use with single-dimension GROUP BY.
+ * - ALL    → adds subtotals per dimension group + grand total. Use with multi-dimension GROUP BY.
+ */
+export declare enum EGroupWithClause {
+    NONE = "",
+    TOTALS = "TOTALS",
+    ALL = "WITH GROUP_TOTALS, TOTALS"
+}

package/dist/esm/core/gemxql/types/index.d.ts

@@ -0,0 +1,11 @@
+export * from './analytic-data';
+export * from './analytic-source';
+export * from './extra-condition';
+export * from './field-filters';
+export * from './field-operators';
+export * from './filter-types';
+export * from './group-with-clause';
+export * from './order-by';
+export * from './page-fields';
+export * from './row-reader-mode';
+export * from './time-dimension';

package/dist/esm/core/gemxql/types/order-by.d.ts

@@ -0,0 +1,10 @@
+export declare enum EOrderDirectionType {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export type OrderDirectionType = EOrderDirectionType.ASC | EOrderDirectionType.DESC;
+export type OrderByType = {
+    field: string;
+    direction: OrderDirectionType;
+};
+export type OrderByFields = Record<string, OrderByType>;

package/dist/esm/core/gemxql/types/page-fields.d.ts

@@ -0,0 +1,22 @@
+export declare enum EPageMetric {
+    PAGE_ITEMS = "page_items",
+    PAGE_PATHS = "page_paths"
+}
+export declare enum EPageDimension {
+    PAGE_PATH = "page_path"
+}
+export declare enum EPageField {
+    SHOPIFY_PAGE_ID = "shopify_page_id",
+    LOCATION_PATH = "location_path",
+    PAGE_TYPE = "page_type",
+    PAGE_TITLE = "page_title",
+    PAGE_PATH = "page_path",
+    TEMPLATE_SUFFIX = "template_suffix"
+}
+export interface IPageItemsPayload {
+    [EPageField.SHOPIFY_PAGE_ID]: string;
+    [EPageField.LOCATION_PATH]: string;
+    [EPageField.PAGE_TYPE]: string;
+    [EPageField.PAGE_TITLE]: string;
+    [EPageField.TEMPLATE_SUFFIX]: string;
+}

package/dist/esm/core/gemxql/types/row-reader-mode.d.ts

@@ -0,0 +1,6 @@
+export declare enum ERowReaderMode {
+    DEFAULT = "DEFAULT",
+    COMPARISON = "COMPARISON",
+    TOTALS = "TOTALS",
+    COMPARISON_TOTALS = "COMPARISON_TOTALS"
+}

package/dist/esm/core/gemxql/types/time-dimension.d.ts

@@ -0,0 +1,8 @@
+export declare enum ETimeDimension {
+    HOUR = "hour",
+    DAY = "day",
+    WEEK = "week",
+    MONTH = "month",
+    QUARTER = "quarter",
+    YEAR = "year"
+}