@webiny/api-headless-cms-ddb 0.0.0-mt-2 → 0.0.0-unstable.06b2ede40f

package/operations/entry/filtering/createExpressions.js

@@ -0,0 +1,178 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createExpressions = void 0;
+var _error = _interopRequireDefault(require("@webiny/error"));
+var _ValueFilterPlugin = require("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin");
+var _mapPlugins = require("./mapPlugins");
+var _where = require("./where");
+var _transform = require("./transform");
+var _CmsEntryFieldFilterPlugin = require("../../../plugins/CmsEntryFieldFilterPlugin");
+var _values = require("./values");
+const createExpressions = params => {
+  const {
+    where,
+    plugins,
+    fields
+  } = params;
+  const filterPlugins = (0, _mapPlugins.getMappedPlugins)({
+    plugins,
+    type: _ValueFilterPlugin.ValueFilterPlugin.type,
+    property: "operation"
+  });
+  const transformValuePlugins = (0, _mapPlugins.getMappedPlugins)({
+    plugins,
+    type: "cms-field-filter-value-transform",
+    property: "fieldType"
+  });
+  const fieldFilterCreatePlugins = (0, _mapPlugins.getMappedPlugins)({
+    plugins,
+    type: _CmsEntryFieldFilterPlugin.CmsEntryFieldFilterPlugin.type,
+    property: "fieldType"
+  });
+  const defaultFilterCreatePlugin = fieldFilterCreatePlugins["*"];
+  const getFilterCreatePlugin = type => {
+    const filterCreatePlugin = fieldFilterCreatePlugins[type] || defaultFilterCreatePlugin;
+    if (filterCreatePlugin) {
+      return filterCreatePlugin;
+    }
+    throw new _error.default(`There is no filter create plugin for the field type "${type}".`, "MISSING_FILTER_CREATE_PLUGIN", {
+      type
+    });
+  };
+  const createExpression = ({
+    where,
+    condition
+  }) => {
+    const expression = {
+      filters: [],
+      expressions: [],
+      condition
+    };
+    for (const key in where) {
+      const value = where[key];
+      if (value === undefined) {
+        continue;
+      }
+
+      /**
+       * If there are "AND" or "OR" keys, let's sort them out first.
+       *
+       *
+       * AND conditional
+       */
+      if (key === "AND") {
+        const childWhereList = (0, _values.getWhereValues)(value, key);
+        const childExpression = {
+          condition: "AND",
+          filters: [],
+          expressions: []
+        };
+        for (const childWhere of childWhereList) {
+          const result = createExpression({
+            where: childWhere,
+            condition: "AND"
+          });
+          childExpression.expressions.push(result);
+        }
+        expression.expressions.push(childExpression);
+        continue;
+      }
+      /**
+       * OR conditional
+       */
+      if (key === "OR") {
+        const childWhereList = (0, _values.getWhereValues)(value, key);
+        const childExpression = {
+          condition: "OR",
+          filters: [],
+          expressions: []
+        };
+        for (const childWhere of childWhereList) {
+          const result = createExpression({
+            where: childWhere,
+            condition: "AND"
+          });
+          childExpression.expressions.push(result);
+        }
+        expression.expressions.push(childExpression);
+        continue;
+      }
+      const whereParams = (0, _where.extractWhereParams)(key);
+      if (!whereParams) {
+        continue;
+      }
+      const {
+        fieldId,
+        operation,
+        negate
+      } = whereParams;
+      const field = fields[fieldId];
+      if (!field) {
+        throw new _error.default(`There is no field with the fieldId "${fieldId}".`, "FIELD_ERROR", {
+          fieldId
+        });
+      }
+
+      /**
+       * We need a filter create plugin for this type.
+       */
+      const filterCreatePlugin = getFilterCreatePlugin(field.type);
+      const transformValuePlugin = transformValuePlugins[field.type];
+      const transformValueCallable = value => {
+        if (!transformValuePlugin) {
+          return value;
+        }
+        return transformValuePlugin.transform({
+          field,
+          value
+        });
+      };
+      const result = filterCreatePlugin.create({
+        key,
+        value,
+        valueFilterPlugins: filterPlugins,
+        transformValuePlugins,
+        getFilterCreatePlugin,
+        operation,
+        negate,
+        field,
+        fields,
+        compareValue: (0, _transform.transformValue)({
+          value,
+          transform: transformValueCallable
+        }),
+        transformValue: transformValueCallable
+      });
+      /**
+       * There is a possibility of
+       * - no result
+       * - result being an array
+       * - result being an object
+       */
+      if (!result || Array.isArray(result) && result.length === 0) {
+        continue;
+      }
+      expression.filters.push(...(Array.isArray(result) ? result : [result]));
+    }
+    return expression;
+  };
+  const expression = createExpression({
+    where,
+    condition: "AND"
+  });
+  /**
+   * If the first expression has no filters and has only one expression, put that expression as main one.
+   * This will mostly be used when having an OR condition as the single expression in the root level of the where
+   */
+  if (expression.filters.length > 0 || expression.expressions.length !== 1) {
+    return expression;
+  }
+  return expression.expressions[0];
+};
+exports.createExpressions = createExpressions;
+
+//# sourceMappingURL=createExpressions.js.map

