plmt-constructor-sdk 0.13.2

package/config.d.ts

@@ -0,0 +1,142 @@
+/**
+ * К помощью конфигурация настраивается получение данных
+ *
+ * @packageDocumentation
+ * @module Конфигурация
+ */
+import { ColumnType } from './data';
+import { DataSettings as WidgetDataSettings, DataSettingsMap as WidgetDataSettingsMap, ViewSettings } from './widget';
+import { configDataBlock_Server } from './__internal__/config';
+import { viewSettingsItemValue } from './__internal__/view-settings';
+export declare enum DataQueryMethod {
+    Table = "table",
+    Aggregate = "aggregate"
+}
+export declare enum DataQueryFunction {
+    Group = "group",
+    Sum = "sum",
+    Average = "avg",
+    Min = "min",
+    Max = "max",
+    First = "first",
+    Last = "last"
+}
+export declare enum BlockIcon {
+    AxisX = "sys:axis-x",
+    AxisY = "sys:axis-y",
+    Value = "sys:value-column"
+}
+export declare type Locale = 'ru' | 'en';
+export declare type Text = Record<Locale, string>;
+export interface Config {
+    label: Text;
+    icon: string;
+    documentation: ConfigDocumentation;
+    dataSettings: Omit<DataSettings, 'key'> | DataSettings[];
+}
+export interface ConfigDocumentation {
+    readme: string;
+    assetsDirectory: string;
+    images: string[];
+}
+export interface DataSettings {
+    method: DataQueryMethod;
+    key: string;
+    label?: Text;
+    min?: number;
+    max?: number;
+    validation?: {
+        requiredSome?: string[];
+        requiredEvery?: string[];
+    };
+    blocks: Block[];
+}
+export declare class Block {
+    private [configDataBlock_Server];
+    constructor(_: symbol);
+}
+export declare function block(params: {
+    key: string;
+    dataQueryFunction: DataQueryFunction;
+    label: Text;
+    columnTypes?: ColumnType[];
+    icon?: BlockIcon | string;
+    max?: number;
+}): Block;
+export declare function filter(params?: {
+    label?: Text;
+    icon?: BlockIcon | string;
+}): Block;
+export declare function sort(params?: {
+    label?: Text;
+    icon?: BlockIcon | string;
+}): Block;
+export declare function colorize(params?: {
+    label?: Text;
+    icon?: BlockIcon | string;
+    max?: number;
+}): Block;
+export declare function drilldown(params: {
+    source: string;
+    additionalFilterSources?: string[];
+    label?: Text;
+}): Block;
+export interface CreateViewSettings<DataSettings extends WidgetDataSettings | WidgetDataSettingsMap> {
+    (settings: {
+        dataSettings: DataSettings;
+        viewSettings: ViewSettings;
+    }): ViewSettingsItem[];
+}
+export declare type ViewSettingsValidator = (value: any) => Text | null;
+export interface ViewSettingsValidation {
+    [key: string]: ViewSettingsValidator;
+}
+export declare class ViewSettingsItem {
+    private [viewSettingsItemValue];
+    constructor(_: symbol);
+}
+export declare function input(params: {
+    key: string;
+    label: Text;
+    span?: number;
+    defaultValue?: string;
+}): ViewSettingsItem;
+export declare function textArea(params: {
+    key: string;
+    label: Text;
+    span?: number;
+    defaultValue?: string;
+}): ViewSettingsItem;
+export declare function checkbox(params: {
+    key: string;
+    label: Text;
+    span?: number;
+    defaultValue?: boolean;
+}): ViewSettingsItem;
+export declare function radio(params: {
+    key: string;
+    label: Text;
+    options: {
+        label: Text;
+        value: string;
+    }[];
+    span?: number;
+    defaultValue?: string;
+}): ViewSettingsItem;
+export declare function select(params: {
+    key: string;
+    label: Text;
+    options: {
+        label: Text;
+        value: string;
+    }[];
+    span?: number;
+    defaultValue?: string;
+}): ViewSettingsItem;
+export declare function colorPicker(params: {
+    key: string;
+    label: Text;
+    span?: number;
+    defaultValue?: string;
+}): ViewSettingsItem;
+export declare function title(label: any): ViewSettingsItem;

package/config.js

