@gravity-ui/dashkit 3.0.1

package/build/cjs/shared/types/config.d.ts

@@ -0,0 +1,49 @@
+import { StringParams } from './common';
+export interface ConfigLayout {
+    i: string;
+    h: number;
+    w: number;
+    x: number;
+    y: number;
+}
+export interface ConfigItemData {
+    _editActive?: boolean;
+    tabs?: {
+        id: string;
+        isDefault?: boolean;
+        params?: StringParams;
+        [key: string]: unknown;
+    }[];
+    [key: string]: unknown;
+}
+export interface ConfigItemDataWithTabs extends Omit<ConfigItemData, 'tabs'> {
+    tabs: NonNullable<ConfigItemData['tabs']>;
+}
+export interface ConfigItem {
+    id: string;
+    data: ConfigItemData;
+    type: string;
+    namespace: string;
+    defaults?: StringParams;
+    orderId?: number;
+    defaultOrderId?: number;
+}
+export interface ConfigItemWithTabs extends Omit<ConfigItem, 'data'> {
+    data: ConfigItemDataWithTabs;
+}
+export interface ConfigAliases {
+    [namespace: string]: string[][];
+}
+export interface ConfigConnection {
+    from: string;
+    to: string;
+    kind: 'ignore';
+}
+export interface Config {
+    salt: string;
+    counter: number;
+    items: ConfigItem[];
+    layout: ConfigLayout[];
+    aliases: ConfigAliases;
+    connections: ConfigConnection[];
+}

package/build/cjs/shared/types/config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/cjs/shared/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './common';
+export * from './config';
+export * from './state-and-params';
+export * from './plugin';

package/build/cjs/shared/types/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./common"), exports);
+tslib_1.__exportStar(require("./config"), exports);
+tslib_1.__exportStar(require("./state-and-params"), exports);
+tslib_1.__exportStar(require("./plugin"), exports);

package/build/cjs/shared/types/plugin.d.ts

@@ -0,0 +1,8 @@
+import { ConfigItem } from './config';
+interface PluginSpecialFields {
+    prerenderMiddleware?: (item: ConfigItem) => ConfigItem;
+}
+export interface PluginBase extends PluginSpecialFields {
+    type: string;
+}
+export {};

package/build/cjs/shared/types/plugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/cjs/shared/types/state-and-params.d.ts

@@ -0,0 +1,22 @@
+import { META_KEY } from '../constants';
+import { StringParams } from './common';
+export interface ItemState {
+    [key: string]: any;
+}
+export interface QueueItem {
+    id: string;
+    tabId?: string;
+}
+export declare type StateAndParamsMetaData = {
+    queue: QueueItem[];
+    version: number;
+};
+export declare type StateAndParamsMeta = {
+    [META_KEY]: StateAndParamsMetaData;
+};
+export declare type ItemStateAndParams = {
+    params?: StringParams;
+    state?: ItemState;
+};
+export declare type ItemsStateAndParamsBase = Record<string, ItemStateAndParams>;
+export declare type ItemsStateAndParams = ItemsStateAndParamsBase | StateAndParamsMeta;

package/build/cjs/shared/types/state-and-params.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../constants");

package/build/cjs/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/cjs/shared/units/__tests__/state-and-params.test.js

@@ -0,0 +1,299 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stateAndParams3 = exports.stateAndParams2 = exports.stateAndParams1 = void 0;
+const tslib_1 = require("tslib");
+const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
+const constants_1 = require("../../constants");
+const datalens_1 = require("../datalens");
+const configs_json_1 = tslib_1.__importDefault(require("./configs.json"));
+exports.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: {},
+        },
+    },
+};
+exports.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: {},
+        },
+    },
+};
+exports.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 = configs_json_1.default.configs;
+describe('getItemsStateAndParamsDL', () => {
+    describe('old version fallback', () => {
+        const oldResultItemsStateAndParams = (0, datalens_1.getItemsStateAndParamsDL)({
+            defaultGlobalParams: {},
+            globalParams: {},
+            config: configs[0],
+            itemsStateAndParams: exports.stateAndParams1.in,
+        });
+        it('return stateAndParams1.out', () => {
+            expect(oldResultItemsStateAndParams).toEqual((0, omit_1.default)(exports.stateAndParams1.out, constants_1.META_KEY));
+        });
+    });
+    describe('version 2 like the old version', () => {
+        const resultItemsStateAndParams = (0, datalens_1.getItemsStateAndParamsDL)({
+            defaultGlobalParams: {},
+            globalParams: {},
+            config: configs[0],
+            itemsStateAndParams: exports.stateAndParams2.in,
+        });
+        it('return stateAndParams2.out', () => {
+            expect(resultItemsStateAndParams).toEqual((0, omit_1.default)(exports.stateAndParams2.out, constants_1.META_KEY));
+        });
+    });
+    describe('version 2: aliases work correctly ', () => {
+        const resultItemsStateAndParams = (0, datalens_1.getItemsStateAndParamsDL)({
+            defaultGlobalParams: {},
+            globalParams: {},
+            config: configs[1],
+            itemsStateAndParams: exports.stateAndParams3.in,
+        });
+        it('return stateAndParams3.out', () => {
+            expect(resultItemsStateAndParams).toEqual((0, omit_1.default)(exports.stateAndParams3.out, constants_1.META_KEY));
+        });
+    });
+});

package/build/cjs/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/cjs/shared/units/datalens/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getItemsStateAndParamsDL = exports.pluginWidgetBaseDL = exports.pluginControlBaseDL = void 0;
+const tslib_1 = require("tslib");
+const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
+const modules_1 = require("../../modules");
+const constants_1 = require("../../constants");
+exports.pluginControlBaseDL = {
+    type: 'control',
+};
+exports.pluginWidgetBaseDL = {
+    type: 'widget',
+};
+const pluginsBaseDL = [
+    { type: 'title' },
+    { type: 'text' },
+    exports.pluginControlBaseDL,
+    exports.pluginWidgetBaseDL,
+];
+// Используется в DataLens на серверной стороне для формирования параметров и стейта чарта в рассылках
+function getItemsStateAndParamsDL(data) {
+    const itemsStateAndParams = (0, modules_1.getItemsStateAndParams)(Object.assign(Object.assign({}, data), { plugins: pluginsBaseDL }));
+    return (0, omit_1.default)(itemsStateAndParams, constants_1.META_KEY);
+}
+exports.getItemsStateAndParamsDL = getItemsStateAndParamsDL;

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

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

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

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