plmt-constructor-sdk 0.17.2 → 0.17.4

package/package.json

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

package/widget.d.ts

@@ -120,15 +120,125 @@ export interface CustomQueryFields {
  * При необходимости можно дополнять интерфейс
  */
 export declare type CustomDataRule = (AllColumnsHidden | HiddenColumnIds | ShowColumnIds) & {
+    /** Сортировка, которая будет отправлена в запросе*/
     sort?: {
         [id: number]: DataOptionSort;
     };
+    /** При установленном флаге будем получать полную информацию по установленным колонкам и данные им соответствующие
+     *
+     * В обычном случае данные получаются с бэка в соответствии с rules
+     *
+     * **С флагом**
+     *
+     * @example
+     * ```ts
+     * const rule: { [key: string]: CustomDataRule } = {
+     *     dataKey: {
+     *         getWithoutData: true,
+     *         hiddenColumnIds: [12, 204],
+     *     },
+     * };
+     *
+     * // В таком случае ответ с бэка будет следующим:
+     * // В colsByBlock будет:
+     * {
+     *      // другие блоки колонок
+     *     dataKey: [
+     *         {
+     *             type: 0,
+     *             id: 12,
+     *             path: '1',
+     *             name: 'Имя',
+     *         },
+     *         {
+     *             type: 0,
+     *             id: 23,
+     *             path: '2',
+     *             name: 'Фамилия',
+     *         },
+     *         {
+     *             type: 0,
+     *             id: 204,
+     *             path: '3',
+     *             name: 'Отчество',
+     *         },
+     *         {
+     *             type: 0,
+     *             id: 24,
+     *             path: '4',
+     *             name: 'Род деятельности',
+     *         },
+     *     ],
+     * };
+     * ```
+     * // В data будет:
+     * ```ts
+     *  [
+     *         {
+     *             2: 'Егоров',
+     *             4: 'Строитель',
+     *         },
+     *         {
+     *             2: 'Иванов',
+     *             4: 'Программист',
+     *         },
+     *  ],
+     * ```
+     *
+     * **Без флага**
+     *
+     * ```ts
+     * const rule: { [key: string]: CustomDataRule } = {
+     *     dataKey: {
+     *         hiddenColumnIds: [12, 204],
+     *     },
+     * };
+     *
+     * // В таком случае ответ с бэка будет следующим:
+     * // В colsByBlock будет:
+     * {
+     *      // другие блоки колонок
+     *     dataKey: [
+     *         {
+     *             type: 0,
+     *             id: 23,
+     *             path: '1',
+     *             name: 'Фамилия',
+     *         },
+     *         {
+     *             type: 0,
+     *             id: 24,
+     *             path: '2',
+     *             name: 'Род деятельности',
+     *         },
+     *     ],
+     * };
+     *
+     * // В data будет:
+     *  [
+     *         {
+     *             1: 'Егоров',
+     *             2: 'Строитель',
+     *         },
+     *         {
+     *             1: 'Иванов',
+     *             2: 'Программист',
+     *         },
+     *  ],
+     * ```
+     */
+    getWithoutData?: true;
 };
 export interface HiddenColumnIds {
     hiddenColumnIds: number[];
 }
 export interface ShowColumnIds {
     showColumnIds: number[];
+    /** Колонки в виджете могут быть перемешаны относительно **dataSettings** виджета
+     *  Если **shuffle** включён то поиск колонок из **showColumnIds** будет осуществляться по всем **dataOptions**
+     *  и перемещать колонку из другого блока в текущий
+     */
+    shuffle?: true;
 }
 export interface DataOptionSort {
     column_id: number;

package/widget.js

@@ -29,3 +29,19 @@ var WidgetRenderEnv;
     WidgetRenderEnv["Default"] = "default";
     WidgetRenderEnv["Print"] = "print";
 })(WidgetRenderEnv = exports.WidgetRenderEnv || (exports.WidgetRenderEnv = {}));
+const a = {
+    dataKey: [
+        {
+            type: 0,
+            id: 199,
+            path: '2',
+            name: 'Товар.Категория',
+        },
+        {
+            type: 0,
+            id: 204,
+            path: '3',
+            name: 'Товар',
+        },
+    ],
+};