@gravity-ui/page-constructor 1.14.0 → 1.15.0-alpha.0

package/build/esm/schema/validators/event.d.ts

@@ -0,0 +1,91 @@
+export declare const AnalyticsEventSchema: {
+    type: string;
+    additionalProperties: boolean;
+    required: string[];
+    properties: {
+        name: {
+            type: string;
+        };
+        type: {
+            type: string;
+        };
+        counters: {
+            type: string;
+            additionalProperties: boolean;
+            required: never[];
+            properties: {
+                include: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                exclude: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+            };
+        };
+        category: {
+            type: string;
+        };
+        label: {
+            type: string;
+        };
+        params: {
+            type: string;
+            items: {
+                type: string;
+                additionalProperties: boolean;
+                required: string[];
+                properties: {
+                    key: {
+                        type: string;
+                    };
+                    value: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+};
+export declare const AnalyticsEventV2Schema: {
+    type: string;
+    propertyNames: {
+        type: string;
+    };
+    additionalProperty: {
+        type: string;
+    };
+    required: string[];
+    properties: {
+        name: {
+            type: string;
+        };
+        type: {
+            type: string;
+        };
+        counters: {
+            type: string;
+            additionalProperties: boolean;
+            required: never[];
+            properties: {
+                include: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+                exclude: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+};

package/build/esm/schema/validators/event.js

@@ -0,0 +1,87 @@
+export const AnalyticsEventSchema = {
+    type: 'object',
+    additionalProperties: false,
+    required: ['name'],
+    properties: {
+        name: {
+            type: 'string',
+        },
+        type: {
+            type: 'string',
+        },
+        counters: {
+            type: 'object',
+            additionalProperties: false,
+            required: [],
+            properties: {
+                include: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                },
+                exclude: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                },
+            },
+        },
+        category: {
+            type: 'string',
+        },
+        label: {
+            type: 'string',
+        },
+        params: {
+            type: 'array',
+            items: {
+                type: 'object',
+                additionalProperties: false,
+                required: ['key', 'value'],
+                properties: {
+                    key: {
+                        type: 'string',
+                    },
+                    value: {
+                        type: 'string',
+                    },
+                },
+            },
+        },
+    },
+};
+export const AnalyticsEventV2Schema = {
+    type: 'object',
+    propertyNames: { type: 'string' },
+    additionalProperty: { type: 'number' },
+    required: ['name'],
+    properties: {
+        name: {
+            type: 'string',
+        },
+        type: {
+            type: 'string',
+        },
+        counters: {
+            type: 'object',
+            additionalProperties: false,
+            required: [],
+            properties: {
+                include: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                },
+                exclude: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                },
+            },
+        },
+    },
+};

package/build/esm/sub-blocks/HubspotForm/index.js

@@ -3,15 +3,16 @@ import { block } from '../../utils';
 import { ThemeValueContext } from '../../context/theme/ThemeValueContext';
 import { MobileContext } from '../../context/mobileContext';
 import { useMetrika } from '../../hooks/useMetrika';
-import { useHandleHubspotEvents } from '../../hooks';
+import { useHandleHubspotEvents, useAnalytics } from '../../hooks';
 import HubspotFormContainer from './HubspotFormContainer';
 import './HubspotForm.css';
 const b = block('hubspot-form');
 const HubspotForm = (props) => {
     const { className, theme: themeProp, isMobile: isMobileProp, formId, formInstanceId, portalId, region, formClassName, pixelEvents, 
     // hubspotEvents, // TODO: decide how to handle them
-    onBeforeSubmit, onSubmit, onBeforeLoad, onLoad, } = props;
+    analyticsEvents, onBeforeSubmit, onSubmit, onBeforeLoad, onLoad, } = props;
     const handleMetrika = useMetrika();
+    const handleAnalytics = useAnalytics();
     const { themeValue } = useContext(ThemeValueContext);
     const isMobileValue = useContext(MobileContext);
     const theme = themeProp !== null && themeProp !== void 0 ? themeProp : themeValue;
@@ -22,9 +23,19 @@ const HubspotForm = (props) => {
         onLoad,
         onSubmit: (e) => {
             handleMetrika === null || handleMetrika === void 0 ? void 0 : handleMetrika({ pixelEvents });
+            handleAnalytics === null || handleAnalytics === void 0 ? void 0 : handleAnalytics(analyticsEvents);
             onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(e);
         },
-    }), [onBeforeLoad, onBeforeSubmit, onLoad, handleMetrika, pixelEvents, onSubmit]);
+    }), [
+        onBeforeLoad,
+        onBeforeSubmit,
+        onLoad,
+        handleMetrika,
+        pixelEvents,
+        handleAnalytics,
+        analyticsEvents,
+        onSubmit,
+    ]);
     useHandleHubspotEvents(handlers, formId);
     return (React.createElement(HubspotFormContainer, { key: [formClassName, formId, formInstanceId, portalId, region].join(), className: b({ theme, mobile }, className), formClassName: formClassName, formId: formId, portalId: portalId, formInstanceId: formInstanceId, region: region }));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/page-constructor",
-  "version": "1.14.0",
+  "version": "1.15.0-alpha.0",
   "description": "Gravity UI Page Constructor",
   "license": "MIT",
   "repository": {
@@ -132,5 +132,8 @@
     "*.{json,yaml,yml,md}": [
       "prettier --write"
     ]
+  },
+  "publishConfig": {
+    "tag": "alpha"
   }
 }

package/server/models/common.d.ts

@@ -7,12 +7,21 @@ export declare enum Theme {
     Light = "light",
     Dark = "dark"
 }
+/**
+ * @deprecated Pixel will be deleted
+ */
 type PixelCommand = 'track' | 'trackCustom';