package/operations/entry/filtering/createExpressions.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_error","_interopRequireDefault","require","_ValueFilterPlugin","_mapPlugins","_where","_transform","_CmsEntryFieldFilterPlugin","_values","createExpressions","params","where","plugins","fields","filterPlugins","getMappedPlugins","type","ValueFilterPlugin","property","transformValuePlugins","fieldFilterCreatePlugins","CmsEntryFieldFilterPlugin","defaultFilterCreatePlugin","getFilterCreatePlugin","filterCreatePlugin","WebinyError","createExpression","condition","expression","filters","expressions","key","value","undefined","childWhereList","getWhereValues","childExpression","childWhere","result","push","whereParams","extractWhereParams","fieldId","operation","negate","field","transformValuePlugin","transformValueCallable","transform","create","valueFilterPlugins","compareValue","transformValue","Array","isArray","length","exports"],"sources":["createExpressions.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport type { CmsEntryListWhere } from \"@webiny/api-headless-cms/types\";\nimport { ValueFilterPlugin } from \"@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin\";\nimport type { CmsFieldFilterValueTransformPlugin } from \"~/types\";\nimport type { PluginsContainer } from \"@webiny/plugins\";\nimport type { Field } from \"./types\";\nimport { getMappedPlugins } from \"./mapPlugins\";\nimport { extractWhereParams } from \"./where\";\nimport { transformValue } from \"./transform\";\nimport { CmsEntryFieldFilterPlugin } from \"~/plugins/CmsEntryFieldFilterPlugin\";\nimport { getWhereValues } from \"~/operations/entry/filtering/values\";\n\ninterface CreateExpressionParams {\n    where: Partial<CmsEntryListWhere>;\n    condition: ExpressionCondition;\n}\n\ninterface CreateExpressionCb {\n    (params: CreateExpressionParams): Expression;\n}\n\ninterface Params {\n    plugins: PluginsContainer;\n    where: Partial<CmsEntryListWhere>;\n    fields: Record<string, Field>;\n}\n\nexport type ExpressionCondition = \"AND\" | \"OR\";\n\nexport interface Expression {\n    expressions: Expression[];\n    filters: Filter[];\n    condition: ExpressionCondition;\n}\n\nexport interface Filter {\n    field: Field;\n    path: string;\n    fieldPathId: string;\n    plugin: ValueFilterPlugin;\n    negate: boolean;\n    compareValue: any;\n    transformValue: <I = any, O = any>(value: I) => O;\n}\n\nexport const createExpressions = (params: Params): Expression => {\n    const { where, plugins, fields } = params;\n    const filterPlugins = getMappedPlugins<ValueFilterPlugin>({\n        plugins,\n        type: ValueFilterPlugin.type,\n        property: \"operation\"\n    });\n    const transformValuePlugins = getMappedPlugins<CmsFieldFilterValueTransformPlugin>({\n        plugins,\n        type: \"cms-field-filter-value-transform\",\n        property: \"fieldType\"\n    });\n    const fieldFilterCreatePlugins = getMappedPlugins<CmsEntryFieldFilterPlugin>({\n        plugins,\n        type: CmsEntryFieldFilterPlugin.type,\n        property: \"fieldType\"\n    });\n\n    const defaultFilterCreatePlugin = fieldFilterCreatePlugins[\"*\"] as CmsEntryFieldFilterPlugin;\n\n    const getFilterCreatePlugin = (type: string) => {\n        const filterCreatePlugin = fieldFilterCreatePlugins[type] || defaultFilterCreatePlugin;\n        if (filterCreatePlugin) {\n            return filterCreatePlugin;\n        }\n        throw new WebinyError(\n            `There is no filter create plugin for the field type \"${type}\".`,\n            \"MISSING_FILTER_CREATE_PLUGIN\",\n            {\n                type\n            }\n        );\n    };\n\n    const createExpression: CreateExpressionCb = ({ where, condition }) => {\n        const expression: Expression = {\n            filters: [],\n            expressions: [],\n            condition\n        };\n\n        for (const key in where) {\n            const value = where[key];\n            if (value === undefined) {\n                continue;\n            }\n\n            /**\n             * If there are \"AND\" or \"OR\" keys, let's sort them out first.\n             *\n             *\n             * AND conditional\n             */\n            if (key === \"AND\") {\n                const childWhereList = getWhereValues(value, key);\n                const childExpression: Expression = {\n                    condition: \"AND\",\n                    filters: [],\n                    expressions: []\n                };\n                for (const childWhere of childWhereList) {\n                    const result = createExpression({\n                        where: childWhere,\n                        condition: \"AND\"\n                    });\n                    childExpression.expressions.push(result);\n                }\n                expression.expressions.push(childExpression);\n                continue;\n            }\n            /**\n             * OR conditional\n             */\n            if (key === \"OR\") {\n                const childWhereList = getWhereValues(value, key);\n\n                const childExpression: Expression = {\n                    condition: \"OR\",\n                    filters: [],\n                    expressions: []\n                };\n                for (const childWhere of childWhereList) {\n                    const result = createExpression({\n                        where: childWhere,\n                        condition: \"AND\"\n                    });\n                    childExpression.expressions.push(result);\n                }\n                expression.expressions.push(childExpression);\n                continue;\n            }\n\n            const whereParams = extractWhereParams(key);\n            if (!whereParams) {\n                continue;\n            }\n\n            const { fieldId, operation, negate } = whereParams;\n\n            const field = fields[fieldId];\n            if (!field) {\n                throw new WebinyError(\n                    `There is no field with the fieldId \"${fieldId}\".`,\n                    \"FIELD_ERROR\",\n                    {\n                        fieldId\n                    }\n                );\n            }\n\n            /**\n             * We need a filter create plugin for this type.\n             */\n            const filterCreatePlugin = getFilterCreatePlugin(field.type);\n\n            const transformValuePlugin: CmsFieldFilterValueTransformPlugin =\n                transformValuePlugins[field.type];\n\n            const transformValueCallable = (value: any) => {\n                if (!transformValuePlugin) {\n                    return value;\n                }\n                return transformValuePlugin.transform({\n                    field,\n                    value\n                });\n            };\n\n            const result = filterCreatePlugin.create({\n                key,\n                value,\n                valueFilterPlugins: filterPlugins,\n                transformValuePlugins,\n                getFilterCreatePlugin,\n                operation,\n                negate,\n                field,\n                fields,\n                compareValue: transformValue({\n                    value,\n                    transform: transformValueCallable\n                }),\n                transformValue: transformValueCallable\n            });\n            /**\n             * There is a possibility of\n             * - no result\n             * - result being an array\n             * - result being an object\n             */\n            if (!result || (Array.isArray(result) && result.length === 0)) {\n                continue;\n            }\n\n            expression.filters.push(...(Array.isArray(result) ? result : [result]));\n        }\n\n        return expression;\n    };\n\n    const expression = createExpression({\n        where,\n        condition: \"AND\"\n    });\n    /**\n     * If the first expression has no filters and has only one expression, put that expression as main one.\n     * This will mostly be used when having an OR condition as the single expression in the root level of the where\n     */\n    if (expression.filters.length > 0 || expression.expressions.length !== 1) {\n        return expression;\n    }\n    return expression.expressions[0];\n};\n"],"mappings":";;;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,kBAAA,GAAAD,OAAA;AAIA,IAAAE,WAAA,GAAAF,OAAA;AACA,IAAAG,MAAA,GAAAH,OAAA;AACA,IAAAI,UAAA,GAAAJ,OAAA;AACA,IAAAK,0BAAA,GAAAL,OAAA;AACA,IAAAM,OAAA,GAAAN,OAAA;AAmCO,MAAMO,iBAAiB,GAAIC,MAAc,IAAiB;EAC7D,MAAM;IAAEC,KAAK;IAAEC,OAAO;IAAEC;EAAO,CAAC,GAAGH,MAAM;EACzC,MAAMI,aAAa,GAAG,IAAAC,4BAAgB,EAAoB;IACtDH,OAAO;IACPI,IAAI,EAAEC,oCAAiB,CAACD,IAAI;IAC5BE,QAAQ,EAAE;EACd,CAAC,CAAC;EACF,MAAMC,qBAAqB,GAAG,IAAAJ,4BAAgB,EAAqC;IAC/EH,OAAO;IACPI,IAAI,EAAE,kCAAkC;IACxCE,QAAQ,EAAE;EACd,CAAC,CAAC;EACF,MAAME,wBAAwB,GAAG,IAAAL,4BAAgB,EAA4B;IACzEH,OAAO;IACPI,IAAI,EAAEK,oDAAyB,CAACL,IAAI;IACpCE,QAAQ,EAAE;EACd,CAAC,CAAC;EAEF,MAAMI,yBAAyB,GAAGF,wBAAwB,CAAC,GAAG,CAA8B;EAE5F,MAAMG,qBAAqB,GAAIP,IAAY,IAAK;IAC5C,MAAMQ,kBAAkB,GAAGJ,wBAAwB,CAACJ,IAAI,CAAC,IAAIM,yBAAyB;IACtF,IAAIE,kBAAkB,EAAE;MACpB,OAAOA,kBAAkB;IAC7B;IACA,MAAM,IAAIC,cAAW,CACjB,wDAAwDT,IAAI,IAAI,EAChE,8BAA8B,EAC9B;MACIA;IACJ,CACJ,CAAC;EACL,CAAC;EAED,MAAMU,gBAAoC,GAAGA,CAAC;IAAEf,KAAK;IAAEgB;EAAU,CAAC,KAAK;IACnE,MAAMC,UAAsB,GAAG;MAC3BC,OAAO,EAAE,EAAE;MACXC,WAAW,EAAE,EAAE;MACfH;IACJ,CAAC;IAED,KAAK,MAAMI,GAAG,IAAIpB,KAAK,EAAE;MACrB,MAAMqB,KAAK,GAAGrB,KAAK,CAACoB,GAAG,CAAC;MACxB,IAAIC,KAAK,KAAKC,SAAS,EAAE;QACrB;MACJ;;MAEA;AACZ;AACA;AACA;AACA;AACA;MACY,IAAIF,GAAG,KAAK,KAAK,EAAE;QACf,MAAMG,cAAc,GAAG,IAAAC,sBAAc,EAACH,KAAK,EAAED,GAAG,CAAC;QACjD,MAAMK,eAA2B,GAAG;UAChCT,SAAS,EAAE,KAAK;UAChBE,OAAO,EAAE,EAAE;UACXC,WAAW,EAAE;QACjB,CAAC;QACD,KAAK,MAAMO,UAAU,IAAIH,cAAc,EAAE;UACrC,MAAMI,MAAM,GAAGZ,gBAAgB,CAAC;YAC5Bf,KAAK,EAAE0B,UAAU;YACjBV,SAAS,EAAE;UACf,CAAC,CAAC;UACFS,eAAe,CAACN,WAAW,CAACS,IAAI,CAACD,MAAM,CAAC;QAC5C;QACAV,UAAU,CAACE,WAAW,CAACS,IAAI,CAACH,eAAe,CAAC;QAC5C;MACJ;MACA;AACZ;AACA;MACY,IAAIL,GAAG,KAAK,IAAI,EAAE;QACd,MAAMG,cAAc,GAAG,IAAAC,sBAAc,EAACH,KAAK,EAAED,GAAG,CAAC;QAEjD,MAAMK,eAA2B,GAAG;UAChCT,SAAS,EAAE,IAAI;UACfE,OAAO,EAAE,EAAE;UACXC,WAAW,EAAE;QACjB,CAAC;QACD,KAAK,MAAMO,UAAU,IAAIH,cAAc,EAAE;UACrC,MAAMI,MAAM,GAAGZ,gBAAgB,CAAC;YAC5Bf,KAAK,EAAE0B,UAAU;YACjBV,SAAS,EAAE;UACf,CAAC,CAAC;UACFS,eAAe,CAACN,WAAW,CAACS,IAAI,CAACD,MAAM,CAAC;QAC5C;QACAV,UAAU,CAACE,WAAW,CAACS,IAAI,CAACH,eAAe,CAAC;QAC5C;MACJ;MAEA,MAAMI,WAAW,GAAG,IAAAC,yBAAkB,EAACV,GAAG,CAAC;MAC3C,IAAI,CAACS,WAAW,EAAE;QACd;MACJ;MAEA,MAAM;QAAEE,OAAO;QAAEC,SAAS;QAAEC;MAAO,CAAC,GAAGJ,WAAW;MAElD,MAAMK,KAAK,GAAGhC,MAAM,CAAC6B,OAAO,CAAC;MAC7B,IAAI,CAACG,KAAK,EAAE;QACR,MAAM,IAAIpB,cAAW,CACjB,uCAAuCiB,OAAO,IAAI,EAClD,aAAa,EACb;UACIA;QACJ,CACJ,CAAC;MACL;;MAEA;AACZ;AACA;MACY,MAAMlB,kBAAkB,GAAGD,qBAAqB,CAACsB,KAAK,CAAC7B,IAAI,CAAC;MAE5D,MAAM8B,oBAAwD,GAC1D3B,qBAAqB,CAAC0B,KAAK,CAAC7B,IAAI,CAAC;MAErC,MAAM+B,sBAAsB,GAAIf,KAAU,IAAK;QAC3C,IAAI,CAACc,oBAAoB,EAAE;UACvB,OAAOd,KAAK;QAChB;QACA,OAAOc,oBAAoB,CAACE,SAAS,CAAC;UAClCH,KAAK;UACLb;QACJ,CAAC,CAAC;MACN,CAAC;MAED,MAAMM,MAAM,GAAGd,kBAAkB,CAACyB,MAAM,CAAC;QACrClB,GAAG;QACHC,KAAK;QACLkB,kBAAkB,EAAEpC,aAAa;QACjCK,qBAAqB;QACrBI,qBAAqB;QACrBoB,SAAS;QACTC,MAAM;QACNC,KAAK;QACLhC,MAAM;QACNsC,YAAY,EAAE,IAAAC,yBAAc,EAAC;UACzBpB,KAAK;UACLgB,SAAS,EAAED;QACf,CAAC,CAAC;QACFK,cAAc,EAAEL;MACpB,CAAC,CAAC;MACF;AACZ;AACA;AACA;AACA;AACA;MACY,IAAI,CAACT,MAAM,IAAKe,KAAK,CAACC,OAAO,CAAChB,MAAM,CAAC,IAAIA,MAAM,CAACiB,MAAM,KAAK,CAAE,EAAE;QAC3D;MACJ;MAEA3B,UAAU,CAACC,OAAO,CAACU,IAAI,CAAC,IAAIc,KAAK,CAACC,OAAO,CAAChB,MAAM,CAAC,GAAGA,MAAM,GAAG,CAACA,MAAM,CAAC,CAAC,CAAC;IAC3E;IAEA,OAAOV,UAAU;EACrB,CAAC;EAED,MAAMA,UAAU,GAAGF,gBAAgB,CAAC;IAChCf,KAAK;IACLgB,SAAS,EAAE;EACf,CAAC,CAAC;EACF;AACJ;AACA;AACA;EACI,IAAIC,UAAU,CAACC,OAAO,CAAC0B,MAAM,GAAG,CAAC,IAAI3B,UAAU,CAACE,WAAW,CAACyB,MAAM,KAAK,CAAC,EAAE;IACtE,OAAO3B,UAAU;EACrB;EACA,OAAOA,UAAU,CAACE,WAAW,CAAC,CAAC,CAAC;AACpC,CAAC;AAAC0B,OAAA,CAAA/C,iBAAA,GAAAA,iBAAA","ignoreList":[]}

