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

package/build/cjs/containers/PageConstructor/Provider.js

@@ -4,6 +4,7 @@ exports.PageConstructorProvider = void 0;
 const tslib_1 = require("tslib");
 const react_1 = tslib_1.__importStar(require("react"));
 const metrikaContext_1 = require("../../context/metrikaContext");
+const analyticsContext_1 = require("../../context/analyticsContext");
 const mobileContext_1 = require("../../context/mobileContext");
 const projectSettingsContext_1 = require("../../context/projectSettingsContext");
 const ssrContext_1 = require("../../context/ssrContext");
@@ -12,7 +13,7 @@ const locationContext_1 = require("../../context/locationContext");
 const ThemeValueContext_1 = require("../../context/theme/ThemeValueContext");
 const constants_1 = require("../../components/constants");
 const PageConstructorProvider = (props) => {
-    const { isMobile, locale = {}, location = {}, metrika = {}, ssrConfig = {}, projectSettings = {}, theme = constants_1.DEFAULT_THEME, children, } = props;
+    const { isMobile, locale = {}, location = {}, metrika = {}, analytics = {}, ssrConfig = {}, projectSettings = {}, theme = constants_1.DEFAULT_THEME, children, } = props;
     /* eslint-disable react/jsx-key */
     const context = [
         react_1.default.createElement(ThemeValueContext_1.ThemeValueContext.Provider, { value: { themeValue: theme } }),
@@ -21,6 +22,7 @@ const PageConstructorProvider = (props) => {
         react_1.default.createElement(locationContext_1.LocationContext.Provider, { value: location }),
         react_1.default.createElement(mobileContext_1.MobileContext.Provider, { value: Boolean(isMobile) }),
         react_1.default.createElement(metrikaContext_1.MetrikaContext.Provider, { value: metrika }),
+        react_1.default.createElement(analyticsContext_1.AnalyticsContext.Provider, { value: analytics }),
         react_1.default.createElement(ssrContext_1.SSRContext.Provider, { value: { isServer: ssrConfig === null || ssrConfig === void 0 ? void 0 : ssrConfig.isServer } }),
     ].reduceRight((prev, provider) => react_1.default.cloneElement(provider, {}, prev), children);
     /* eslint-enable react/jsx-key */

package/build/cjs/context/analyticsContext/analyticsContext.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { AnalyticsEventV2 } from '../../models';
+export interface AnalyticsContextProps {
+    sendEvents?: (e: AnalyticsEventV2 | AnalyticsEventV2[]) => void;
+}
+export declare const AnalyticsContext: React.Context<AnalyticsContextProps>;

package/build/cjs/context/analyticsContext/analyticsContext.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsContext = void 0;
+const tslib_1 = require("tslib");
+const react_1 = tslib_1.__importDefault(require("react"));
+exports.AnalyticsContext = react_1.default.createContext({});

package/build/cjs/context/analyticsContext/index.d.ts

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

package/build/cjs/context/analyticsContext/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./analyticsContext"), exports);

package/build/cjs/context/metrikaContext/metrikaContext.d.ts

@@ -1,7 +1,13 @@
 import React from 'react';
 import { Metrika, Pixel } from '../../models';
 export interface MetrikaContextProps {
+    /**
+     * @deprecated Metrika will be deleted
+     */
     metrika?: Metrika;
+    /**
+     * @deprecated Metrika will be deleted
+     */
     pixel?: Pixel;
 }
 export declare const MetrikaContext: React.Context<MetrikaContextProps>;

package/build/cjs/hooks/index.d.ts

@@ -2,4 +2,5 @@ export { default as useFocus } from './useFocus';
 export { default as useWindowBreakpoint } from './useWindowBreakpoint';
 export { useIntersection } from './useIntersection';
 export { default as useMount } from './useMount';
+export * from './useAnalytics';
 export * from './hubspot';

package/build/cjs/hooks/index.js

@@ -10,4 +10,5 @@ var useIntersection_1 = require("./useIntersection");
 Object.defineProperty(exports, "useIntersection", { enumerable: true, get: function () { return useIntersection_1.useIntersection; } });
 var useMount_1 = require("./useMount");
 Object.defineProperty(exports, "useMount", { enumerable: true, get: function () { return tslib_1.__importDefault(useMount_1).default; } });
+tslib_1.__exportStar(require("./useAnalytics"), exports);
 tslib_1.__exportStar(require("./hubspot"), exports);

package/build/cjs/hooks/useAnalytics.d.ts

@@ -0,0 +1,2 @@
+import { AnalyticsEventV2 } from '../models';
+export declare const useAnalytics: () => ((e?: AnalyticsEventV2 | AnalyticsEventV2[]) => void) | undefined;

package/build/cjs/hooks/useAnalytics.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useAnalytics = void 0;
+const react_1 = require("react");
+const analyticsContext_1 = require("../context/analyticsContext");
+const useAnalytics = () => {
+    const { sendEvents } = (0, react_1.useContext)(analyticsContext_1.AnalyticsContext);
+    if (!sendEvents) {
+        return undefined;
+    }
+    return (e) => {
+        if (!e) {
+            return;
+        }
+        sendEvents(e);
+    };
+};
+exports.useAnalytics = useAnalytics;

package/build/cjs/hooks/useMetrika.d.ts

@@ -1,7 +1,13 @@
 import { ButtonPixel, MetrikaGoal, PixelEvent } from '../models';
+/**
+ * @deprecated Metrika will be deleted
+ */
 type UseMetrikaProps = {
     metrikaGoals?: MetrikaGoal;
     pixelEvents?: string | string[] | PixelEvent | PixelEvent[] | ButtonPixel;
 };
+/**
+ * @deprecated useMetrika will be deleted
+ */
 export declare const useMetrika: () => ({ metrikaGoals, pixelEvents }: UseMetrikaProps) => void;
 export {};

package/build/cjs/hooks/useMetrika.js

@@ -5,12 +5,20 @@ const react_1 = require("react");
 const metrikaContext_1 = require("../context/metrikaContext");
 const models_1 = require("../models");
 const guards_1 = require("../models/guards");
+// eslint-disable-next-line valid-jsdoc
+/**
+ * @deprecated Metrika will be deleted, which uses this logic
+ */
 function isButtonPixel(pixelEvents) {
     if (Array.isArray(pixelEvents) && pixelEvents.length && 'name' in pixelEvents) {
         return true;
     }
     return false;
 }
+// eslint-disable-next-line valid-jsdoc
+/**
+ * @deprecated useMetrika will be deleted
+ */
 const useMetrika = () => {
     const { metrika, pixel } = (0, react_1.useContext)(metrikaContext_1.MetrikaContext);
     return ({ metrikaGoals, pixelEvents }) => {

package/build/cjs/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/build/cjs/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/build/cjs/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/build/cjs/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;

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

@@ -414,6 +414,9 @@ export declare const ButtonProps: {
             };
         })[];
     };
+    /**
+     * @deprecated Metrika will be deleted
+     */
     metrikaGoals: {
         anyOf: ({
             type: string;
@@ -443,6 +446,9 @@ export declare const ButtonProps: {
             };
         })[];
     };
+    /**
+     * @deprecated Pixel will be deleted
+     */
     pixelEvents: {
         type: string;
         items: {
@@ -499,6 +505,84 @@ export declare const ButtonProps: {
             };
         };
     };
+    analyticsEvents: {
+        anyOf: ({
+            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;
+                            };
+                        };
+                    };
+                };
+            };
+        } | {
+            type: string;
+            items: {
+                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;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        })[];
+    };
     target: {
         type: string;
         enum: string[];
@@ -629,6 +713,9 @@ export declare const ButtonBlock: {
                 };
             })[];
         };
