plmt-constructor-sdk 0.13.26 → 0.13.28

package/__internal__/config.d.ts

@@ -1,5 +1,6 @@
-import { Text, DataQueryMethod, DataQueryFunction } from '../config';
+import { AllColumnsHidden, DataQueryFunction, DataQueryMethod, HiddenColumnIdx, ShowColumnIdx, Text } from '../config';
 import { ColumnType } from '../data';
+import { CamelToSnakeCase } from '../tools';
 import { DatasetColumnType_Server } from './dataset';
 export declare enum ConfigDataBlockType_Server {
     Column = "column",
@@ -8,11 +9,23 @@ export declare enum ConfigDataBlockType_Server {
     Colorizer = "colorizer",
     Drilldown = "drilldown"
 }
+export declare enum DataQueryFunction_Server {
+    Group = "GROUP",
+    Sum = "SUM",
+    Min = "MIN",
+    Max = "MAX",
+    Average = "AVG",
+    Median = "MEDIAN",
+    ClickhouseMedian = "median",
+    Count = "COUNT",
+    CountDistinct = "COUNT_DISTINCT"
+}
 export interface Config_Server {
     label: Text;
     icon: string;
     data_options: ConfigDataOption_Server[];
     alternative_sort?: true;
+    custom_default_data_rules: CustomDefaultDataRules_Server;
     doc: {
         info: string;
         assets: string;
@@ -53,6 +66,10 @@ export interface ConfigDataOptionBlock_Server {
     function?: DataQueryFunction;
     sorted?: true;
 }
+export declare type CustomDefaultDataRules_Server = Rule_Server | Rule_Server[];
+export declare type Rule_Server = {
+    [key: string]: CamelToSnakeCase<AllColumnsHidden | HiddenColumnIdx | ShowColumnIdx>;
+};
 export declare const configDataBlock_Server = "8316067a-d04b-4b21-bd4d-35529846617b";
 export declare const blockFilterKey = "34642664-dbd1-4e35-b0ea-2eaabe796b48";
 export declare const blockSortKey = "2c849ed6-6105-4aa2-a961-9f95135dfe3b";

package/__internal__/config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.encodeDrilldownData = exports.decodeDrilldownData = exports.blockColorizeKey = exports.blockSortKey = exports.blockFilterKey = exports.configDataBlock_Server = exports.ConfigDataBlockType_Server = void 0;
+exports.encodeDrilldownData = exports.decodeDrilldownData = exports.blockColorizeKey = exports.blockSortKey = exports.blockFilterKey = exports.configDataBlock_Server = exports.DataQueryFunction_Server = exports.ConfigDataBlockType_Server = void 0;
 // enums
 var ConfigDataBlockType_Server;
 (function (ConfigDataBlockType_Server) {
@@ -10,6 +10,18 @@ var ConfigDataBlockType_Server;
     ConfigDataBlockType_Server["Colorizer"] = "colorizer";
     ConfigDataBlockType_Server["Drilldown"] = "drilldown";
 })(ConfigDataBlockType_Server = exports.ConfigDataBlockType_Server || (exports.ConfigDataBlockType_Server = {}));
+var DataQueryFunction_Server;
+(function (DataQueryFunction_Server) {
+    DataQueryFunction_Server["Group"] = "GROUP";
+    DataQueryFunction_Server["Sum"] = "SUM";
+    DataQueryFunction_Server["Min"] = "MIN";
+    DataQueryFunction_Server["Max"] = "MAX";
+    DataQueryFunction_Server["Average"] = "AVG";
+    DataQueryFunction_Server["Median"] = "MEDIAN";
+    DataQueryFunction_Server["ClickhouseMedian"] = "median";
+    DataQueryFunction_Server["Count"] = "COUNT";
+    DataQueryFunction_Server["CountDistinct"] = "COUNT_DISTINCT";
+})(DataQueryFunction_Server = exports.DataQueryFunction_Server || (exports.DataQueryFunction_Server = {}));
 exports.configDataBlock_Server = '8316067a-d04b-4b21-bd4d-35529846617b';
 exports.blockFilterKey = '34642664-dbd1-4e35-b0ea-2eaabe796b48';
 exports.blockSortKey = '2c849ed6-6105-4aa2-a961-9f95135dfe3b';

package/__internal__/widget-io.d.ts

@@ -1,6 +1,6 @@
 import { Locale } from '../config';
 import { DataOptionFilter, Filter, Sort, Target } from '../data';
-import { WidgetRenderEnv } from '../widget';
+import { CustomQueryFields, WidgetRenderEnv } from '../widget';
 import { ThemeProvide } from './theme';
 import { WidgetDataOptionColumn_Server, WidgetRepresent } from './widget';
 export declare enum Input {
@@ -17,7 +17,8 @@ export declare enum Output {
     RemoveFilterAt = "ptnl.output.RemoveFilterAt",
     SetSort = "ptnl.output.setSort",
     RemoveSortAt = "ptnl.output.RemoveSortAt",
-    Interact = "ptnl.output.interact"
+    Interact = "ptnl.output.interact",
+    CustomQuery = "ptnl.output.customQuery"
 }
 export interface InputParameter extends Record<Input, any> {
     [Input.Change]: WidgetRepresent;
@@ -60,6 +61,9 @@ export interface OutputParameter extends Record<Output, any> {
         dataOptionId: number;
         dataIndex: number;
     };
+    [Output.CustomQuery]: {
+        customQueryData: CustomQueryFields;
+    };
 }
 export declare type OutputData = {
     [K in Output]: {

package/__internal__/widget-io.js

@@ -18,4 +18,5 @@ var Output;
     Output["SetSort"] = "ptnl.output.setSort";
     Output["RemoveSortAt"] = "ptnl.output.RemoveSortAt";
     Output["Interact"] = "ptnl.output.interact";
+    Output["CustomQuery"] = "ptnl.output.customQuery";
 })(Output = exports.Output || (exports.Output = {}));

package/__internal__/widget-provide-data.d.ts

@@ -1,4 +1,4 @@
 import { DataSettings } from '../widget';
 import { WidgetRepresent } from './widget';
-export declare type DataSettingsMethods = Pick<DataSettings, 'setFilter' | 'removeFilterAt' | 'setSort' | 'removeSortAt' | 'interact'>;
+export declare type DataSettingsMethods = Pick<DataSettings, 'setFilter' | 'removeFilterAt' | 'setSort' | 'removeSortAt' | 'interact' | 'customQuery'>;
 export declare function provideDataTo(widget: any, { dataOptionsMap, viewOptions }: WidgetRepresent, dataSettingsMethods?: DataSettingsMethods): void;

package/__internal__/widget-provide-data.js

@@ -11,6 +11,7 @@ const defaultDataSettingsMethods = {
     setSort() { },
     removeSortAt() { },
     interact() { },
+    customQuery() { },
 };
 function provideDataTo(widget, { dataOptionsMap, viewOptions }, dataSettingsMethods = defaultDataSettingsMethods) {
     const widgetMultiData = {};

package/config.d.ts

@@ -29,7 +29,29 @@ export declare enum BlockIcon {
 }
 export declare type Locale = 'ru' | 'en';
 export declare type Text = Record<Locale, string>;
-export interface Config {
+/**
+ * Правила для **дефолтного** запроса данных
+ *
+ * Например, для сущности нужно получать данные не по всем вынесенным в блоки колонкам
+ *
+ * Собственно, на данный момент кастомные правила эту проблему и решают
+ *
+ * Интерфейс при необходимости можно расширять (не забыть про обработку на уровне платформы)
+ */
+export declare type CustomDefaultDataRules = Rule | Rule[];
+export declare type Rule = {
+    [key: string]: AllColumnsHidden | HiddenColumnIdx | ShowColumnIdx;
+};
+export interface AllColumnsHidden {
+    allColumnsHidden: true;
+}
+export interface HiddenColumnIdx {
+    hiddenColumnIdx: number[];
+}
+export interface ShowColumnIdx {
+    showColumnIdx: number[];
+}
+export declare type Config = {
     label: Text;
     icon: string;
     type?: string;
@@ -39,8 +61,13 @@ export interface Config {
         max?: number;
     };
     documentation: ConfigDocumentation;
-    dataSettings: Omit<DataSettings, 'key'> | DataSettings[];
-}
+} & ({
+    customDefaultDataRules?: Rule[];
+    dataSettings: DataSettings[];
+} | {
+    customDefaultDataRules?: Rule;
+    dataSettings: Omit<DataSettings, 'key'>;
+});
 export interface ConfigDocumentation {
     readme: string;
     assetsDirectory: string;

package/declare.js

@@ -98,6 +98,11 @@ function Declare(params) {
                     dataIndex,
                 });
             },
+            customQuery(query) {
+                output(token, widget_io_1.Output.CustomQuery, {
+                    customQueryData: query,
+                });
+            },
         };
         let inited = false;
         input(widget_io_1.Input.Change, (widgetRepresent) => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "plmt-constructor-sdk",
-    "version": "0.13.26",
+    "version": "0.13.28",
     "description": "Набор инструментов для создания виджетов.",
     "dependencies": {
         "logical-not": "^1.0.9"

package/tools/camel-to-snake.d.ts

@@ -0,0 +1,6 @@
+export declare type CamelToSnakeCaseField<S extends string> = S extends `${infer T}${infer U}` ? `${T extends Capitalize<T> ? '_' : ''}${Lowercase<T>}${CamelToSnakeCaseField<U>}` : S;
+export declare type CamelToSnakeCase<T extends {
+    [key: string]: any;
+}> = {
+    [K in Extract<keyof T, string> as CamelToSnakeCaseField<K>]: T[K];
+};

package/tools/camel-to-snake.js

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

package/tools/index.d.ts

@@ -0,0 +1 @@
+export * from './camel-to-snake';

package/tools/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./camel-to-snake"), exports);

package/widget.d.ts

@@ -4,8 +4,9 @@
  * @packageDocumentation
  * @module Класс Widget
  */
-import { Locale } from './config';
-import { Column, DataItem, DataOptionFilter, Filter, Sort, Target } from './data';
+import { DataQueryFunction_Server } from './__internal__/config';
+import { AllColumnsHidden, DataQueryMethod, Locale } from './config';
+import { Column, DataItem, DataOptionFilter, Filter, Sort, SortDirection, Target } from './data';
 import { Theme } from './theme';
 export declare abstract class Widget {
     viewSettings: ViewSettings;
@@ -46,6 +47,12 @@ export interface DataSettings {
     setSort(sort: Sort | null): void;
     removeSortAt(index: number): void;
     interact(dataIndex: number): void;
+    /**
+     * Метод для выполнения кастомных запросов
+     *
+     * Выполняет запросы вне зависимости от стандартного конфига виджета
+     */
+    customQuery(query: CustomQueryFields): void;
     events: {
         onOtherFilterChange?: (filter: Filter) => void;
     };
@@ -79,3 +86,39 @@ export interface SetFilterFn {
         (target: Target.Self, filter: DataOptionFilter[]): void;
     };
 }
+export interface CustomQueryFields {
+    /** Метод выполнения запроса*/
+    method?: DataQueryMethod;
+    /** Правила, по которым будет строиться DataOption*/
+    rules: {
+        [key: string]: CustomDataRule;
+    };
+    /** Фильтры, которые будут отправлены в запросе*/
+    filters?: DataOptionFilter[];
+    /** Сортировка, которая будет отправлена в запросе*/
+    sort?: DataOptionSort[];
+    /** Смещение относительно данных датасета (применимо например в пагинации)*/
+    offset?: number;
+}
+/**
+ * Интерфейс для создания правил, по которым будет строиться DataOption
+ *
+ * При необходимости можно дополнять интерфейс
+ */
+export declare type CustomDataRule = (AllColumnsHidden | HiddenColumnIds | ShowColumnIds) & {
+    sort?: {
+        [id: number]: DataOptionSort;
+    };
+};
+export interface HiddenColumnIds {
+    hiddenColumnIds: number[];
+}
+export interface ShowColumnIds {
+    showColumnIds: number[];
+}
+export interface DataOptionSort {
+    column_id: number;
+    direction?: SortDirection;
+    agg_fn?: DataQueryFunction_Server;
+    path?: string;
+}