@@ -0,0 +1,198 @@
+"use strict";
+/**
+ * К помощью конфигурация настраивается получение данных
+ *
+ * @packageDocumentation
+ * @module Конфигурация
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.title = exports.colorPicker = exports.select = exports.radio = exports.checkbox = exports.textArea = exports.input = exports.ViewSettingsItem = exports.drilldown = exports.colorize = exports.sort = exports.filter = exports.block = exports.Block = exports.BlockIcon = exports.DataQueryFunction = exports.DataQueryMethod = void 0;
+const data_1 = require("./data");
+const config_1 = require("./__internal__/config");
+const dataset_1 = require("./__internal__/dataset");
+const view_settings_1 = require("./__internal__/view-settings");
+// enums
+var DataQueryMethod;
+(function (DataQueryMethod) {
+    DataQueryMethod["Table"] = "table";
+    DataQueryMethod["Aggregate"] = "aggregate";
+})(DataQueryMethod = exports.DataQueryMethod || (exports.DataQueryMethod = {}));
+var DataQueryFunction;
+(function (DataQueryFunction) {
+    DataQueryFunction["Group"] = "group";
+    DataQueryFunction["Sum"] = "sum";
+    DataQueryFunction["Average"] = "avg";
+    DataQueryFunction["Min"] = "min";
+    DataQueryFunction["Max"] = "max";
+    DataQueryFunction["First"] = "first";
+    DataQueryFunction["Last"] = "last";
+})(DataQueryFunction = exports.DataQueryFunction || (exports.DataQueryFunction = {}));
+var BlockIcon;
+(function (BlockIcon) {
+    BlockIcon["AxisX"] = "sys:axis-x";
+    BlockIcon["AxisY"] = "sys:axis-y";
+    BlockIcon["Value"] = "sys:value-column";
+})(BlockIcon = exports.BlockIcon || (exports.BlockIcon = {}));
+// blocks
+const token = Symbol();
+class Block {
+    constructor(_) {
+        if (_ !== token)
+            throw new Error('Illigal constructor');
+    }
+}
+exports.Block = Block;
+function createBlock(source) {
+    return Object.assign(new Block(token), {
+        [config_1.configDataBlock_Server]: {
+            type: source.type,
+            key: source.key,
+            label: source.label,
+            icon: source.icon || '',
+            data_type: source.data_type,
+            max: source.max || 0,
+            function: source.function || null,
+        },
+    });
+}
+function block(params) {
+    const columnTypes = params.columnTypes || [];
+    const hasNumberType = columnTypes.includes(data_1.ColumnType.Number);
+    let columnType;
+    switch (columnTypes.length) {
+        case 0:
+            columnType = dataset_1.DatasetColumnType_Server.Any;
+            break;
+        case 1:
+            columnType = hasNumberType
+                ? dataset_1.DatasetColumnType_Server.Fact
+                : dataset_1.DatasetColumnType_Server.Dimension;
+            break;
+        default:
+            columnType = hasNumberType
+                ? dataset_1.DatasetColumnType_Server.Any
+                : dataset_1.DatasetColumnType_Server.Dimension;
+    }
+    return createBlock({
+        type: config_1.ConfigDataBlockType_Server.Column,
+        key: params.key,
+        label: params.label,
+        icon: params.icon,
+        max: params.max,
+        function: params.dataQueryFunction,
+        data_type: columnType,
+    });
+}
+exports.block = block;
+function filter(params = {}) {
+    return createBlock({
+        type: config_1.ConfigDataBlockType_Server.Filter,
+        key: config_1.blockFilterKey,
+        label: params.label || {
+            ru: 'Фильтры',
+            en: 'Filters',
+        },
+        icon: params.icon || BlockIcon.Value,
+    });
+}
+exports.filter = filter;
+function sort(params = {}) {
+    return createBlock({
+        type: config_1.ConfigDataBlockType_Server.Sort,
+        key: config_1.blockSortKey,
+        label: params.label || {
+            ru: 'Сортировка',
+            en: 'Sort',
+        },
+        icon: params.icon || BlockIcon.Value,
+    });
+}
+exports.sort = sort;
+function colorize(params = {}) {
+    return createBlock({
+        type: config_1.ConfigDataBlockType_Server.Colorizer,
+        key: config_1.blockColorizeKey,
+        label: params.label || {
+            ru: 'Цветовая дифференциация',
+            en: 'Colors',
+        },
+        icon: params.icon || BlockIcon.Value,
+        max: params.max || 0,
+    });
+}
+exports.colorize = colorize;
+function drilldown(params) {
+    return createBlock({
+        type: config_1.ConfigDataBlockType_Server.Drilldown,
+        key: (0, config_1.decodeDrilldownData)(params.source, params.additionalFilterSources || []),
+        label: params.label || {
+            ru: 'Drilldown',
+            en: 'Drilldown',
+        },
+        icon: BlockIcon.Value,
+        max: 4,
+    });
+}
+exports.drilldown = drilldown;
+class ViewSettingsItem {
+    constructor(_) {
+        if (_ !== token)
+            throw new Error('Illigal constructor');
+    }
+}
+exports.ViewSettingsItem = ViewSettingsItem;
+function createViewSettingsItem(value) {
+    return Object.assign(new ViewSettingsItem(token), {
+        [view_settings_1.viewSettingsItemValue]: value,
+    });
+}
+function input(params) {
+    return createViewSettingsItem({
+        type: view_settings_1.ViewSettingsItemType.Input,
+        ...params,
+    });
+}
+exports.input = input;
+function textArea(params) {
+    return createViewSettingsItem({
+        type: view_settings_1.ViewSettingsItemType.TextArea,
+        ...params,
+    });
+}
+exports.textArea = textArea;
+function checkbox(params) {
+    return createViewSettingsItem({
+        type: view_settings_1.ViewSettingsItemType.Checkbox,
+        ...params,
+    });
+}
+exports.checkbox = checkbox;
+function radio(params) {
+    return createViewSettingsItem({
+        type: view_settings_1.ViewSettingsItemType.Radio,
+        ...params,
+    });
+}
+exports.radio = radio;
+function select(params) {
+    return createViewSettingsItem({
+        type: view_settings_1.ViewSettingsItemType.Select,
+        ...params,
+    });
+}
+exports.select = select;
+function colorPicker(params) {
+    return createViewSettingsItem({
+        type: view_settings_1.ViewSettingsItemType.ColorPicker,
+        ...params,
+    });
+}
+exports.colorPicker = colorPicker;
+function title(label) {
+    return createViewSettingsItem({
+        type: view_settings_1.ViewSettingsItemType.Title,
+        key: '',
+        label,
+    });
+}
+exports.title = title;

package/data.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Для выборки данных, а также управлением фильтрами и сортировкой...
+ *
+ * @packageDocumentation
+ * @module Работа с данными
+ */
+export declare enum ColumnType {
+    String = "string",
+    Number = "number",
+    Boolean = "boolean",
+    Date = "date",
+    Array = "array",
+    Object = "object"
+}
+export declare enum FilterMethod {
+    Equal = "equally",
+    NotEqual = "not_equal",
+    GreaterThen = "gt",
+    LessThen = "lt",
+    GreaterThenOrEqual = "gte",
+    LessThenOrEqual = "lte",
+    Period = "period",
+    DateList = "date_list",
+    InList = "in_list",
+    NotInList = "nin_list",
+    StartsOnIndex = "starts_on_i",
+    StartsOn = "starts_on",
+    EndsOnIndex = "ends_on_i",
+    EndsOn = "ends_on",
+    ContainsIndex = "contains_i",
+    Contains = "contains",
+    NotContainIndex = "not_contain_i",
+    NotContain = "not_contain"
+}
+export declare enum SortDirection {
+    Asc = "ASC",
+    Desc = "DESC"
+}
+export declare enum Target {
+    Self = "self",
+    Other = "other",
+    All = "all"
+}
+export interface DataItem {
+    [path: string]: any;
+}
+export interface Column {
+    type: ColumnType;
+    id: number;
+    name: string;
+    path: string;
+    format: (value: any) => string;
+}
+export interface Filter {
+    column: Column;
+    method: FilterMethod;
+    value: string | number | string[] | number[];
+}
+export interface Sort {
+    column: Column;
+    direction: SortDirection;
+}

