@gravity-ui/dashkit 3.0.1

package/build/esm/shared/units/__tests__/state-and-params.test.d.ts

@@ -0,0 +1,241 @@
+export declare const stateAndParams1: {
+    in: {
+        '0g': {
+            params: {
+                min: string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+            };
+        };
+        JX: {
+            params: {
+                min: string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+            };
+        };
+        V8: {
+            params: {
+                min: string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+            };
+        };
+        WZ: {
+            state: {
+                tabId: string;
+            };
+            params: {
+                min: string;
+            };
+        };
+        Zb: {
+            params: {
+                min: string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+            };
+        };
+        qM: {
+            params: {
+                min: string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+            };
+        };
+    };
+    out: {
+        '0g': {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {};
+        };
+        JX: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {};
+        };
+        WZ: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                min: string;
+            };
+            state: {
+                tabId: string;
+            };
+        };
+        Zb: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {};
+        };
+        V8: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {};
+        };
+        qM: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {};
+        };
+    };
+};
+export declare const stateAndParams2: {
+    in: {
+        JX: {
+            params: {
+                min: string;
+            };
+        };
+        WZ: {
+            state: {
+                tabId: string;
+            };
+        };
+        Zb: {
+            state: {
+                tabId: string;
+            };
+            params: {
+                min: string;
+            };
+        };
+        qM: {
+            params: {
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+            };
+        };
+        __meta__: {
+            queue: ({
+                id: string;
+                tabId?: undefined;
+            } | {
+                id: string;
+                tabId: string;
+            })[];
+            version: number;
+        };
+    };
+    out: {
+        __meta__: {
+            queue: ({
+                id: string;
+                tabId?: undefined;
+            } | {
+                id: string;
+                tabId: string;
+            })[];
+            version: number;
+        };
+        '0g': {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {};
+        };
+        JX: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {};
+        };
+        WZ: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {
+                tabId: string;
+            };
+        };
+        Zb: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {
+                tabId: string;
+            };
+        };
+        V8: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {};
+        };
+        qM: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': string;
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': string;
+                min: string;
+            };
+            state: {};
+        };
+    };
+};
+export declare const stateAndParams3: {
+    in: {
+        yd: {
+            params: {
+                b: string;
+            };
+        };
+        __meta__: {
+            queue: {
+                id: string;
+            }[];
+            version: number;
+        };
+    };
+    out: {
+        AD: {
+            params: {
+                a: string;
+                b: string;
+                c: string;
+            };
+            state: {};
+        };
+        yd: {
+            params: {
+                a: string;
+                b: string;
+                c: string;
+            };
+            state: {};
+        };
+        lA: {
+            params: {
+                a: string;
+                b: string;
+                c: string;
+            };
+            state: {};
+        };
+        __meta__: {
+            queue: {
+                id: string;
+            }[];
+            version: number;
+        };
+    };
+};

package/build/esm/shared/units/__tests__/state-and-params.test.js