package/operations/entry/filtering/createFields.d.ts

@@ -0,0 +1,16 @@
+import type { CmsModelField } from "@webiny/api-headless-cms/types";
+import type { Field } from "./types";
+import type { PluginsContainer } from "@webiny/plugins";
+interface Params {
+    fields: CmsModelField[];
+    plugins: PluginsContainer;
+}
+/**
+ * This method will map the fieldId (fieldId -> field) to the actual field.
+ *
+ * In case of nested fields, fieldId is all the parent fieldIds + current one, joined by the dot (.).
+ */
+export declare const createFields: (params: Params) => {
+    [x: string]: Field;
+};
+export {};

package/operations/entry/filtering/createFields.js

@@ -0,0 +1,108 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createFields = void 0;
+var _systemFields = require("./systemFields");
+var _plugins = require("../../../plugins");
+var _mapPlugins = require("./mapPlugins");
+const createFieldCollection = params => {
+  const {
+    fields,
+    parents,
+    transformValuePlugins,
+    valuePathPlugins,
+    system
+  } = params;
+  return fields.reduce((collection, field) => {
+    const transformPlugin = transformValuePlugins[field.type];
+    const valuePathPlugin = valuePathPlugins[field.type];
+    const basePath = system ? [] : ["values"];
+    /**
+     * The required fieldId is a product of all of its parents and its own fieldId.
+     */
+    const fieldId = [...parents, {
+      fieldId: field.fieldId,
+      multipleValues: field.multipleValues
+    }].map(f => f.fieldId).join(".");
+    collection[fieldId] = {
+      ...field,
+      parents,
+      system,
+      createPath: params => {
+        if (valuePathPlugin && valuePathPlugin.canUse(field, parents.map(p => p.fieldId))) {
+          return valuePathPlugin.createPath(params);
+        }
+        return basePath.concat(parents.map(parent => parent.fieldId)).concat([params.field.fieldId]).join(".");
+      },
+      transform: value => {
+        if (!transformPlugin) {
+          return value;
+        }
+        return transformPlugin.transform({
+          field,
+          value
+        });
+      }
+    };
+    const childFields = field.settings?.fields;
+    if (!childFields?.length) {
+      return collection;
+    }
+    const result = createFieldCollection({
+      fields: childFields,
+      parents: [...parents, {
+        fieldId: field.fieldId,
+        multipleValues: field.multipleValues
+      }],
+      transformValuePlugins,
+      valuePathPlugins,
+      system
+    });
+    Object.assign(collection, result);
+    return collection;
+  }, {});
+};
+/**
+ * This method will map the fieldId (fieldId -> field) to the actual field.
+ *
+ * In case of nested fields, fieldId is all the parent fieldIds + current one, joined by the dot (.).
+ */
+const createFields = params => {
+  const {
+    fields,
+    plugins
+  } = params;
+  const transformValuePlugins = (0, _mapPlugins.getMappedPlugins)({
+    plugins,
+    type: "cms-field-filter-value-transform",
+    property: "fieldType"
+  });
+  const valuePathPlugins = (0, _mapPlugins.getMappedPlugins)({
+    plugins,
+    type: _plugins.CmsEntryFieldFilterPathPlugin.type,
+    property: "fieldType"
+  });
+  const collection = createFieldCollection({
+    fields: (0, _systemFields.createSystemFields)(),
+    transformValuePlugins,
+    valuePathPlugins,
+    parents: [],
+    system: true
+  });
+  const result = createFieldCollection({
+    fields,
+    transformValuePlugins,
+    valuePathPlugins,
+    parents: [],
+    system: false
+  });
+  return {
+    ...collection,
+    ...result
+  };
+};
+exports.createFields = createFields;
+
+//# sourceMappingURL=createFields.js.map