package/data.js

@@ -0,0 +1,51 @@
+"use strict";
+/**
+ * Для выборки данных, а также управлением фильтрами и сортировкой...
+ *
+ * @packageDocumentation
+ * @module Работа с данными
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Target = exports.SortDirection = exports.FilterMethod = exports.ColumnType = void 0;
+// enums
+var ColumnType;
+(function (ColumnType) {
+    ColumnType["String"] = "string";
+    ColumnType["Number"] = "number";
+    ColumnType["Boolean"] = "boolean";
+    ColumnType["Date"] = "date";
+    ColumnType["Array"] = "array";
+    ColumnType["Object"] = "object";
+})(ColumnType = exports.ColumnType || (exports.ColumnType = {}));
+var FilterMethod;
+(function (FilterMethod) {
+    FilterMethod["Equal"] = "equally";
+    FilterMethod["NotEqual"] = "not_equal";
+    FilterMethod["GreaterThen"] = "gt";
+    FilterMethod["LessThen"] = "lt";
+    FilterMethod["GreaterThenOrEqual"] = "gte";
+    FilterMethod["LessThenOrEqual"] = "lte";
+    FilterMethod["Period"] = "period";
+    FilterMethod["DateList"] = "date_list";
+    FilterMethod["InList"] = "in_list";
+    FilterMethod["NotInList"] = "nin_list";
+    FilterMethod["StartsOnIndex"] = "starts_on_i";
+    FilterMethod["StartsOn"] = "starts_on";
+    FilterMethod["EndsOnIndex"] = "ends_on_i";
+    FilterMethod["EndsOn"] = "ends_on";
+    FilterMethod["ContainsIndex"] = "contains_i";
+    FilterMethod["Contains"] = "contains";
+    FilterMethod["NotContainIndex"] = "not_contain_i";
+    FilterMethod["NotContain"] = "not_contain";
+})(FilterMethod = exports.FilterMethod || (exports.FilterMethod = {}));
+var SortDirection;
+(function (SortDirection) {
+    SortDirection["Asc"] = "ASC";
+    SortDirection["Desc"] = "DESC";
+})(SortDirection = exports.SortDirection || (exports.SortDirection = {}));
+var Target;
+(function (Target) {
+    Target["Self"] = "self";
+    Target["Other"] = "other";
+    Target["All"] = "all";
+})(Target = exports.Target || (exports.Target = {}));

package/declare.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Для того, чтобы виджет получал и управлял данными,
+ * класс виджета необходимо декорировать функцией Declare:
+ *
+ * ```ts
+ * import { Declare, Widget } from 'ptnl-constructor-sdk';
+ *
+ * @Declare()
+ * class MyWidget extends Widget {}
+ * ```
+ *
+ * @packageDocumentation
+ * @module Регистрация виджета
+ */
+/**
+ * Функция-декоратор
+ */
+export declare function Declare(params?: {
+    provideCssVariables: boolean;
+}): ClassDecorator;

