polymatica-widget 0.7.2 → 2.0.4

package/README.md

@@ -1,3 +1,6 @@
 # Polymatica Widget SDK
 
+![build: passing](https://raw.githubusercontent.com/git@gitlab.ptnl.moscow:constructor/platform/polymatica-widget/master/badges/build.svg)
+![license: ISC](https://raw.githubusercontent.com/git@gitlab.ptnl.moscow:constructor/platform/polymatica-widget/master/badges/license.svg)
+
 > Pre-Alpha

package/__internal__/widget-options.d.ts

@@ -1,5 +1,8 @@
 import { Text } from '../locale';
 export declare enum WidgetOptionType {
+    Title = "title",
+    Label = "label",
+    Spacer = "spacer",
     Text = "text",
     Number = "number",
     Integer = "integer",
@@ -8,18 +11,17 @@ export declare enum WidgetOptionType {
     Date = "date",
     Time = "time",
     DateTime = "datetime",
-    DateInterval = "dateinterval",
+    DateInterval = "date-interval",
     Checkbox = "checkbox",
     Radio = "radio",
+    RadioButtons = "radio-buttons",
     Select = "select",
-    ColorPicker = "color-picker",
-    Title = "title"
+    ColorPicker = "color-picker"
 }
 export interface WidgetOptionConfig {
     type: WidgetOptionType;
-    key: string;
-    label: Text;
-    defaultValue?: any;
+    key?: string;
+    label?: Text;
     options?: {
         label: Text;
         value: string | number | boolean;

package/__internal__/widget-options.js

@@ -4,6 +4,11 @@ exports.getSpan = exports.valueConversion = exports.WidgetOptionType = void 0;
 const widget_config_1 = require("../widget-config");
 var WidgetOptionType;
 (function (WidgetOptionType) {
+    // Layout
+    WidgetOptionType["Title"] = "title";
+    WidgetOptionType["Label"] = "label";
+    WidgetOptionType["Spacer"] = "spacer";
+    // Controls
     WidgetOptionType["Text"] = "text";
     WidgetOptionType["Number"] = "number";
     WidgetOptionType["Integer"] = "integer";
@@ -12,16 +17,17 @@ var WidgetOptionType;
     WidgetOptionType["Date"] = "date";
     WidgetOptionType["Time"] = "time";
     WidgetOptionType["DateTime"] = "datetime";
-    WidgetOptionType["DateInterval"] = "dateinterval";
+    WidgetOptionType["DateInterval"] = "date-interval";
     WidgetOptionType["Checkbox"] = "checkbox";
     WidgetOptionType["Radio"] = "radio";
+    WidgetOptionType["RadioButtons"] = "radio-buttons";
     WidgetOptionType["Select"] = "select";
     WidgetOptionType["ColorPicker"] = "color-picker";
-    WidgetOptionType["Title"] = "title";
 })(WidgetOptionType = exports.WidgetOptionType || (exports.WidgetOptionType = {}));
 function valueConversion(type, source) {
     switch (type) {
         case WidgetOptionType.Text:
+        case WidgetOptionType.Title:
             return source ? String(source) : '';
         case WidgetOptionType.Number:
         case WidgetOptionType.Range:

package/package.json

@@ -1,11 +1,11 @@
 {
-  "name": "polymatica-widget",
-  "version": "0.7.2",
-  "description": "SDK для создания виджетов для модуля Dashboard платформы Polymatica",
-  "keywords": [],
-  "license": "ISC",
-  "main": "index.js",
-  "dependencies": {
-    "logical-not": "^1.0.9"
-  }
+    "name": "polymatica-widget",
+    "version": "2.0.4",
+    "description": "SDK для создания виджетов для платформы Polymatica",
+    "keywords": [],
+    "license": "ISC",
+    "main": "index.js",
+    "dependencies": {
+        "logical-not": "^1.0.9"
+    }
 }

package/widget-config.d.ts

@@ -1,157 +1,102 @@
-import { ColumnType } from './dataset';
 import { Text } from './locale';
 import { Options } from './widget';
-import { Block } from './__internal__/widget-config';
 import { WidgetOptionConfig } from './__internal__/widget-options';
 export declare enum DataQueryMethod {
-    Table = "table",
-    Aggregate = "aggregate"
-}
-export declare enum AggregateFunction {
-    Group = "group",
-    Sum = "sum",
-    Average = "avg",
-    Min = "min",
-    Max = "max",
-    First = "first",
-    Last = "last"
-}
-export declare enum Icon {
-    AxisX = "ico://axis-x",
-    AxisY = "ico://axis-y",
-    Value = "ico://value-column",
-    Filter = "ico://filter",
-    Sort = "ico://sort",
-    Heatmap = "ico://heatmap",
-    Drilldown = "ico://drilldown"
+    Aggregate = "aggregate",
+    Pivot = "pivot",
+    Table = "table"
 }
 export interface WidgetConfig {
     data?: {
-        view: DataConfigView | (DataConfigView & WithKey)[];
-        request?: DataRequest;
+        config: DataConfig | (DataConfig & WithKey)[];
     };
     options?: {
-        view: GetWidgetOptionsView;
+        provider: GetWidgetOptionsConfig;
         default: Options;
-        validation?: OptionsValidation;
+        validators?: OptionsValidation;
     };
 }
-export interface DataConfigView {
-    blocks: Block[];
+export interface DataConfig {
     method: DataQueryMethod;
+    blocks: Block[];
     label?: Text;
     validation?: {
         requiredSome?: string[];
         requiredEvery?: string[];
     };
-    repeatable?: boolean;
-    min?: number;
-    max?: number;
-    pagination?: boolean;
+    interactable?: boolean;
+    drilldown?: {
+        source: string;
+    };
+    heatmap?: boolean | {
+        targets: string[];
+    };
+    repeatable?: boolean | {
+        min?: number;
+        max?: number;
+    };
 }
 export interface WithKey {
     key: string;
 }
-export interface DataConfigItem {
-    blocks: Block[];
-    method: DataQueryMethod;
-    rowsLimit: number;
-    pagination?: boolean;
-}
-export declare type DataConfig = DataConfigItem | DataConfigItem[] | {
-    [key: string]: DataConfigItem | DataConfigItem[];
-};
-export interface DataRequest {
-    (viewConfig: DataConfig, options: Options): DataConfig;
-}
-export declare function data(params: {
+export interface Block {
     key: string;
     label: Text;
     icon?: string;
-    aggregateFunction?: AggregateFunction;
-    columnTypes?: ColumnType[];
-    max?: number;
-}): Block;
-export declare function filter(params?: {
-    label?: Text;
-    icon?: Icon | string;
-}): Block;
-export declare function sort(params?: {
-    label?: Text;
-    icon?: Icon | string;
-}): Block;
-export declare function heatmap(params?: {
-    label?: Text;
-    icon?: Icon | string;
-    max?: number;
-}): Block;
-export declare function drilldown(params: {
-    source: string;
-    additionalFilterSources?: string[];
-    label?: Text;
-    icon?: Icon | string;
+    aggregation?: boolean;
     max?: number;
-}): Block;
-export declare function rowsLimit(params?: {
-    label?: Text;
-}): Block;
-export declare const STEP = 48;
-export interface GetWidgetOptionsView {
-    (options: Options, dataConfig?: DataConfig): WidgetOptionConfig[];
 }
+export declare const STEP = 24;
+export interface GetWidgetOptionsConfig {
+    (options: Options): WidgetOptionConfig[];
+}
+export declare function title(label: Text): WidgetOptionConfig;
+export declare function label(label: Text): WidgetOptionConfig;
+export declare function spacer(span: number): WidgetOptionConfig;
 export declare function text(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
 export declare function number(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
 export declare function integer(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
 export declare function range(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
 export declare function interval(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
 export declare function date(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
 export declare function time(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
 export declare function dateTime(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
 export declare function checkbox(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: boolean;
 }): WidgetOptionConfig;
 export declare function radio(params: {
     key: string;
@@ -161,7 +106,15 @@ export declare function radio(params: {
         value: string;
     }[];
     span?: number;
-    defaultValue?: string;
+}): WidgetOptionConfig;
+export declare function radioButton(params: {
+    key: string;
+    label: Text;
+    options: {
+        label: Text;
+        value: string;
+    }[];
+    span?: number;
 }): WidgetOptionConfig;
 export declare function select(params: {
     key: string;
@@ -171,15 +124,12 @@ export declare function select(params: {
         value: string;
     }[];
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
 export declare function colorPicker(params: {
     key: string;
     label: Text;
     span?: number;
-    defaultValue?: string;
 }): WidgetOptionConfig;
-export declare function title(label: Text, description?: Text): WidgetOptionConfig;
 export interface OptionsValidation {
     [key: string]: OptionsValidator;
 }

package/widget-config.js

@@ -1,102 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.title = exports.colorPicker = exports.select = exports.radio = exports.checkbox = exports.dateTime = exports.time = exports.date = exports.interval = exports.range = exports.integer = exports.number = exports.text = exports.STEP = exports.rowsLimit = exports.drilldown = exports.heatmap = exports.sort = exports.filter = exports.data = exports.Icon = exports.AggregateFunction = exports.DataQueryMethod = void 0;
-const widget_config_1 = require("./__internal__/widget-config");
+exports.colorPicker = exports.select = exports.radioButton = exports.radio = exports.checkbox = exports.dateTime = exports.time = exports.date = exports.interval = exports.range = exports.integer = exports.number = exports.text = exports.spacer = exports.label = exports.title = exports.STEP = exports.DataQueryMethod = void 0;
 const widget_options_1 = require("./__internal__/widget-options");
 // enums
 var DataQueryMethod;
 (function (DataQueryMethod) {
-    DataQueryMethod["Table"] = "table";
     DataQueryMethod["Aggregate"] = "aggregate";
+    DataQueryMethod["Pivot"] = "pivot";
+    DataQueryMethod["Table"] = "table";
 })(DataQueryMethod = exports.DataQueryMethod || (exports.DataQueryMethod = {}));
-var AggregateFunction;
-(function (AggregateFunction) {
-    AggregateFunction["Group"] = "group";
-    AggregateFunction["Sum"] = "sum";
-    AggregateFunction["Average"] = "avg";
-    AggregateFunction["Min"] = "min";
-    AggregateFunction["Max"] = "max";
-    AggregateFunction["First"] = "first";
-    AggregateFunction["Last"] = "last";
-})(AggregateFunction = exports.AggregateFunction || (exports.AggregateFunction = {}));
-var Icon;
-(function (Icon) {
-    Icon["AxisX"] = "ico://axis-x";
-    Icon["AxisY"] = "ico://axis-y";
-    Icon["Value"] = "ico://value-column";
-    Icon["Filter"] = "ico://filter";
-    Icon["Sort"] = "ico://sort";
-    Icon["Heatmap"] = "ico://heatmap";
-    Icon["Drilldown"] = "ico://drilldown";
-})(Icon = exports.Icon || (exports.Icon = {}));
-// blocks
-function data(params) {
-    return Object.assign({ type: widget_config_1.BlockType.Data }, params);
-}
-exports.data = data;
-function filter(params = {}) {
-    return {
-        type: widget_config_1.BlockType.Filter,
-        label: params.label || {
-            ru: 'Фильтры',
-            en: 'Filters',
-        },
-        icon: params.icon || Icon.Filter,
-        key: '',
-    };
-}
-exports.filter = filter;
-function sort(params = {}) {
-    return {
-        type: widget_config_1.BlockType.Sort,
-        label: params.label || {
-            ru: 'Сортировка',
-            en: 'Sort',
-        },
-        icon: params.icon || Icon.Sort,
-        key: '',
-    };
-}
-exports.sort = sort;
-function heatmap(params = {}) {
-    return {
-        type: widget_config_1.BlockType.Heatmap,
-        label: params.label || {
-            ru: 'Тепловая карта',
-            en: 'Heatmap',
-        },
-        icon: params.icon || Icon.Heatmap,
-        max: params.max || 0,
-        key: '',
-    };
-}
-exports.heatmap = heatmap;
-function drilldown(params) {
-    return {
-        type: widget_config_1.BlockType.Drilldown,
-        key: (0, widget_config_1.decodeDrilldownData)(params.source, params.additionalFilterSources || []),
-        label: params.label || {
-            ru: 'Drilldown',
-            en: 'Drilldown',
-        },
-        icon: params.icon || Icon.Drilldown,
-        max: params.max || 4,
-    };
-}
-exports.drilldown = drilldown;
-function rowsLimit(params = {}) {
-    return {
-        type: widget_config_1.BlockType.RowsLimit,
-        label: params.label || {
-            ru: 'Количество записей на странице',
-            en: 'Rows limit',
-        },
-        key: '',
-    };
-}
-exports.rowsLimit = rowsLimit;
-// widget optiosn
-exports.STEP = 48;
+// widget options
+exports.STEP = 24;
+// layout
+function title(label) {
+    return { type: widget_options_1.WidgetOptionType.Title, label };
+}
+exports.title = title;
+function label(label) {
+    return { type: widget_options_1.WidgetOptionType.Label, label };
+}
+exports.label = label;
+function spacer(span) {
+    return { type: widget_options_1.WidgetOptionType.Spacer, span };
+}
+exports.spacer = spacer;
+// controls
 function text(params) {
     return Object.assign({ type: widget_options_1.WidgetOptionType.Text }, params);
 }
@@ -137,6 +65,10 @@ function radio(params) {
     return Object.assign({ type: widget_options_1.WidgetOptionType.Radio }, params);
 }
 exports.radio = radio;
+function radioButton(params) {
+    return Object.assign({ type: widget_options_1.WidgetOptionType.RadioButtons }, params);
+}
+exports.radioButton = radioButton;
 function select(params) {
     return Object.assign({ type: widget_options_1.WidgetOptionType.Select }, params);
 }
@@ -145,12 +77,3 @@ function colorPicker(params) {
     return Object.assign({ type: widget_options_1.WidgetOptionType.ColorPicker }, params);
 }
 exports.colorPicker = colorPicker;
-function title(label, description) {
-    return {
-        type: widget_options_1.WidgetOptionType.Title,
-        label,
-        defaultValue: description,
-        key: '',
-    };
-}
-exports.title = title;

package/__internal__/widget-config.d.ts

@@ -1,25 +0,0 @@
-import { Text } from '../locale';
-import { ColumnType } from '../dataset';
-import { AggregateFunction } from '../widget-config';
-export declare enum BlockType {
-    Data = "data",
-    Filter = "filter",
-    Sort = "sort",
-    Heatmap = "heatmap",
-    Drilldown = "drilldown",
-    RowsLimit = "rows-limit"
-}
-export interface Block {
-    type: BlockType;
-    key: string;
-    label: Text;
-    icon?: string;
-    aggregateFunction?: AggregateFunction;
-    columnTypes?: ColumnType[];
-    max?: number;
-}
-export declare function decodeDrilldownData(source: string, additionalFilterSources: string[]): string;
-export declare function encodeDrilldownData(key: string): {
-    source: string;
-    additionalFilterSources: string[];
-};

package/__internal__/widget-config.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.encodeDrilldownData = exports.decodeDrilldownData = exports.BlockType = void 0;
-// enums
-var BlockType;
-(function (BlockType) {
-    BlockType["Data"] = "data";
-    BlockType["Filter"] = "filter";
-    BlockType["Sort"] = "sort";
-    BlockType["Heatmap"] = "heatmap";
-    BlockType["Drilldown"] = "drilldown";
-    BlockType["RowsLimit"] = "rows-limit";
-})(BlockType = exports.BlockType || (exports.BlockType = {}));
-function decodeDrilldownData(source, additionalFilterSources) {
-    const keyParts = [length(source.length), source];
-    additionalFilterSources.forEach(item => keyParts.push(length(item.length), item));
-    return keyParts.join('');
-    function length(value) {
-        if (value > 0xff)
-            throw new RangeError();
-        return value > 0xf
-            ? `0x${value.toString(16)}`
-            : `0x0${value.toString(16)}`;
-    }
-}
-exports.decodeDrilldownData = decodeDrilldownData;
-function encodeDrilldownData(key) {
-    const parts = [];
-    parse();
-    const [source, ...additionalFilterSources] = parts;
-    return {
-        source,
-        additionalFilterSources,
-    };
-    function parse(offset = 0) {
-        const start = offset + 4;
-        const end = start + parseInt(key.slice(offset, start));
-        parts.push(key.slice(start, end));
-        if (end < key.length)
-            parse(end);
-    }
-}
-exports.encodeDrilldownData = encodeDrilldownData;