package/operations/entry/filtering/createFields.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_systemFields","require","_plugins","_mapPlugins","createFieldCollection","params","fields","parents","transformValuePlugins","valuePathPlugins","system","reduce","collection","field","transformPlugin","type","valuePathPlugin","basePath","fieldId","multipleValues","map","f","join","createPath","canUse","p","concat","parent","transform","value","childFields","settings","length","result","Object","assign","createFields","plugins","getMappedPlugins","property","CmsEntryFieldFilterPathPlugin","createSystemFields","exports"],"sources":["createFields.ts"],"sourcesContent":["import type { CmsModelField } from \"@webiny/api-headless-cms/types\";\nimport { createSystemFields } from \"./systemFields\";\nimport type { Field, FieldParent } from \"./types\";\nimport type { PluginsContainer } from \"@webiny/plugins\";\nimport type { CmsFieldFilterValueTransformPlugin } from \"~/types\";\nimport { CmsEntryFieldFilterPathPlugin } from \"~/plugins\";\nimport { getMappedPlugins } from \"./mapPlugins\";\n\ninterface Params {\n    fields: CmsModelField[];\n    plugins: PluginsContainer;\n}\n\ninterface FieldCollection {\n    [key: string]: Field;\n}\n\ninterface AddFieldsToCollectionParams {\n    fields: CmsModelField[];\n    parents: FieldParent[];\n    transformValuePlugins: Record<string, CmsFieldFilterValueTransformPlugin>;\n    valuePathPlugins: Record<string, CmsEntryFieldFilterPathPlugin>;\n    system: boolean;\n}\n\nconst createFieldCollection = (params: AddFieldsToCollectionParams): FieldCollection => {\n    const { fields, parents, transformValuePlugins, valuePathPlugins, system } = params;\n    return fields.reduce<FieldCollection>((collection, field) => {\n        const transformPlugin = transformValuePlugins[field.type];\n        const valuePathPlugin = valuePathPlugins[field.type];\n\n        const basePath = system ? [] : [\"values\"];\n        /**\n         * The required fieldId is a product of all of its parents and its own fieldId.\n         */\n        const fieldId = [\n            ...parents,\n            {\n                fieldId: field.fieldId,\n                multipleValues: field.multipleValues\n            }\n        ]\n            .map(f => f.fieldId)\n            .join(\".\");\n\n        collection[fieldId] = {\n            ...field,\n            parents,\n            system,\n            createPath: params => {\n                if (\n                    valuePathPlugin &&\n                    valuePathPlugin.canUse(\n                        field,\n                        parents.map(p => p.fieldId)\n                    )\n                ) {\n                    return valuePathPlugin.createPath(params);\n                }\n\n                return basePath\n                    .concat(parents.map(parent => parent.fieldId))\n                    .concat([params.field.fieldId])\n                    .join(\".\");\n            },\n            transform: value => {\n                if (!transformPlugin) {\n                    return value;\n                }\n                return transformPlugin.transform({\n                    field,\n                    value\n                });\n            }\n        };\n        const childFields = field.settings?.fields;\n        if (!childFields?.length) {\n            return collection;\n        }\n\n        const result = createFieldCollection({\n            fields: childFields,\n            parents: [\n                ...parents,\n                {\n                    fieldId: field.fieldId,\n                    multipleValues: field.multipleValues\n                }\n            ],\n            transformValuePlugins,\n            valuePathPlugins,\n            system\n        });\n        Object.assign(collection, result);\n        return collection;\n    }, {});\n};\n/**\n * This method will map the fieldId (fieldId -> field) to the actual field.\n *\n * In case of nested fields, fieldId is all the parent fieldIds + current one, joined by the dot (.).\n */\nexport const createFields = (params: Params) => {\n    const { fields, plugins } = params;\n\n    const transformValuePlugins = getMappedPlugins<CmsFieldFilterValueTransformPlugin>({\n        plugins,\n        type: \"cms-field-filter-value-transform\",\n        property: \"fieldType\"\n    });\n    const valuePathPlugins = getMappedPlugins<CmsEntryFieldFilterPathPlugin>({\n        plugins,\n        type: CmsEntryFieldFilterPathPlugin.type,\n        property: \"fieldType\"\n    });\n\n    const collection = createFieldCollection({\n        fields: createSystemFields(),\n        transformValuePlugins,\n        valuePathPlugins,\n        parents: [],\n        system: true\n    });\n\n    const result = createFieldCollection({\n        fields,\n        transformValuePlugins,\n        valuePathPlugins,\n        parents: [],\n        system: false\n    });\n\n    return {\n        ...collection,\n        ...result\n    };\n};\n"],"mappings":";;;;;;AACA,IAAAA,aAAA,GAAAC,OAAA;AAIA,IAAAC,QAAA,GAAAD,OAAA;AACA,IAAAE,WAAA,GAAAF,OAAA;AAmBA,MAAMG,qBAAqB,GAAIC,MAAmC,IAAsB;EACpF,MAAM;IAAEC,MAAM;IAAEC,OAAO;IAAEC,qBAAqB;IAAEC,gBAAgB;IAAEC;EAAO,CAAC,GAAGL,MAAM;EACnF,OAAOC,MAAM,CAACK,MAAM,CAAkB,CAACC,UAAU,EAAEC,KAAK,KAAK;IACzD,MAAMC,eAAe,GAAGN,qBAAqB,CAACK,KAAK,CAACE,IAAI,CAAC;IACzD,MAAMC,eAAe,GAAGP,gBAAgB,CAACI,KAAK,CAACE,IAAI,CAAC;IAEpD,MAAME,QAAQ,GAAGP,MAAM,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC;IACzC;AACR;AACA;IACQ,MAAMQ,OAAO,GAAG,CACZ,GAAGX,OAAO,EACV;MACIW,OAAO,EAAEL,KAAK,CAACK,OAAO;MACtBC,cAAc,EAAEN,KAAK,CAACM;IAC1B,CAAC,CACJ,CACIC,GAAG,CAACC,CAAC,IAAIA,CAAC,CAACH,OAAO,CAAC,CACnBI,IAAI,CAAC,GAAG,CAAC;IAEdV,UAAU,CAACM,OAAO,CAAC,GAAG;MAClB,GAAGL,KAAK;MACRN,OAAO;MACPG,MAAM;MACNa,UAAU,EAAElB,MAAM,IAAI;QAClB,IACIW,eAAe,IACfA,eAAe,CAACQ,MAAM,CAClBX,KAAK,EACLN,OAAO,CAACa,GAAG,CAACK,CAAC,IAAIA,CAAC,CAACP,OAAO,CAC9B,CAAC,EACH;UACE,OAAOF,eAAe,CAACO,UAAU,CAAClB,MAAM,CAAC;QAC7C;QAEA,OAAOY,QAAQ,CACVS,MAAM,CAACnB,OAAO,CAACa,GAAG,CAACO,MAAM,IAAIA,MAAM,CAACT,OAAO,CAAC,CAAC,CAC7CQ,MAAM,CAAC,CAACrB,MAAM,CAACQ,KAAK,CAACK,OAAO,CAAC,CAAC,CAC9BI,IAAI,CAAC,GAAG,CAAC;MAClB,CAAC;MACDM,SAAS,EAAEC,KAAK,IAAI;QAChB,IAAI,CAACf,eAAe,EAAE;UAClB,OAAOe,KAAK;QAChB;QACA,OAAOf,eAAe,CAACc,SAAS,CAAC;UAC7Bf,KAAK;UACLgB;QACJ,CAAC,CAAC;MACN;IACJ,CAAC;IACD,MAAMC,WAAW,GAAGjB,KAAK,CAACkB,QAAQ,EAAEzB,MAAM;IAC1C,IAAI,CAACwB,WAAW,EAAEE,MAAM,EAAE;MACtB,OAAOpB,UAAU;IACrB;IAEA,MAAMqB,MAAM,GAAG7B,qBAAqB,CAAC;MACjCE,MAAM,EAAEwB,WAAW;MACnBvB,OAAO,EAAE,CACL,GAAGA,OAAO,EACV;QACIW,OAAO,EAAEL,KAAK,CAACK,OAAO;QACtBC,cAAc,EAAEN,KAAK,CAACM;MAC1B,CAAC,CACJ;MACDX,qBAAqB;MACrBC,gBAAgB;MAChBC;IACJ,CAAC,CAAC;IACFwB,MAAM,CAACC,MAAM,CAACvB,UAAU,EAAEqB,MAAM,CAAC;IACjC,OAAOrB,UAAU;EACrB,CAAC,EAAE,CAAC,CAAC,CAAC;AACV,CAAC;AACD;AACA;AACA;AACA;AACA;AACO,MAAMwB,YAAY,GAAI/B,MAAc,IAAK;EAC5C,MAAM;IAAEC,MAAM;IAAE+B;EAAQ,CAAC,GAAGhC,MAAM;EAElC,MAAMG,qBAAqB,GAAG,IAAA8B,4BAAgB,EAAqC;IAC/ED,OAAO;IACPtB,IAAI,EAAE,kCAAkC;IACxCwB,QAAQ,EAAE;EACd,CAAC,CAAC;EACF,MAAM9B,gBAAgB,GAAG,IAAA6B,4BAAgB,EAAgC;IACrED,OAAO;IACPtB,IAAI,EAAEyB,sCAA6B,CAACzB,IAAI;IACxCwB,QAAQ,EAAE;EACd,CAAC,CAAC;EAEF,MAAM3B,UAAU,GAAGR,qBAAqB,CAAC;IACrCE,MAAM,EAAE,IAAAmC,gCAAkB,EAAC,CAAC;IAC5BjC,qBAAqB;IACrBC,gBAAgB;IAChBF,OAAO,EAAE,EAAE;IACXG,MAAM,EAAE;EACZ,CAAC,CAAC;EAEF,MAAMuB,MAAM,GAAG7B,qBAAqB,CAAC;IACjCE,MAAM;IACNE,qBAAqB;IACrBC,gBAAgB;IAChBF,OAAO,EAAE,EAAE;IACXG,MAAM,EAAE;EACZ,CAAC,CAAC;EAEF,OAAO;IACH,GAAGE,UAAU;IACb,GAAGqB;EACP,CAAC;AACL,CAAC;AAACS,OAAA,CAAAN,YAAA,GAAAA,YAAA","ignoreList":[]}