package/declare.js

@@ -0,0 +1,131 @@
+"use strict";
+/**
+ * Для того, чтобы виджет получал и управлял данными,
+ * класс виджета необходимо декорировать функцией Declare:
+ *
+ * ```ts
+ * import { Declare, Widget } from 'ptnl-constructor-sdk';
+ *
+ * @Declare()
+ * class MyWidget extends Widget {}
+ * ```
+ *
+ * @packageDocumentation
+ * @module Регистрация виджета
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Declare = void 0;
+const logical_not_1 = require("logical-not");
+const data_1 = require("./data");
+const widget_io_1 = require("./__internal__/widget-io");
+const widget_provide_data_1 = require("./__internal__/widget-provide-data");
+const theme_1 = require("./__internal__/theme");
+const widget_1 = require("./__internal__/widget");
+/**
+ * Функция-декоратор
+ */
+function Declare(params) {
+    if ((0, logical_not_1.not)(params))
+        params = {
+            provideCssVariables: false,
+        };
+    return (T) => {
+        const instance = new T();
+        const token = readFromUrl('token');
+        const uid = readFromUrl('uid');
+        if (uid) {
+            instance.uid = uid;
+        }
+        Object.assign(instance, {
+            viewSettings: {},
+            ready() {
+                output(token, widget_io_1.Output.Ready);
+            },
+        });
+        const dataSettingsMethods = {
+            setFilter(filter, rowIndex, target = data_1.Target.Self) {
+                filter = { ...filter };
+                filter.column = { ...filter.column };
+                delete filter.column.format;
+                output(token, widget_io_1.Output.SetFilter, {
+                    filter,
+                    target,
+                    rowIndex,
+                });
+            },
+            removeFilterAt(index) {
+                output(token, widget_io_1.Output.RemoveFilterAt, {
+                    index,
+                });
+            },
+            setSort(sort, target = data_1.Target.Self) {
+                if (sort) {
+                    sort = { ...sort };
+                    sort.column = { ...sort.column };
+                    delete sort.column.format;
+                }
+                output(token, widget_io_1.Output.SetSort, { sort, target });
+            },
+            removeSortAt(index) {
+                output(token, widget_io_1.Output.RemoveSortAt, {
+                    index,
+                });
+            },
+            interact(dataIndex) {
+                output(token, widget_io_1.Output.Interact, {
+                    dataOptionId: this.id,
+                    dataIndex,
+                });
+            },
+        };
+        let inited = false;
+        input(widget_io_1.Input.Change, (widgetRepresent) => {
+            (0, widget_provide_data_1.provideDataTo)(instance, widgetRepresent, dataSettingsMethods);
+            if ((0, logical_not_1.not)(inited)) {
+                inited = true;
+                if (typeof instance.onInit === 'function') {
+                    instance.onInit();
+                }
+            }
+            if (typeof instance.onChange === 'function') {
+                instance.onChange();
+            }
+        });
+        input(widget_io_1.Input.ChangeLang, (lang) => {
+            instance.lang = lang;
+            if (instance.onLangChange && inited)
+                instance.onLangChange();
+        });
+        input(widget_io_1.Input.ChangeTheme, (value) => {
+            instance.theme = value.theme;
+            if (params.provideCssVariables)
+                (0, theme_1.provideCssVariables)(value);
+            if (instance.onThemeChange && inited)
+                instance.onThemeChange();
+        });
+        input(widget_io_1.Input.ChangeOtherFilters, (source) => (0, widget_1.dispatchChangeOtherFilters)(instance, source));
+        input(widget_io_1.Input.ChangeWidgetRenderEnv, (value) => {
+            instance.renderEnv = value;
+        });
+        output(token, widget_io_1.Output.Init);
+        return T;
+    };
+}
+exports.Declare = Declare;
+function input(type, callback) {
+    window.addEventListener('message', ({ data }) => {
+        if (data.type === type)
+            callback(data.payload);
+    });
+}
+function output(token, type, payload) {
+    const message = { type, token, payload };
+    window.parent.postMessage(message, '*');
+}
+function readFromUrl(key) {
+    const startsWith = key + '=';
+    const source = window.location.search
+        .split(/[?&]/)
+        .find((item) => item.startsWith(startsWith));
+    return source ? source.slice(startsWith.length) : '';
+}

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './declare';
+export * from './widget';