@@ -0,0 +1,295 @@
+import omit from 'lodash/omit';
+import { META_KEY } from '../../constants';
+import { getItemsStateAndParamsDL } from '../datalens';
+import mockConfigs from './configs.json';
+export const stateAndParams1 = {
+    in: {
+        '0g': {
+            params: {
+                min: '300',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+            },
+        },
+        JX: {
+            params: {
+                min: '300',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+            },
+        },
+        V8: {
+            params: {
+                min: '300',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+            },
+        },
+        WZ: {
+            state: {
+                tabId: '2m',
+            },
+            params: {
+                min: '300',
+            },
+        },
+        Zb: {
+            params: {
+                min: '300',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+            },
+        },
+        qM: {
+            params: {
+                min: '300',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+            },
+        },
+    },
+    out: {
+        '0g': {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {},
+        },
+        JX: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {},
+        },
+        WZ: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                min: '300',
+            },
+            state: {
+                tabId: '2m',
+            },
+        },
+        Zb: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {},
+        },
+        V8: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {},
+        },
+        qM: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {},
+        },
+    },
+};
+export const stateAndParams2 = {
+    in: {
+        JX: {
+            params: {
+                min: '20',
+            },
+        },
+        WZ: {
+            state: {
+                tabId: '2m',
+            },
+        },
+        Zb: {
+            state: {
+                tabId: 'om',
+            },
+            params: {
+                min: '300',
+            },
+        },
+        qM: {
+            params: {
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+            },
+        },
+        __meta__: {
+            queue: [
+                {
+                    id: 'JX',
+                },
+                {
+                    id: 'Zb',
+                    tabId: 'om',
+                },
+                {
+                    id: 'qM',
+                },
+            ],
+            version: 2,
+        },
+    },
+    out: {
+        __meta__: {
+            queue: [
+                {
+                    id: 'JX',
+                },
+                {
+                    id: 'Zb',
+                    tabId: 'om',
+                },
+                {
+                    id: 'qM',
+                },
+            ],
+            version: 2,
+        },
+        '0g': {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {},
+        },
+        JX: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {},
+        },
+        WZ: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {
+                tabId: '2m',
+            },
+        },
+        Zb: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {
+                tabId: 'om',
+            },
+        },
+        V8: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {},
+        },
+        qM: {
+            params: {
+                '60487355-b211-4b64-977d-49db609b1106': '',
+                'b147d8f0-30b0-41ba-a93c-d99897f473ed': 'A-Bomb',
+                min: '300',
+            },
+            state: {},
+        },
+    },
+};
+export const stateAndParams3 = {
+    in: {
+        yd: {
+            params: {
+                b: '100',
+            },
+        },
+        __meta__: {
+            queue: [
+                {
+                    id: 'yd',
+                },
+            ],
+            version: 2,
+        },
+    },
+    out: {
+        AD: {
+            params: {
+                a: '100',
+                b: '100',
+                c: '100',
+            },
+            state: {},
+        },
+        yd: {
+            params: {
+                a: '100',
+                b: '100',
+                c: '100',
+            },
+            state: {},
+        },
+        lA: {
+            params: {
+                a: '100',
+                b: '100',
+                c: '100',
+            },
+            state: {},
+        },
+        __meta__: {
+            queue: [
+                {
+                    id: 'yd',
+                },
+            ],
+            version: 2,
+        },
+    },
+};
+const configs = mockConfigs.configs;
+describe('getItemsStateAndParamsDL', () => {
+    describe('old version fallback', () => {
+        const oldResultItemsStateAndParams = getItemsStateAndParamsDL({
+            defaultGlobalParams: {},
+            globalParams: {},
+            config: configs[0],
+            itemsStateAndParams: stateAndParams1.in,
+        });
+        it('return stateAndParams1.out', () => {
+            expect(oldResultItemsStateAndParams).toEqual(omit(stateAndParams1.out, META_KEY));
+        });
+    });
+    describe('version 2 like the old version', () => {
+        const resultItemsStateAndParams = getItemsStateAndParamsDL({
+            defaultGlobalParams: {},
+            globalParams: {},
+            config: configs[0],
+            itemsStateAndParams: stateAndParams2.in,
+        });
+        it('return stateAndParams2.out', () => {
+            expect(resultItemsStateAndParams).toEqual(omit(stateAndParams2.out, META_KEY));
+        });
+    });
+    describe('version 2: aliases work correctly ', () => {
+        const resultItemsStateAndParams = getItemsStateAndParamsDL({
+            defaultGlobalParams: {},
+            globalParams: {},
+            config: configs[1],
+            itemsStateAndParams: stateAndParams3.in,
+        });
+        it('return stateAndParams3.out', () => {
+            expect(resultItemsStateAndParams).toEqual(omit(stateAndParams3.out, META_KEY));
+        });
+    });
+});

package/build/esm/shared/units/datalens/index.d.ts

@@ -0,0 +1,5 @@
+import { GetItemsParamsArg } from '../../modules';
+import { PluginBase, ItemsStateAndParamsBase } from '../../types';
+export declare const pluginControlBaseDL: PluginBase;
+export declare const pluginWidgetBaseDL: PluginBase;
+export declare function getItemsStateAndParamsDL(data: Omit<GetItemsParamsArg, 'plugins'>): ItemsStateAndParamsBase;

package/build/esm/shared/units/datalens/index.js

@@ -0,0 +1,20 @@
+import omit from 'lodash/omit';
+import { getItemsStateAndParams } from '../../modules';
+import { META_KEY } from '../../constants';
+export const pluginControlBaseDL = {
+    type: 'control',
+};
+export const pluginWidgetBaseDL = {
+    type: 'widget',
+};
+const pluginsBaseDL = [
+    { type: 'title' },
+    { type: 'text' },
+    pluginControlBaseDL,
+    pluginWidgetBaseDL,
+];
+// Используется в DataLens на серверной стороне для формирования параметров и стейта чарта в рассылках
+export function getItemsStateAndParamsDL(data) {
+    const itemsStateAndParams = getItemsStateAndParams(Object.assign(Object.assign({}, data), { plugins: pluginsBaseDL }));
+    return omit(itemsStateAndParams, META_KEY);
+}