package/operations/entry/filtering/extractSort.d.ts

@@ -0,0 +1,17 @@
+import type { Field } from "./types";
+import type { PluginsContainer } from "@webiny/plugins";
+import type { CmsModel } from "@webiny/api-headless-cms/types";
+interface Result {
+    valuePath: string;
+    reverse: boolean;
+    fieldId: string;
+    field: Field;
+}
+interface Params {
+    model: CmsModel;
+    sortBy: string;
+    fields: Record<string, Field>;
+    plugins: PluginsContainer;
+}
+export declare const extractSort: (params: Params) => Result;
+export {};

package/operations/entry/filtering/extractSort.js

@@ -0,0 +1,69 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extractSort = void 0;
+var _error = _interopRequireDefault(require("@webiny/error"));
+var _plugins = require("../../../plugins");
+const extractSort = params => {
+  const {
+    model,
+    sortBy,
+    fields,
+    plugins
+  } = params;
+  const result = sortBy.split("_");
+  if (result.length !== 2) {
+    throw new _error.default("Problem in determining the sorting for the entry items.", "SORT_EXTRACT_ERROR", {
+      sortBy
+    });
+  }
+  const [fieldId, order] = result;
+  const field = Object.values(fields).find(field => {
+    /**
+     * We do not support sorting by nested fields.
+     */
+    if (field.parents.length > 0) {
+      return false;
+    }
+    return field.fieldId === fieldId;
+  });
+  const plugin = plugins.byType(_plugins.CmsEntryFieldSortingPlugin.type).reverse().find(plugin => {
+    return plugin.canUse({
+      model,
+      field,
+      fieldId,
+      order,
+      sortBy
+    });
+  });
+  if (plugin) {
+    return plugin.createSort({
+      model,
+      fieldId,
+      order,
+      sortBy,
+      field,
+      fields
+    });
+  } else if (!field) {
+    throw new _error.default("Sorting field does not exist in the content model.", "SORTING_FIELD_ERROR", {
+      fieldId,
+      fields
+    });
+  }
+  const valuePath = field.createPath({
+    field
+  });
+  return {
+    field,
+    fieldId,
+    valuePath,
+    reverse: order === "DESC"
+  };
+};
+exports.extractSort = extractSort;
+
+//# sourceMappingURL=extractSort.js.map

