@gravity-ui/page-constructor 1.19.1 → 1.20.0

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

@@ -318,6 +318,84 @@ export declare const LinkProps: {
             type: string;
             enum: string[];
         };
+        analyticsEvents: {
+            anyOf: ({
+                type: string;
+                additionalProperties: {
+                    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;
+                                };
+                            };
+                        };
+                    };
+                    context: {
+                        type: string;
+                    };
+                };
+            } | {
+                type: string;
+                items: {
+                    type: string;
+                    additionalProperties: {
+                        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;
+                                    };
+                                };
+                            };
+                        };
+                        context: {
+                            type: string;
+                        };
+                    };
+                };
+            })[];
+        };
         type: {};
         when: {};
     };
@@ -414,6 +492,9 @@ export declare const ButtonProps: {
             };
         })[];
     };
+    /**
+     * @deprecated Metrika will be deleted
+     */
     metrikaGoals: {
         anyOf: ({
             type: string;
@@ -443,6 +524,9 @@ export declare const ButtonProps: {
             };
         })[];
     };
+    /**
+     * @deprecated Pixel will be deleted
+     */
     pixelEvents: {
         type: string;
         items: {
@@ -499,6 +583,84 @@ export declare const ButtonProps: {
             };
         };
     };
+    analyticsEvents: {
+        anyOf: ({
+            type: string;
+            additionalProperties: {
+                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;
+                            };
+                        };
+                    };
+                };
+                context: {
+                    type: string;
+                };
+            };
+        } | {
+            type: string;
+            items: {
+                type: string;
+                additionalProperties: {
+                    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;
+                                };
+                            };
+                        };
+                    };
+                    context: {
+                        type: string;
+                    };
+                };
+            };
+        })[];
+    };
     target: {
         type: string;
         enum: string[];
@@ -558,6 +720,9 @@ export declare const BlockBaseProps: {
     resetPaddings: {
         type: string;
     };
+    context: {
+        type: string;
+    };
     type: {};
     when: {};
 };
@@ -629,6 +794,9 @@ export declare const ButtonBlock: {
                 };
             })[];
         };
+        /**
+         * @deprecated Metrika will be deleted
+         */
         metrikaGoals: {
             anyOf: ({
                 type: string;
@@ -658,6 +826,9 @@ export declare const ButtonBlock: {
                 };
             })[];
         };
+        /**
+         * @deprecated Pixel will be deleted
+         */
         pixelEvents: {
             type: string;
             items: {
@@ -714,6 +885,84 @@ export declare const ButtonBlock: {
                 };
             };
         };
+        analyticsEvents: {
+            anyOf: ({
+                type: string;
+                additionalProperties: {
+                    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;
+                                };
+                            };
+                        };
+                    };
+                    context: {
+                        type: string;
+                    };
+                };
+            } | {
+                type: string;
+                items: {
+                    type: string;
+                    additionalProperties: {
+                        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;
+                                    };
+                                };
+                            };
+                        };
+                        context: {
+                            type: string;
+                        };
+                    };
+                };
+            })[];
+        };
         target: {
             type: string;
             enum: string[];

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

@@ -1,6 +1,7 @@
 import { pixelEvents } from './pixel';
 import { Theme } from '../../models';
 import { ImageProps, urlPattern } from '../../components/Image/schema';
+import { AnalyticsEventSchema } from './event';
 export const mediaDirection = ['media-content', 'content-media'];
 export const textSize = ['s', 'm', 'l'];
 export const containerSizesArray = ['sm', 'md', 'lg', 'xl', 'all'];
@@ -174,6 +175,8 @@ export const LinkProps = {
         }, target: {
             type: 'string',
             enum: ['_blank', '_parent', '_top', '_self'],
+        }, analyticsEvents: {
+            anyOf: [AnalyticsEventSchema, { type: 'array', items: AnalyticsEventSchema }],
         } }),
 };
 export const FileLinkProps = {
@@ -306,6 +309,9 @@ export const ButtonProps = {
             },
         ],
     },
+    /**
+     * @deprecated Metrika will be deleted
+     */
     metrikaGoals: {
         anyOf: [
             { type: 'string' },
@@ -328,7 +334,13 @@ export const ButtonProps = {
             },
         ],
     },
+    /**
+     * @deprecated Pixel will be deleted
+     */
     pixelEvents,