+        /**
+         * @deprecated Metrika will be deleted
+         */
         metrikaGoals: {
             anyOf: ({
                 type: string;
@@ -658,6 +745,9 @@ export declare const ButtonBlock: {
                 };
             })[];
         };
+        /**
+         * @deprecated Pixel will be deleted
+         */
         pixelEvents: {
             type: string;
             items: {
@@ -714,6 +804,84 @@ export declare const ButtonBlock: {
                 };
             };
         };
+        analyticsEvents: {
+            anyOf: ({
+                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;
+                                };
+                            };
+                        };
+                    };
+                };
+            } | {
+                type: string;
+                items: {
+                    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;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            })[];
+        };
         target: {
             type: string;
             enum: string[];

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

@@ -4,6 +4,7 @@ exports.BlockHeaderProps = exports.CardBase = exports.MediaProps = exports.Butto
 const pixel_1 = require("./pixel");
 const models_1 = require("../../models");
 const schema_1 = require("../../components/Image/schema");
+const event_1 = require("./event");
 exports.mediaDirection = ['media-content', 'content-media'];
 exports.textSize = ['s', 'm', 'l'];
 exports.containerSizesArray = ['sm', 'md', 'lg', 'xl', 'all'];
@@ -309,6 +310,9 @@ exports.ButtonProps = {
             },
         ],
     },
+    /**
+     * @deprecated Metrika will be deleted
+     */
     metrikaGoals: {
         anyOf: [
             { type: 'string' },
@@ -331,7 +335,13 @@ exports.ButtonProps = {
             },
         ],
     },
+    /**
+     * @deprecated Pixel will be deleted
+     */
     pixelEvents: pixel_1.pixelEvents,
+    analyticsEvents: {
+        anyOf: [event_1.AnalyticsEventV2Schema, { type: 'array', items: event_1.AnalyticsEventV2Schema }],
+    },
     target: {
         type: 'string',
         enum: ['_self', '_blank', '_parent', '_top'],

package/build/cjs/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;
+                    };
+                };
+            };
+        };
+    };
+};