package/operations/entry/filtering/extractSort.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_error","_interopRequireDefault","require","_plugins","extractSort","params","model","sortBy","fields","plugins","result","split","length","WebinyError","fieldId","order","field","Object","values","find","parents","plugin","byType","CmsEntryFieldSortingPlugin","type","reverse","canUse","createSort","valuePath","createPath","exports"],"sources":["extractSort.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport type { Field } from \"./types\";\nimport type { PluginsContainer } from \"@webiny/plugins\";\nimport { CmsEntryFieldSortingPlugin } from \"~/plugins\";\nimport type { CmsModel } from \"@webiny/api-headless-cms/types\";\n\ninterface Result {\n    valuePath: string;\n    reverse: boolean;\n    fieldId: string;\n    field: Field;\n}\n\ninterface Params {\n    model: CmsModel;\n    sortBy: string;\n    fields: Record<string, Field>;\n    plugins: PluginsContainer;\n}\n\nexport const extractSort = (params: Params): Result => {\n    const { model, sortBy, fields, plugins } = params;\n    const result = sortBy.split(\"_\");\n    if (result.length !== 2) {\n        throw new WebinyError(\n            \"Problem in determining the sorting for the entry items.\",\n            \"SORT_EXTRACT_ERROR\",\n            {\n                sortBy\n            }\n        );\n    }\n    const [fieldId, order] = result as [string, \"ASC\" | \"DESC\"];\n\n    const field = Object.values(fields).find(field => {\n        /**\n         * We do not support sorting by nested fields.\n         */\n        if (field.parents.length > 0) {\n            return false;\n        }\n        return field.fieldId === fieldId;\n    });\n\n    const plugin = plugins\n        .byType<CmsEntryFieldSortingPlugin>(CmsEntryFieldSortingPlugin.type)\n        .reverse()\n        .find(plugin => {\n            return plugin.canUse({\n                model,\n                field,\n                fieldId,\n                order,\n                sortBy\n            });\n        });\n\n    if (plugin) {\n        return plugin.createSort({\n            model,\n            fieldId,\n            order,\n            sortBy,\n            field,\n            fields\n        });\n    } else if (!field) {\n        throw new WebinyError(\n            \"Sorting field does not exist in the content model.\",\n            \"SORTING_FIELD_ERROR\",\n            {\n                fieldId,\n                fields\n            }\n        );\n    }\n    const valuePath = field.createPath({\n        field\n    });\n    return {\n        field,\n        fieldId,\n        valuePath,\n        reverse: order === \"DESC\"\n    };\n};\n"],"mappings":";;;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AAGA,IAAAC,QAAA,GAAAD,OAAA;AAiBO,MAAME,WAAW,GAAIC,MAAc,IAAa;EACnD,MAAM;IAAEC,KAAK;IAAEC,MAAM;IAAEC,MAAM;IAAEC;EAAQ,CAAC,GAAGJ,MAAM;EACjD,MAAMK,MAAM,GAAGH,MAAM,CAACI,KAAK,CAAC,GAAG,CAAC;EAChC,IAAID,MAAM,CAACE,MAAM,KAAK,CAAC,EAAE;IACrB,MAAM,IAAIC,cAAW,CACjB,yDAAyD,EACzD,oBAAoB,EACpB;MACIN;IACJ,CACJ,CAAC;EACL;EACA,MAAM,CAACO,OAAO,EAAEC,KAAK,CAAC,GAAGL,MAAkC;EAE3D,MAAMM,KAAK,GAAGC,MAAM,CAACC,MAAM,CAACV,MAAM,CAAC,CAACW,IAAI,CAACH,KAAK,IAAI;IAC9C;AACR;AACA;IACQ,IAAIA,KAAK,CAACI,OAAO,CAACR,MAAM,GAAG,CAAC,EAAE;MAC1B,OAAO,KAAK;IAChB;IACA,OAAOI,KAAK,CAACF,OAAO,KAAKA,OAAO;EACpC,CAAC,CAAC;EAEF,MAAMO,MAAM,GAAGZ,OAAO,CACjBa,MAAM,CAA6BC,mCAA0B,CAACC,IAAI,CAAC,CACnEC,OAAO,CAAC,CAAC,CACTN,IAAI,CAACE,MAAM,IAAI;IACZ,OAAOA,MAAM,CAACK,MAAM,CAAC;MACjBpB,KAAK;MACLU,KAAK;MACLF,OAAO;MACPC,KAAK;MACLR;IACJ,CAAC,CAAC;EACN,CAAC,CAAC;EAEN,IAAIc,MAAM,EAAE;IACR,OAAOA,MAAM,CAACM,UAAU,CAAC;MACrBrB,KAAK;MACLQ,OAAO;MACPC,KAAK;MACLR,MAAM;MACNS,KAAK;MACLR;IACJ,CAAC,CAAC;EACN,CAAC,MAAM,IAAI,CAACQ,KAAK,EAAE;IACf,MAAM,IAAIH,cAAW,CACjB,oDAAoD,EACpD,qBAAqB,EACrB;MACIC,OAAO;MACPN;IACJ,CACJ,CAAC;EACL;EACA,MAAMoB,SAAS,GAAGZ,KAAK,CAACa,UAAU,CAAC;IAC/Bb;EACJ,CAAC,CAAC;EACF,OAAO;IACHA,KAAK;IACLF,OAAO;IACPc,SAAS;IACTH,OAAO,EAAEV,KAAK,KAAK;EACvB,CAAC;AACL,CAAC;AAACe,OAAA,CAAA1B,WAAA,GAAAA,WAAA","ignoreList":[]}

package/operations/entry/filtering/filter.d.ts

@@ -0,0 +1,15 @@
+import type { CmsEntry, CmsEntryListWhere } from "@webiny/api-headless-cms/types";
+import type { PluginsContainer } from "@webiny/plugins";
+import type { Field } from "./types";
+interface Params {
+    items: CmsEntry[];
+    where: Partial<CmsEntryListWhere>;
+    plugins: PluginsContainer;
+    fields: Record<string, Field>;
+    fullTextSearch?: {
+        term?: string;
+        fields?: string[];
+    };
+}
+export declare const filter: (params: Params) => CmsEntry[];
+export {};

package/operations/entry/filtering/filter.js

@@ -0,0 +1,158 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.filter = void 0;
+var _ValueFilterPlugin = require("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin");
+var _error = _interopRequireDefault(require("@webiny/error"));
+var _fullTextSearch = require("./fullTextSearch");
+var _createExpressions = require("./createExpressions");
+var _transform = require("./transform");
+var _getValue = require("./getValue");
+const executeFilter = params => {
+  const {
+    value,
+    filter
+  } = params;
+
+  /**
+   * We need to check if the filter can be used.
+   * If it cannot, we will just return true.
+   */
+  const canUse = filter.plugin.canUse({
+    value,
+    compareValue: filter.compareValue
+  });
+  if (!canUse) {
+    return true;
+  }
+  const matched = filter.plugin.matches({
+    value,
+    compareValue: filter.compareValue
+  });
+  if (filter.negate) {
+    return matched === false;
+  }
+  return matched;
+};
+const executeExpressions = params => {
+  const {
+    expressions,
+    getCachedValue,
+    filters,
+    condition
+  } = params;
+  if (expressions.length === 0 && filters.length === 0) {
+    return true;
+  }
+  /**
+   * Always run filters first as they might trigger an early return.
+   */
+  for (const filter of filters) {
+    const value = getCachedValue(filter);
+    const result = executeFilter({
+      value,
+      filter
+    });
+    /**
+     * Filters are ALWAYS executed as an AND.
+     * So if even one is false, everything false.
+     */
+    if (!result) {
+      return false;
+    }
+  }
+  /**
+   * Then we move onto expressions, which are basically nested upon nested filters with different conditions.
+   */
+  for (const expression of expressions) {
+    const result = executeExpressions({
+      ...expression,
+      getCachedValue
+    });
+    if (result && condition === "OR") {
+      return true;
+    } else if (!result && condition == "AND") {
+      return false;
+    }
+  }
+  /**
+   * If condition is an OR, we can fail the expressions check because the code would return a lot earlier than this line.
+   *
+   * Also, if condition is not an OR, we can say that the expressions check is ok, because it would fail a lot earlier than this line.
+   */
+  return condition === "OR" ? false : true;
+};
+const filter = params => {
+  const {
+    items: records,
+    where,
+    plugins,
+    fields,
+    fullTextSearch
+  } = params;
+  const keys = Object.keys(where);
+  if (keys.length === 0 && !fullTextSearch) {
+    return records;
+  }
+  const expression = (0, _createExpressions.createExpressions)({
+    plugins,
+    where,
+    fields
+  });
+
+  /**
+   * No point in going further if there are no expressions to be applied and no full text search to be executed.
+   */
+  if (expression.filters.length === 0 && expression.expressions.length === 0 && !fullTextSearch?.term) {
+    return records;
+  }
+  /**
+   * We need the contains plugin to run the full text search.
+   */
+  const fullTextSearchPlugin = plugins.byType(_ValueFilterPlugin.ValueFilterPlugin.type).find(plugin => plugin.getOperation() === "contains");
+  if (!fullTextSearchPlugin) {
+    throw new _error.default(`Missing "contains" plugin to run the full-text search.`, "MISSING_PLUGIN");
+  }
+  const search = (0, _fullTextSearch.createFullTextSearch)({
+    term: fullTextSearch?.term,
+    targetFields: fullTextSearch?.fields,
+    fields,
+    plugin: fullTextSearchPlugin
+  });
+  return records.filter(record => {
+    const cachedValues = {};
+    const getCachedValue = filter => {
+      const {
+        path
+      } = filter;
+      if (cachedValues[path] !== undefined) {
+        return cachedValues[path];
+      }
+      const plainValue = (0, _getValue.getValue)(record, path);
+      const rawValue = (0, _transform.transformValue)({
+        value: plainValue,
+        transform: filter.transformValue
+      });
+      cachedValues[path] = rawValue;
+      return rawValue;
+    };
+    const exprResult = executeExpressions({
+      ...expression,
+      getCachedValue
+    });
+    /**
+     * If expression result is false we do not need to continue further.
+     * Also, if there is no full text search defined, just return the expression result.
+     */
+    if (!exprResult || !search) {
+      return exprResult;
+    }
+    return search(record);
+  });
+};
+exports.filter = filter;
+
+//# sourceMappingURL=filter.js.map