+/**
+ * @deprecated Pixel will be deleted
+ */
 export interface PixelEvent {
     command: PixelCommand;
     event: PixelEventType | string;
     data?: Object;
 }
+/**
+ * @deprecated Pixel will be deleted from package
+ */
 export declare enum PixelEventType {
     AddPaymentInfo = "AddPaymentInfo",
     AddToCart = "AddToCart",
@@ -36,11 +45,17 @@ export declare enum PixelEventType {
 export type Modifiers = {
     [name: string]: string | boolean | undefined;
 };
+/**
+ * @deprecated Pixel will be deleted
+ */
 export interface Pixel<TEvent = string> {
     trackStandard: (event: TEvent, data?: Object) => void;
     trackCustom: (event: string, data?: Object) => void;
     track: (trackEvents: string | string[] | PixelEvent[] | PixelEvent) => void;
 }
+/**
+ * @deprecated Metrika will be deleted
+ */
 export interface Metrika {
     reachGoal: (counterName: string, ...args: any) => void;
     reachGoals: (goals: MetrikaGoal, counterName?: string) => void;
@@ -49,4 +64,25 @@ export interface ClassNameProps {
     className?: string;
 }
 export type Timeout = ReturnType<typeof setTimeout> | undefined;
+export type AnalyticsParameter = {
+    key: string;
+    value: string | number | boolean;
+};
+export type AnalyticsCounters = {
+    include?: string[];
+    exclude?: string[];
+};
+export type AnalyticsEvent = {
+    name: string;
+    type?: string;
+    counters?: AnalyticsCounters;
+    category?: string;
+    label?: string;
+    params?: AnalyticsParameter[];
+};
+export type AnalyticsEventV2<T = {}> = T & {
+    name: string;
+    type?: string;
+    counters?: AnalyticsCounters;
+};
 export {};

package/server/models/common.js

@@ -6,6 +6,9 @@ var Theme;
     Theme["Light"] = "light";
     Theme["Dark"] = "dark";
 })(Theme = exports.Theme || (exports.Theme = {}));
+/**
+ * @deprecated Pixel will be deleted from package
+ */
 var PixelEventType;
 (function (PixelEventType) {
     PixelEventType["AddPaymentInfo"] = "AddPaymentInfo";

package/server/models/constructor-items/common.d.ts

@@ -1,7 +1,7 @@
 import { CSSProperties, ReactNode } from 'react';
 import { ButtonSize, ButtonView } from '@gravity-ui/uikit';
 import { ThemeSupporting } from '../../utils/theme';
-import { ClassNameProps, PixelEventType } from '../common';
+import { AnalyticsEventV2, ClassNameProps, PixelEventType } from '../common';
 export declare enum AuthorType {
     Column = "column",
     Line = "line"
@@ -110,6 +110,7 @@ export interface MediaVideoProps {
     playButton?: PlayButtonProps;
     controls?: MediaVideoControlsType;
     metrika?: MetrikaVideo;
+    analyticsEvents?: AnalyticsEventV2[];
 }
 export interface LinkProps extends Stylable {
     url: string;
@@ -121,6 +122,7 @@ export interface LinkProps extends Stylable {
     target?: string;
     metrikaGoals?: MetrikaGoal;
     pixelEvents?: ButtonPixel;
+    analyticsEvents?: AnalyticsEventV2 | AnalyticsEventV2[];
 }
 export interface FileLinkProps extends ClassNameProps {
     href: string;
@@ -139,6 +141,7 @@ export interface ButtonProps {
     img?: ButtonImageProps | string;
     metrikaGoals?: MetrikaGoal;
     pixelEvents?: ButtonPixel;
+    analyticsEvents?: AnalyticsEventV2[];
     target?: string;
 }
 export interface ButtonImageProps {
@@ -167,6 +170,7 @@ export interface MediaComponentVideoProps {
     video: MediaVideoProps;
     height?: number;
     metrika?: MetrikaVideo;
+    analyticsEvents?: AnalyticsEventV2[];
     previewImg?: string;
 }
 export interface MediaComponentYoutubeProps {
@@ -222,6 +226,7 @@ export interface HeaderBreadCrumbsProps extends ClassNameProps {
     theme?: TextTheme;
     metrikaGoals?: MetrikaGoal;
     pixelEvents?: ButtonPixel;
+    analyticsEvents?: AnalyticsEventV2 | AnalyticsEventV2[];
 }
 export interface PreviewContentItemProps {
     title: string;

package/server/models/constructor-items/sub-blocks.d.ts

@@ -3,7 +3,7 @@ import { ThemeSupporting } from '../../utils';
 import { HubspotEventData, HubspotEventHandlers } from '../../utils/hubspot';
 import { AuthorItem, ButtonPixel, ButtonProps, CardBaseProps, ContentTheme, DividerSize, ImageObjectProps, ImageProps, LinkProps, MediaProps, PriceDetailedProps, TextTheme, Themable, ThemedImage } from './common';
 import { ContentBlockProps } from './blocks';
-import { PixelEvent } from '../common';
+import { AnalyticsEventV2, PixelEvent } from '../common';
 export declare enum SubBlockType {
     Divider = "divider",
     Quote = "quote",
@@ -61,6 +61,7 @@ export interface HubspotFormProps extends HubspotEventHandlers {
     onLoad?: (arg: HubspotEventData) => void;
     pixelEvents?: string | string[] | PixelEvent | PixelEvent[] | ButtonPixel;
     hubspotEvents?: string[];
+    analyticsEvents?: AnalyticsEventV2 | AnalyticsEventV2[];
 }
 export interface PartnerProps extends CardBaseProps {
     text: string;