@gravity-ui/page-constructor 3.8.3 → 3.9.0

package/build/esm/text-transform/filter.js

@@ -0,0 +1,56 @@
+/* eslint-disable no-param-reassign */
+/* eslint-disable no-not-accumulator-reassign/no-not-accumulator-reassign */
+import evalExp from '@doc-tools/transform/lib/liquid/evaluation';
+function filterItems(items, vars, propertyName) {
+    if (!Array.isArray(items)) {
+        throw new Error(`Error while filtering: items has invalid key '${propertyName}' equals ${JSON.stringify(items)}`);
+    }
+    return items.reduce((result, item) => {
+        const passedFiltration = checkWhenCondition(item.when, vars);
+        if (passedFiltration) {
+            const property = propertyName && item[propertyName];
+            if (property === undefined) {
+                result.push(item);
+            }
+            else {
+                const filteredProperty = filterItems(property, vars, propertyName);
+                if (filteredProperty.length !== 0) {
+                    result.push(Object.assign(Object.assign({}, item), { [propertyName]: filteredProperty }));
+                }
+            }
+        }
+        return result;
+    }, []);
+}
+function checkWhenCondition(whenValue, vars) {
+    return (whenValue === true ||
+        whenValue === undefined ||
+        (typeof whenValue === 'string' && (!whenValue || evalExp(whenValue, vars))));
+}
+function isItemArray(content) {
+    return Array.isArray(content);
+}
+function isItem(content) {
+    return content && typeof content === 'object' && !Array.isArray(content);
+}
+/**
+ * Filters content recoursively by result of it's 'when' property evaluation applied to vars argument.
+ * e.g. property {..., when: 'someVar == "someValue"' } will be included in result only if vars.someVar === 'someValue'
+ * @param {FilterableContent} content
+ * @param {ContentVariables} vars
+ * @return {FilteredContent}
+ */
+export function filterContent(content, vars) {
+    if (isItemArray(content)) {
+        return filterItems(content, vars).map((item) => filterContent(item, vars));
+    }
+    else if (isItem(content)) {
+        return Object.entries(content).reduce((acc, [key, value]) => {
+            acc[key] = filterContent(value, vars);
+            return acc;
+        }, {});
+    }
+    else {
+        return content;
+    }
+}

package/build/esm/text-transform/index.d.ts

@@ -2,3 +2,4 @@ export * from './utils';
 export * from './config';
 export * from './common';
 export * from './transformers';
+export * from './filter';

package/build/esm/text-transform/index.js

@@ -2,3 +2,4 @@ export * from './utils';
 export * from './config';
 export * from './common';
 export * from './transformers';
+export * from './filter';

package/build/esm/text-transform/transformers.d.ts

@@ -1,5 +1,6 @@
 import { ConstructorBlock } from '../models/constructor';
 import { Lang } from '../utils/configure';