package/index.js

@@ -0,0 +1,18 @@
+"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("./declare"), exports);
+__exportStar(require("./widget"), exports);

package/package.json

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

package/theme.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Для получения текущей темы, виджет должен имплементировать
+ * интерфейс OnThemeChange:
+ *
+ * ```ts
+ * import { Declare, Widget, OnThemeChange } from 'ptnl-constructor-sdk';
+ * import { Theme } from 'ptnl-constructor-sdk/theme';
+ *
+ * @Declare()
+ * class MyWidget extends Widget implements OnThemeChange {
+ *     onThemeChange(theme: Theme): void {}
+ * }
+ * ```
+ *
+ * @packageDocumentation
+ * @module Работа с темами
+ */
+export interface Theme {
+    background: string;
+    backgroundBright: string;
+    backgroundTint: string[];
+    colorize: string[][];
+    colors: string[];
+    text: string;
+    textTint: string[];
+}

package/theme.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Для получения текущей темы, виджет должен имплементировать
+ * интерфейс OnThemeChange:
+ *
+ * ```ts
+ * import { Declare, Widget, OnThemeChange } from 'ptnl-constructor-sdk';
+ * import { Theme } from 'ptnl-constructor-sdk/theme';
+ *
+ * @Declare()
+ * class MyWidget extends Widget implements OnThemeChange {
+ *     onThemeChange(theme: Theme): void {}
+ * }
+ * ```
+ *
+ * @packageDocumentation
+ * @module Работа с темами
+ */
+Object.defineProperty(exports, "__esModule", { value: true });