+    analyticsEvents: {
+        anyOf: [AnalyticsEventSchema, { type: 'array', items: AnalyticsEventSchema }],
+    },
     target: {
         type: 'string',
         enum: ['_self', '_blank', '_parent', '_top'],
@@ -376,6 +388,8 @@ export const BlockBaseProps = Object.assign(Object.assign({}, BaseProps), { anch
         enum: containerSizesArray,
     }, resetPaddings: {
         type: 'boolean',
+    }, context: {
+        type: 'string',
     } });
 export const TitleProps = {
     type: 'object',

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

@@ -0,0 +1,37 @@
+export declare const AnalyticsEventSchema: {
+    type: string;
+    additionalProperties: {
+        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;
+                    };
+                };
+            };
+        };
+        context: {
+            type: string;
+        };
+    };
+};

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

@@ -0,0 +1,35 @@
+export const AnalyticsEventSchema = {
+    type: 'object',
+    additionalProperties: { type: 'string' },
+    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',
+                    },
+                },
+            },
+        },
+        context: {
+            type: 'string',
+        },
+    },
+};

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

@@ -3,15 +3,17 @@ 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 { DefaultEventNames } from '../../models';
+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, createDOMElement, onSubmitError, } = props;
+    analyticsEvents, onBeforeSubmit, onSubmit, onBeforeLoad, onLoad, createDOMElement, onSubmitError, } = props;
     const handleMetrika = useMetrika();
+    const handleAnalytics = useAnalytics(DefaultEventNames.HubspotFormSubmit);
     const { themeValue } = useContext(ThemeValueContext);
     const isMobileValue = useContext(MobileContext);
     const theme = themeProp !== null && themeProp !== void 0 ? themeProp : themeValue;
@@ -23,9 +25,20 @@ const HubspotForm = (props) => {
         onSubmitError,
         onSubmit: (e) => {
             handleMetrika === null || handleMetrika === void 0 ? void 0 : handleMetrika({ pixelEvents });
+            handleAnalytics(analyticsEvents);
             onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(e);
         },
-    }), [onBeforeLoad, onBeforeSubmit, onLoad, handleMetrika, pixelEvents, onSubmit, onSubmitError]);
+    }), [
+        onBeforeLoad,
+        onBeforeSubmit,
+        onLoad,
+        handleMetrika,
+        pixelEvents,
+        handleAnalytics,
+        analyticsEvents,
+        onSubmit,
+        onSubmitError,
+    ]);
     useHandleHubspotEvents(handlers, formId);
     return (React.createElement(HubspotFormContainer, { createDOMElement: createDOMElement, key: [formClassName, formId, formInstanceId, portalId, region].join(), className: b({ theme, mobile }, className), formClassName: formClassName, formId: formId, portalId: portalId, formInstanceId: formInstanceId, region: region }));
 };

package/build/esm/sub-blocks/LayoutItem/utils.d.ts