+export type ContentVariables = Record<string, string>;
 export type ContentTransformerProps = {
     content: {
         blocks?: ConstructorBlock[];
@@ -7,6 +8,7 @@ export type ContentTransformerProps = {
     options: {
         lang: Lang;
         customConfig?: {};
+        vars?: ContentVariables;
     };
 };
 export declare const contentTransformer: ({ content, options }: ContentTransformerProps) => {

package/build/esm/text-transform/transformers.js

@@ -2,6 +2,7 @@
 /* eslint-disable no-not-accumulator-reassign/no-not-accumulator-reassign */
 import _ from 'lodash';
 import { config } from './config';
+import { filterContent } from './filter';
 function transformBlocks(blocks, lang, customConfig = {}) {
     const fullConfig = Object.assign(Object.assign({}, config), customConfig);
     const clonedBlocks = _.cloneDeep(blocks);
@@ -42,8 +43,8 @@ function transformBlock(lang, blocksConfig, block) {
     return block;
 }
 export const contentTransformer = ({ content, options }) => {
-    const { lang, customConfig = {} } = options;
-    const { blocks = [] } = content;
+    const { lang, customConfig = {}, vars } = options;
+    const { blocks = [] } = (vars ? filterContent(content, vars) : content);
     const transformedBlocks = transformBlocks(blocks, lang, customConfig);
     return {
         blocks: transformedBlocks,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/page-constructor",
-  "version": "3.8.3",
+  "version": "3.9.0",
   "description": "Gravity UI Page Constructor",
   "license": "MIT",
   "repository": {

package/server/text-transform/filter.d.ts

@@ -0,0 +1,20 @@
+import { ContentVariables } from './transformers';
+type WhenValue = string | boolean | undefined;
+type OrArray<T> = T | T[];
+type OrArrayRecord<T> = Record<string, OrArray<T>>;
+interface FilteredContentItem extends OrArrayRecord<FilteredContentItem> {
+}
+type FilteredContent = OrArray<FilteredContentItem>;
+type FilterableContentItem = FilteredContentItem & {
+    when: WhenValue;
+};
+export type FilterableContent = OrArray<FilterableContentItem>;
+/**
+ * Filters content recoursively by result of it's 'when' property evaluation applied to vars argument.
+ * e.g. property {..., when: 'someVar == "someValue"' } will be included in result only if vars.someVar === 'someValue'
+ * @param {FilterableContent} content
+ * @param {ContentVariables} vars
+ * @return {FilteredContent}
+ */
+export declare function filterContent(content: FilterableContent | FilteredContent, vars: ContentVariables): FilteredContent;
+export {};

package/server/text-transform/filter.js

@@ -0,0 +1,63 @@
+"use strict";
+/* eslint-disable no-param-reassign */
+/* eslint-disable no-not-accumulator-reassign/no-not-accumulator-reassign */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterContent = void 0;
+const evaluation_1 = __importDefault(require("@doc-tools/transform/lib/liquid/evaluation"));
+function filterItems(items, vars, propertyName) {
+    if (!Array.isArray(items)) {
+        throw new Error(`Error while filtering: items has invalid key '${propertyName}' equals ${JSON.stringify(items)}`);
+    }
+    return items.reduce((result, item) => {
+        const passedFiltration = checkWhenCondition(item.when, vars);
+        if (passedFiltration) {
+            const property = propertyName && item[propertyName];
+            if (property === undefined) {
+                result.push(item);
+            }
+            else {
+                const filteredProperty = filterItems(property, vars, propertyName);
+                if (filteredProperty.length !== 0) {
+                    result.push(Object.assign(Object.assign({}, item), { [propertyName]: filteredProperty }));
+                }
+            }
+        }
+        return result;
+    }, []);
+}
+function checkWhenCondition(whenValue, vars) {
+    return (whenValue === true ||
+        whenValue === undefined ||
+        (typeof whenValue === 'string' && (!whenValue || (0, evaluation_1.default)(whenValue, vars))));
+}
+function isItemArray(content) {
+    return Array.isArray(content);
+}
+function isItem(content) {
+    return content && typeof content === 'object' && !Array.isArray(content);
+}
+/**
+ * Filters content recoursively by result of it's 'when' property evaluation applied to vars argument.
+ * e.g. property {..., when: 'someVar == "someValue"' } will be included in result only if vars.someVar === 'someValue'
+ * @param {FilterableContent} content
+ * @param {ContentVariables} vars
+ * @return {FilteredContent}
+ */
+function filterContent(content, vars) {
+    if (isItemArray(content)) {
+        return filterItems(content, vars).map((item) => filterContent(item, vars));
+    }
+    else if (isItem(content)) {
+        return Object.entries(content).reduce((acc, [key, value]) => {
+            acc[key] = filterContent(value, vars);
+            return acc;
+        }, {});
+    }
+    else {
+        return content;
+    }
+}
+exports.filterContent = filterContent;

package/server/text-transform/index.d.ts

@@ -2,3 +2,4 @@ export * from './utils';
 export * from './config';
 export * from './common';
 export * from './transformers';
+export * from './filter';

package/server/text-transform/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./utils"), exports);
 __exportStar(require("./config"), exports);
 __exportStar(require("./common"), exports);
 __exportStar(require("./transformers"), exports);
+__exportStar(require("./filter"), exports);

package/server/text-transform/transformers.d.ts

@@ -1,5 +1,6 @@
 import { ConstructorBlock } from '../models/constructor';
 import { Lang } from '../utils/configure';
+export type ContentVariables = Record<string, string>;
 export type ContentTransformerProps = {
     content: {
         blocks?: ConstructorBlock[];
@@ -7,6 +8,7 @@ export type ContentTransformerProps = {
     options: {
         lang: Lang;
         customConfig?: {};
+        vars?: ContentVariables;
     };
 };
 export declare const contentTransformer: ({ content, options }: ContentTransformerProps) => {

package/server/text-transform/transformers.js

@@ -8,6 +8,7 @@ exports.contentTransformer = void 0;
 /* eslint-disable no-not-accumulator-reassign/no-not-accumulator-reassign */
 const lodash_1 = __importDefault(require("lodash"));
 const config_1 = require("./config");
+const filter_1 = require("./filter");
 function transformBlocks(blocks, lang, customConfig = {}) {
     const fullConfig = Object.assign(Object.assign({}, config_1.config), customConfig);
     const clonedBlocks = lodash_1.default.cloneDeep(blocks);
@@ -48,8 +49,8 @@ function transformBlock(lang, blocksConfig, block) {
     return block;
 }
 const contentTransformer = ({ content, options }) => {
-    const { lang, customConfig = {} } = options;
-    const { blocks = [] } = content;
+    const { lang, customConfig = {}, vars } = options;
+    const { blocks = [] } = (vars ? (0, filter_1.filterContent)(content, vars) : content);
     const transformedBlocks = transformBlocks(blocks, lang, customConfig);
     return {
         blocks: transformedBlocks,