package/build/esm/shared/units/index.d.ts

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

package/build/esm/shared/units/index.js

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

package/build/esm/typings/common.d.ts

@@ -0,0 +1,32 @@
+import { OverlayCustomControlItem } from '../components/OverlayControls/OverlayControls';
+import { MenuItems } from '../constants';
+export interface Settings {
+    gridLayout?: {
+        margin?: [number, number];
+        rowHeight?: number;
+        cols?: number;
+        containerPadding?: [number, number];
+    };
+    theme?: string;
+    isMobile?: boolean;
+    menu?: Array<MenuItem>;
+}
+export declare type MenuItem = typeof MenuItems[keyof typeof MenuItems] | OverlayCustomControlItem;
+export interface SettingsProps {
+    autoupdateInterval: number;
+    silentLoading: boolean;
+}
+export interface ContextProps {
+    [key: string]: any;
+}
+export interface WidgetLayout {
+    i: string;
+    w: number;
+    h: number;
+    x: number;
+    y: number;
+    minW: number;
+    minH: number;
+    maxW?: number;
+    maxH?: number;
+}

package/build/esm/typings/common.js

@@ -0,0 +1 @@
+export {};

package/build/esm/typings/config.d.ts

@@ -0,0 +1,7 @@
+import { ConfigItem, ConfigLayout } from '../shared';
+export interface AddConfigItem extends Omit<ConfigItem, 'id' | 'namespace'> {
+    id?: null;
+    namespace?: string;
+    layout?: ConfigLayout;
+}
+export declare type SetConfigItem = ConfigItem | AddConfigItem;

package/build/esm/typings/config.js

@@ -0,0 +1 @@
+export {};

package/build/esm/typings/global.d.ts

@@ -0,0 +1,7 @@
+declare module '*.svg' {
+    const content: SVGIconData;
+
+    export default content;
+}
+
+declare module '*.md';

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

@@ -0,0 +1,3 @@
+export * from './common';
+export * from './plugin';
+export * from './config';

package/build/esm/typings/index.js

@@ -0,0 +1,3 @@
+export * from './common';
+export * from './plugin';
+export * from './config';

package/build/esm/typings/plugin.d.ts

@@ -0,0 +1,39 @@
+import React from 'react';
+import { ContextProps, SettingsProps, WidgetLayout } from './common';
+import { StringParams, ConfigItem, ItemState, ItemStateAndParams, PluginBase } from '../shared';
+import { RegisterManagerGridLayout } from '../utils/register-manager';
+export interface PluginWidgetProps {
+    id: string;
+    editMode: boolean;
+    params: StringParams;
+    state: ItemState;
+    onStateAndParamsChange: (stateAndParams: ItemStateAndParams) => void;
+    width: number;
+    height: number;
+    data: ConfigItem['data'];
+    defaults: ConfigItem['defaults'];
+    namespace: ConfigItem['namespace'];
+    settings: SettingsProps;
+    context: ContextProps;
+    layout: WidgetLayout[];
+    gridLayout: RegisterManagerGridLayout;
+    adjustWidgetLayout: (data: {
+        widgetId: string;
+        needSetDefault?: boolean;
+        adjustedWidgetLayout?: WidgetLayout;
+    }) => void;
+}
+export interface PluginDefaultLayout {
+    w?: number;
+    h?: number;
+    x?: number;
+    y?: number;
+    minW?: number;
+    maxW?: number;
+    minH?: number;
+    maxH?: number;
+}
+export interface Plugin<P extends PluginWidgetProps = any> extends PluginBase {
+    defaultLayout?: PluginDefaultLayout;
+    renderer: (props: P, forwardedRef: React.RefObject<any>) => React.ReactNode;
+}

package/build/esm/typings/plugin.js

@@ -0,0 +1 @@
+export {};

package/build/esm/utils/__tests__/mock.test.d.ts

@@ -0,0 +1 @@
+

package/build/esm/utils/__tests__/mock.test.js

@@ -0,0 +1,8 @@
+"use strict";
+describe('test: mock', () => {
+    describe('mock', () => {
+        test('adds 1 + 2 to equal 3', () => {
+            expect(1 + 2).toBe(3);
+        });
+    });
+});

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

@@ -0,0 +1,9 @@
+export declare type Lang = 'ru' | 'en';
+interface Config {
+    lang?: Lang;
+}
+declare type Subscriber = (config: Config) => void;
+export declare const configure: (newConfig: Config) => void;
+export declare const subscribeConfigure: (sub: Subscriber) => () => void;
+export declare const getConfig: () => Config;
+export {};