package/operations/entry/filtering/filter.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_ValueFilterPlugin","require","_error","_interopRequireDefault","_fullTextSearch","_createExpressions","_transform","_getValue","executeFilter","params","value","filter","canUse","plugin","compareValue","matched","matches","negate","executeExpressions","expressions","getCachedValue","filters","condition","length","result","expression","items","records","where","plugins","fields","fullTextSearch","keys","Object","createExpressions","term","fullTextSearchPlugin","byType","ValueFilterPlugin","type","find","getOperation","WebinyError","search","createFullTextSearch","targetFields","record","cachedValues","path","undefined","plainValue","getValue","rawValue","transformValue","transform","exprResult","exports"],"sources":["filter.ts"],"sourcesContent":["import type { CmsEntry, CmsEntryListWhere } from \"@webiny/api-headless-cms/types\";\nimport { ValueFilterPlugin } from \"@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin\";\nimport WebinyError from \"@webiny/error\";\nimport type { PluginsContainer } from \"@webiny/plugins\";\nimport type { Field } from \"./types\";\nimport { createFullTextSearch } from \"./fullTextSearch\";\nimport type { Expression, ExpressionCondition, Filter } from \"./createExpressions\";\nimport { createExpressions } from \"./createExpressions\";\nimport { transformValue } from \"./transform\";\nimport { getValue } from \"~/operations/entry/filtering/getValue\";\n\ninterface ExecuteFilterParams {\n    value: any;\n    filter: Filter;\n}\n\nconst executeFilter = (params: ExecuteFilterParams) => {\n    const { value, filter } = params;\n\n    /**\n     * We need to check if the filter can be used.\n     * If it cannot, we will just return true.\n     */\n    const canUse = filter.plugin.canUse({\n        value,\n        compareValue: filter.compareValue\n    });\n    if (!canUse) {\n        return true;\n    }\n\n    const matched = filter.plugin.matches({\n        value,\n        compareValue: filter.compareValue\n    });\n    if (filter.negate) {\n        return matched === false;\n    }\n    return matched;\n};\n\ninterface ExecuteExpressionsParams {\n    getCachedValue: (filter: Filter) => Promise<any>;\n    expressions: Expression[];\n    filters: Filter[];\n    condition: ExpressionCondition;\n}\n\nconst executeExpressions = (params: ExecuteExpressionsParams): boolean => {\n    const { expressions, getCachedValue, filters, condition } = params;\n    if (expressions.length === 0 && filters.length === 0) {\n        return true;\n    }\n    /**\n     * Always run filters first as they might trigger an early return.\n     */\n    for (const filter of filters) {\n        const value = getCachedValue(filter);\n\n        const result = executeFilter({\n            value,\n            filter\n        });\n        /**\n         * Filters are ALWAYS executed as an AND.\n         * So if even one is false, everything false.\n         */\n        if (!result) {\n            return false;\n        }\n    }\n    /**\n     * Then we move onto expressions, which are basically nested upon nested filters with different conditions.\n     */\n    for (const expression of expressions) {\n        const result = executeExpressions({\n            ...expression,\n            getCachedValue\n        });\n        if (result && condition === \"OR\") {\n            return true;\n        } else if (!result && condition == \"AND\") {\n            return false;\n        }\n    }\n    /**\n     * If condition is an OR, we can fail the expressions check because the code would return a lot earlier than this line.\n     *\n     * Also, if condition is not an OR, we can say that the expressions check is ok, because it would fail a lot earlier than this line.\n     */\n    return condition === \"OR\" ? false : true;\n};\n\ninterface Params {\n    items: CmsEntry[];\n    where: Partial<CmsEntryListWhere>;\n    plugins: PluginsContainer;\n    fields: Record<string, Field>;\n    fullTextSearch?: {\n        term?: string;\n        fields?: string[];\n    };\n}\n\nexport const filter = (params: Params): CmsEntry[] => {\n    const { items: records, where, plugins, fields, fullTextSearch } = params;\n\n    const keys = Object.keys(where);\n    if (keys.length === 0 && !fullTextSearch) {\n        return records;\n    }\n    const expression = createExpressions({\n        plugins,\n        where,\n        fields\n    });\n\n    /**\n     * No point in going further if there are no expressions to be applied and no full text search to be executed.\n     */\n    if (\n        expression.filters.length === 0 &&\n        expression.expressions.length === 0 &&\n        !fullTextSearch?.term\n    ) {\n        return records;\n    }\n    /**\n     * We need the contains plugin to run the full text search.\n     */\n    const fullTextSearchPlugin = plugins\n        .byType<ValueFilterPlugin>(ValueFilterPlugin.type)\n        .find(plugin => plugin.getOperation() === \"contains\");\n    if (!fullTextSearchPlugin) {\n        throw new WebinyError(\n            `Missing \"contains\" plugin to run the full-text search.`,\n            \"MISSING_PLUGIN\"\n        );\n    }\n\n    const search = createFullTextSearch({\n        term: fullTextSearch?.term,\n        targetFields: fullTextSearch?.fields,\n        fields,\n        plugin: fullTextSearchPlugin\n    });\n\n    return records.filter(record => {\n        const cachedValues: Record<string, any> = {};\n\n        const getCachedValue = (filter: Filter) => {\n            const { path } = filter;\n            if (cachedValues[path] !== undefined) {\n                return cachedValues[path];\n            }\n            const plainValue = getValue(record, path);\n\n            const rawValue = transformValue({\n                value: plainValue,\n                transform: filter.transformValue\n            });\n\n            cachedValues[path] = rawValue;\n            return rawValue;\n        };\n\n        const exprResult = executeExpressions({ ...expression, getCachedValue });\n        /**\n         * If expression result is false we do not need to continue further.\n         * Also, if there is no full text search defined, just return the expression result.\n         */\n        if (!exprResult || !search) {\n            return exprResult;\n        }\n\n        return search(record);\n    });\n};\n"],"mappings":";;;;;;;AACA,IAAAA,kBAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAC,sBAAA,CAAAF,OAAA;AAGA,IAAAG,eAAA,GAAAH,OAAA;AAEA,IAAAI,kBAAA,GAAAJ,OAAA;AACA,IAAAK,UAAA,GAAAL,OAAA;AACA,IAAAM,SAAA,GAAAN,OAAA;AAOA,MAAMO,aAAa,GAAIC,MAA2B,IAAK;EACnD,MAAM;IAAEC,KAAK;IAAEC;EAAO,CAAC,GAAGF,MAAM;;EAEhC;AACJ;AACA;AACA;EACI,MAAMG,MAAM,GAAGD,MAAM,CAACE,MAAM,CAACD,MAAM,CAAC;IAChCF,KAAK;IACLI,YAAY,EAAEH,MAAM,CAACG;EACzB,CAAC,CAAC;EACF,IAAI,CAACF,MAAM,EAAE;IACT,OAAO,IAAI;EACf;EAEA,MAAMG,OAAO,GAAGJ,MAAM,CAACE,MAAM,CAACG,OAAO,CAAC;IAClCN,KAAK;IACLI,YAAY,EAAEH,MAAM,CAACG;EACzB,CAAC,CAAC;EACF,IAAIH,MAAM,CAACM,MAAM,EAAE;IACf,OAAOF,OAAO,KAAK,KAAK;EAC5B;EACA,OAAOA,OAAO;AAClB,CAAC;AASD,MAAMG,kBAAkB,GAAIT,MAAgC,IAAc;EACtE,MAAM;IAAEU,WAAW;IAAEC,cAAc;IAAEC,OAAO;IAAEC;EAAU,CAAC,GAAGb,MAAM;EAClE,IAAIU,WAAW,CAACI,MAAM,KAAK,CAAC,IAAIF,OAAO,CAACE,MAAM,KAAK,CAAC,EAAE;IAClD,OAAO,IAAI;EACf;EACA;AACJ;AACA;EACI,KAAK,MAAMZ,MAAM,IAAIU,OAAO,EAAE;IAC1B,MAAMX,KAAK,GAAGU,cAAc,CAACT,MAAM,CAAC;IAEpC,MAAMa,MAAM,GAAGhB,aAAa,CAAC;MACzBE,KAAK;MACLC;IACJ,CAAC,CAAC;IACF;AACR;AACA;AACA;IACQ,IAAI,CAACa,MAAM,EAAE;MACT,OAAO,KAAK;IAChB;EACJ;EACA;AACJ;AACA;EACI,KAAK,MAAMC,UAAU,IAAIN,WAAW,EAAE;IAClC,MAAMK,MAAM,GAAGN,kBAAkB,CAAC;MAC9B,GAAGO,UAAU;MACbL;IACJ,CAAC,CAAC;IACF,IAAII,MAAM,IAAIF,SAAS,KAAK,IAAI,EAAE;MAC9B,OAAO,IAAI;IACf,CAAC,MAAM,IAAI,CAACE,MAAM,IAAIF,SAAS,IAAI,KAAK,EAAE;MACtC,OAAO,KAAK;IAChB;EACJ;EACA;AACJ;AACA;AACA;AACA;EACI,OAAOA,SAAS,KAAK,IAAI,GAAG,KAAK,GAAG,IAAI;AAC5C,CAAC;AAaM,MAAMX,MAAM,GAAIF,MAAc,IAAiB;EAClD,MAAM;IAAEiB,KAAK,EAAEC,OAAO;IAAEC,KAAK;IAAEC,OAAO;IAAEC,MAAM;IAAEC;EAAe,CAAC,GAAGtB,MAAM;EAEzE,MAAMuB,IAAI,GAAGC,MAAM,CAACD,IAAI,CAACJ,KAAK,CAAC;EAC/B,IAAII,IAAI,CAACT,MAAM,KAAK,CAAC,IAAI,CAACQ,cAAc,EAAE;IACtC,OAAOJ,OAAO;EAClB;EACA,MAAMF,UAAU,GAAG,IAAAS,oCAAiB,EAAC;IACjCL,OAAO;IACPD,KAAK;IACLE;EACJ,CAAC,CAAC;;EAEF;AACJ;AACA;EACI,IACIL,UAAU,CAACJ,OAAO,CAACE,MAAM,KAAK,CAAC,IAC/BE,UAAU,CAACN,WAAW,CAACI,MAAM,KAAK,CAAC,IACnC,CAACQ,cAAc,EAAEI,IAAI,EACvB;IACE,OAAOR,OAAO;EAClB;EACA;AACJ;AACA;EACI,MAAMS,oBAAoB,GAAGP,OAAO,CAC/BQ,MAAM,CAAoBC,oCAAiB,CAACC,IAAI,CAAC,CACjDC,IAAI,CAAC3B,MAAM,IAAIA,MAAM,CAAC4B,YAAY,CAAC,CAAC,KAAK,UAAU,CAAC;EACzD,IAAI,CAACL,oBAAoB,EAAE;IACvB,MAAM,IAAIM,cAAW,CACjB,wDAAwD,EACxD,gBACJ,CAAC;EACL;EAEA,MAAMC,MAAM,GAAG,IAAAC,oCAAoB,EAAC;IAChCT,IAAI,EAAEJ,cAAc,EAAEI,IAAI;IAC1BU,YAAY,EAAEd,cAAc,EAAED,MAAM;IACpCA,MAAM;IACNjB,MAAM,EAAEuB;EACZ,CAAC,CAAC;EAEF,OAAOT,OAAO,CAAChB,MAAM,CAACmC,MAAM,IAAI;IAC5B,MAAMC,YAAiC,GAAG,CAAC,CAAC;IAE5C,MAAM3B,cAAc,GAAIT,MAAc,IAAK;MACvC,MAAM;QAAEqC;MAAK,CAAC,GAAGrC,MAAM;MACvB,IAAIoC,YAAY,CAACC,IAAI,CAAC,KAAKC,SAAS,EAAE;QAClC,OAAOF,YAAY,CAACC,IAAI,CAAC;MAC7B;MACA,MAAME,UAAU,GAAG,IAAAC,kBAAQ,EAACL,MAAM,EAAEE,IAAI,CAAC;MAEzC,MAAMI,QAAQ,GAAG,IAAAC,yBAAc,EAAC;QAC5B3C,KAAK,EAAEwC,UAAU;QACjBI,SAAS,EAAE3C,MAAM,CAAC0C;MACtB,CAAC,CAAC;MAEFN,YAAY,CAACC,IAAI,CAAC,GAAGI,QAAQ;MAC7B,OAAOA,QAAQ;IACnB,CAAC;IAED,MAAMG,UAAU,GAAGrC,kBAAkB,CAAC;MAAE,GAAGO,UAAU;MAAEL;IAAe,CAAC,CAAC;IACxE;AACR;AACA;AACA;IACQ,IAAI,CAACmC,UAAU,IAAI,CAACZ,MAAM,EAAE;MACxB,OAAOY,UAAU;IACrB;IAEA,OAAOZ,MAAM,CAACG,MAAM,CAAC;EACzB,CAAC,CAAC;AACN,CAAC;AAACU,OAAA,CAAA7C,MAAA,GAAAA,MAAA","ignoreList":[]}

package/operations/entry/filtering/fullTextSearch.d.ts

@@ -0,0 +1,14 @@
+import type { ValueFilterPlugin } from "@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin";
+import type { CmsEntry } from "@webiny/api-headless-cms/types";
+import type { Field } from "./types";
+interface Params {
+    term?: string;
+    targetFields?: string[];
+    fields: Record<string, Field>;
+    plugin: ValueFilterPlugin;
+}
+/**
+ * Unfortunately we must use the contains plugin directly as plugins do not support multi field searching.
+ */
+export declare const createFullTextSearch: (params: Params) => ((item: CmsEntry) => boolean) | null;
+export {};