@@ -9,6 +9,19 @@ export declare const getLayoutItemLinks: (links: LayoutItemProps['content']['lin
     target?: string | undefined;
     metrikaGoals?: import("../../models").MetrikaGoal | undefined;
     pixelEvents?: import("../../models").ButtonPixel | undefined;
+    analyticsEvents?: {
+        name: string;
+        type?: string | undefined;
+        counters?: import("../../models").AnalyticsCounters | undefined;
+        context?: string | undefined;
+        target?: string | undefined;
+    } | {
+        name: string;
+        type?: string | undefined;
+        counters?: import("../../models").AnalyticsCounters | undefined;
+        context?: string | undefined;
+        target?: string | undefined;
+    }[] | undefined;
     className?: string | undefined;
 }[] | undefined;
 export declare const hasFullScreen: ({ dataLens, image }: MediaProps) => boolean;

package/build/esm/sub-blocks/Quote/Quote.js

@@ -1,10 +1,11 @@
-import React, { useContext } from 'react';
+import React, { useCallback, useContext } from 'react';
 import { Button } from '@gravity-ui/uikit';
 import { block, getThemedValue } from '../../utils';
-import { AuthorType } from '../../models';
+import { AuthorType, DefaultEventNames } from '../../models';
 import { Author, Image, HTML } from '../../components';
 import { ThemeValueContext } from '../../context/theme/ThemeValueContext';
 import { getMediaImage } from '../../components/Media/Image/utils';
+import { useAnalytics } from '../../hooks';
 import './Quote.css';
 const b = block('quote');
 const Quote = (props) => {
@@ -12,9 +13,11 @@ const Quote = (props) => {
     const { themeValue: theme } = useContext(ThemeValueContext);
     const imageThemed = getThemedValue(image, theme);
     const imageData = getMediaImage(imageThemed);
+    const handleAnalytics = useAnalytics(DefaultEventNames.QuoteButton, url);
+    const handleButtonClick = useCallback(() => handleAnalytics(), [handleAnalytics]);
     const renderFooter = Boolean(author || url) && (React.createElement("div", { className: b('author-wrapper') },
         author && (React.createElement(Author, { className: b('author', { theme: textTheme }), author: author, type: AuthorType.Line })),
-        url && buttonText && (React.createElement(Button, { view: "outlined", size: "xl", href: url, className: b('link-button', { theme: textTheme }) }, buttonText))));
+        url && buttonText && (React.createElement(Button, { view: "outlined", size: "xl", href: url, className: b('link-button', { theme: textTheme }), onClick: handleButtonClick }, buttonText))));
     return (React.createElement("div", { className: b({ theme: textTheme, border }), style: color ? { backgroundColor: color } : {} },
         React.createElement("div", { key: text, className: b('content-wrapper') },
             React.createElement("div", null,

package/build/esm/utils/analytics.d.ts

@@ -0,0 +1,2 @@
+import { AnalyticsCounters } from '../models';
+export declare const isCounterAllowed: (counter: string, counters?: AnalyticsCounters) => boolean;

package/build/esm/utils/analytics.js

@@ -0,0 +1,13 @@
+export const isCounterAllowed = (counter, counters) => {
+    var _a, _b;
+    if (!counters) {
+        return true;
+    }
+    if ((_a = counters.exclude) === null || _a === void 0 ? void 0 : _a.includes(counter)) {
+        return false;
+    }
+    else if ((_b = counters.include) === null || _b === void 0 ? void 0 : _b.includes(counter)) {
+        return true;
+    }
+    return false;
+};

package/build/esm/utils/index.d.ts

@@ -1,4 +1,5 @@
 export * from './common';
+export * from './analytics';
 export * from './blocks';
 export * from './scroll';
 export * from './url';

package/build/esm/utils/index.js

@@ -1,4 +1,5 @@
 export * from './common';
+export * from './analytics';
 export * from './blocks';
 export * from './scroll';
 export * from './url';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/page-constructor",
-  "version": "1.19.1",
+  "version": "1.20.0",
   "description": "Gravity UI Page Constructor",
   "license": "MIT",
   "repository": {

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,34 @@ export interface ClassNameProps {
     className?: string;
 }
 export type Timeout = ReturnType<typeof setTimeout> | undefined;
+export declare enum PredefinedEventTypes {
+    Default = "default-event",
+    Play = "play",
+    Stop = "stop"
+}
+export declare enum DefaultEventNames {
+    ShareButton = "share-button-click",
+    Button = "button-click",
+    CardBase = "card-base-click",
+    Link = "link-click",
+    ReactPlayerControls = "react-player-controls-click",
+    YandexFormSubmit = "yandex-form-submit",
+    HubspotFormSubmit = "hubspot-form-submit",
+    QuoteButton = "quote-button-click",
+    BackLink = "back-link-click"
+}
+export type AnalyticsCounters = {
+    include?: string[];
+    exclude?: string[];
+};
+export type AnalyticsEvent<T = {}> = T & {
+    name: string;
+    type?: string;
+    counters?: AnalyticsCounters;
+    context?: string;
+    target?: string;
+};
+export interface AnalyticsEventsBase {
+    analyticsEvents?: AnalyticsEvent | AnalyticsEvent[];
+}
 export {};

package/server/models/common.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PixelEventType = exports.Theme = void 0;
+exports.DefaultEventNames = exports.PredefinedEventTypes = exports.PixelEventType = exports.Theme = void 0;
 var Theme;
 (function (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";
@@ -27,3 +30,21 @@ var PixelEventType;
     PixelEventType["Subscribe"] = "Subscribe";
     PixelEventType["ViewContent"] = "ViewContent";
 })(PixelEventType = exports.PixelEventType || (exports.PixelEventType = {}));
+var PredefinedEventTypes;
+(function (PredefinedEventTypes) {
+    PredefinedEventTypes["Default"] = "default-event";
+    PredefinedEventTypes["Play"] = "play";
+    PredefinedEventTypes["Stop"] = "stop";
+})(PredefinedEventTypes = exports.PredefinedEventTypes || (exports.PredefinedEventTypes = {}));
+var DefaultEventNames;
+(function (DefaultEventNames) {
+    DefaultEventNames["ShareButton"] = "share-button-click";
+    DefaultEventNames["Button"] = "button-click";
+    DefaultEventNames["CardBase"] = "card-base-click";
+    DefaultEventNames["Link"] = "link-click";
+    DefaultEventNames["ReactPlayerControls"] = "react-player-controls-click";
+    DefaultEventNames["YandexFormSubmit"] = "yandex-form-submit";
+    DefaultEventNames["HubspotFormSubmit"] = "hubspot-form-submit";
+    DefaultEventNames["QuoteButton"] = "quote-button-click";
+    DefaultEventNames["BackLink"] = "back-link-click";
+})(DefaultEventNames = exports.DefaultEventNames || (exports.DefaultEventNames = {}));