@webiny/api-elasticsearch 0.0.0-mt-2 → 0.0.0-unstable.5e7233243f

package/plugins/operator/notStartsWith.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ElasticsearchQueryBuilderOperatorNotStartsWithPlugin","ElasticsearchQueryBuilderOperatorPlugin","getOperator","apply","query","params","value","basePath","must_not","push","match_phrase_prefix"],"sources":["notStartsWith.ts"],"sourcesContent":["import { ElasticsearchQueryBuilderOperatorPlugin } from \"~/plugins/definition/ElasticsearchQueryBuilderOperatorPlugin\";\nimport { ElasticsearchBoolQueryConfig, ElasticsearchQueryBuilderArgsPlugin } from \"~/types\";\n\nexport class ElasticsearchQueryBuilderOperatorNotStartsWithPlugin extends ElasticsearchQueryBuilderOperatorPlugin {\n    public override name = \"elasticsearch.queryBuilder.operator.notStartsWith.default\";\n\n    public getOperator(): string {\n        return \"not_startsWith\";\n    }\n\n    public apply(\n        query: ElasticsearchBoolQueryConfig,\n        params: ElasticsearchQueryBuilderArgsPlugin\n    ): void {\n        const { value, basePath } = params;\n        query.must_not.push({\n            match_phrase_prefix: {\n                [basePath]: value\n            }\n        });\n    }\n}\n"],"mappings":";;;;;;;;;;;AAAA;;AAGO,MAAMA,oDAAN,SAAmEC,gFAAnE,CAA2G;EAAA;IAAA;IAAA,4CACvF,2DADuF;EAAA;;EAGvGC,WAAW,GAAW;IACzB,OAAO,gBAAP;EACH;;EAEMC,KAAK,CACRC,KADQ,EAERC,MAFQ,EAGJ;IACJ,MAAM;MAAEC,KAAF;MAASC;IAAT,IAAsBF,MAA5B;IACAD,KAAK,CAACI,QAAN,CAAeC,IAAf,CAAoB;MAChBC,mBAAmB,EAAE;QACjB,CAACH,QAAD,GAAYD;MADK;IADL,CAApB;EAKH;;AAjB6G"}

package/plugins/operator/startsWith.d.ts

@@ -0,0 +1,7 @@
+import { ElasticsearchQueryBuilderOperatorPlugin } from "../definition/ElasticsearchQueryBuilderOperatorPlugin";
+import { ElasticsearchBoolQueryConfig, ElasticsearchQueryBuilderArgsPlugin } from "../../types";
+export declare class ElasticsearchQueryBuilderOperatorStartsWithPlugin extends ElasticsearchQueryBuilderOperatorPlugin {
+    name: string;
+    getOperator(): string;
+    apply(query: ElasticsearchBoolQueryConfig, params: ElasticsearchQueryBuilderArgsPlugin): void;
+}

package/plugins/operator/startsWith.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ElasticsearchQueryBuilderOperatorStartsWithPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _ElasticsearchQueryBuilderOperatorPlugin = require("../definition/ElasticsearchQueryBuilderOperatorPlugin");
+
+class ElasticsearchQueryBuilderOperatorStartsWithPlugin extends _ElasticsearchQueryBuilderOperatorPlugin.ElasticsearchQueryBuilderOperatorPlugin {
+  constructor(...args) {
+    super(...args);
+    (0, _defineProperty2.default)(this, "name", "elasticsearch.queryBuilder.operator.startsWith.default");
+  }
+
+  getOperator() {
+    return "startsWith";
+  }
+
+  apply(query, params) {
+    const {
+      value,
+      basePath
+    } = params;
+    query.must.push({
+      match_phrase_prefix: {
+        [basePath]: value
+      }
+    });
+  }
+
+}
+
+exports.ElasticsearchQueryBuilderOperatorStartsWithPlugin = ElasticsearchQueryBuilderOperatorStartsWithPlugin;

package/plugins/operator/startsWith.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ElasticsearchQueryBuilderOperatorStartsWithPlugin","ElasticsearchQueryBuilderOperatorPlugin","getOperator","apply","query","params","value","basePath","must","push","match_phrase_prefix"],"sources":["startsWith.ts"],"sourcesContent":["import { ElasticsearchQueryBuilderOperatorPlugin } from \"~/plugins/definition/ElasticsearchQueryBuilderOperatorPlugin\";\nimport { ElasticsearchBoolQueryConfig, ElasticsearchQueryBuilderArgsPlugin } from \"~/types\";\n\nexport class ElasticsearchQueryBuilderOperatorStartsWithPlugin extends ElasticsearchQueryBuilderOperatorPlugin {\n    public override name = \"elasticsearch.queryBuilder.operator.startsWith.default\";\n\n    public getOperator(): string {\n        return \"startsWith\";\n    }\n\n    public apply(\n        query: ElasticsearchBoolQueryConfig,\n        params: ElasticsearchQueryBuilderArgsPlugin\n    ): void {\n        const { value, basePath } = params;\n        query.must.push({\n            match_phrase_prefix: {\n                [basePath]: value\n            }\n        });\n    }\n}\n"],"mappings":";;;;;;;;;;;AAAA;;AAGO,MAAMA,iDAAN,SAAgEC,gFAAhE,CAAwG;EAAA;IAAA;IAAA,4CACpF,wDADoF;EAAA;;EAGpGC,WAAW,GAAW;IACzB,OAAO,YAAP;EACH;;EAEMC,KAAK,CACRC,KADQ,EAERC,MAFQ,EAGJ;IACJ,MAAM;MAAEC,KAAF;MAASC;IAAT,IAAsBF,MAA5B;IACAD,KAAK,CAACI,IAAN,CAAWC,IAAX,CAAgB;MACZC,mBAAmB,EAAE;QACjB,CAACH,QAAD,GAAYD;MADK;IADT,CAAhB;EAKH;;AAjB0G"}

package/sort.d.ts

@@ -1,7 +1,11 @@
 import { SortType, SortOrder } from "./types";
 import { ElasticsearchFieldPlugin } from "./plugins/definition/ElasticsearchFieldPlugin";
-export interface Params {
-    sort: string[];
+interface SortOption {
+    path: string;
+    order: "ASC" | "DESC" | "asc" | "desc";
+}
+interface CreateSortParams {
+    sort: string[] | SortOption[];
     defaults?: {
         field?: string;
         order?: SortOrder;
@@ -9,4 +13,5 @@ export interface Params {
     };
     fieldPlugins: Record<string, ElasticsearchFieldPlugin>;
 }
-export declare const createSort: (params: Params) => SortType;
+export declare const createSort: (params: CreateSortParams) => SortType;
+export {};

package/sort.js

@@ -9,8 +9,9 @@ exports.createSort = void 0;
 
 var _error = _interopRequireDefault(require("@webiny/error"));
 
-const sortRegExp = new RegExp(/^([a-zA-Z-0-9_]+)_(ASC|DESC)$/);
+const sortRegExp = new RegExp(/^([a-zA-Z-0-9_@]+)_(ASC|DESC)$/);
 
+// TODO refactor so the sort input is of SortOption type
 const createSort = params => {
   const {
     sort,
@@ -35,8 +36,17 @@ const createSort = params => {
       }
     };
   }
+  /**
+   * Cast as string because nothing else should be allowed yet.
+   */
+  // @ts-refactor
+
 
   return sort.reduce((acc, value) => {
+    if (typeof value !== "string") {
+      throw new _error.default(`Sort as object is not supported..`);
+    }
+
     const match = value.match(sortRegExp);
 
     if (!match) {

package/sort.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["sortRegExp","RegExp","createSort","params","sort","defaults","fieldPlugins","length","field","order","unmappedType","unmapped_type","undefined","reduce","acc","value","WebinyError","match","initialOrder","toLowerCase","plugin","path","getPath","getSortOptions"],"sources":["sort.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { FieldSortOptions, SortType, SortOrder } from \"./types\";\nimport { ElasticsearchFieldPlugin } from \"./plugins/definition/ElasticsearchFieldPlugin\";\n\nconst sortRegExp = new RegExp(/^([a-zA-Z-0-9_@]+)_(ASC|DESC)$/);\n\ninterface SortOption {\n    path: string;\n    order: \"ASC\" | \"DESC\" | \"asc\" | \"desc\";\n}\ninterface CreateSortParams {\n    sort: string[] | SortOption[];\n    defaults?: {\n        field?: string;\n        order?: SortOrder;\n        unmappedType?: string;\n    };\n    fieldPlugins: Record<string, ElasticsearchFieldPlugin>;\n}\n// TODO refactor so the sort input is of SortOption type\nexport const createSort = (params: CreateSortParams): SortType => {\n    const { sort, defaults, fieldPlugins } = params;\n    if (!sort || sort.length === 0) {\n        const { field, order, unmappedType } = defaults || {};\n        /**\n         * We say that our system defaults is always id since all records we create have some kind of primary ID.\n         */\n        return {\n            [field || \"id.keyword\"]: {\n                order: order || \"desc\",\n                unmapped_type: unmappedType || undefined\n            }\n        };\n    }\n    /**\n     * Cast as string because nothing else should be allowed yet.\n     */\n    // @ts-refactor\n    return (sort as string[]).reduce((acc, value) => {\n        if (typeof value !== \"string\") {\n            throw new WebinyError(`Sort as object is not supported..`);\n        }\n        const match = value.match(sortRegExp);\n\n        if (!match) {\n            throw new WebinyError(`Cannot sort by \"${value}\".`);\n        }\n\n        const [, field, initialOrder] = match;\n        const order: SortOrder = initialOrder.toLowerCase() === \"asc\" ? \"asc\" : \"desc\";\n\n        const plugin: ElasticsearchFieldPlugin = fieldPlugins[field] || fieldPlugins[\"*\"];\n        if (!plugin) {\n            throw new WebinyError(`Missing plugin for the field \"${field}\"`, \"PLUGIN_SORT_ERROR\", {\n                field\n            });\n        }\n        /**\n         * In case field plugin is the global one, change the * with actual field name.\n         * Custom path methods will return their own values anyway so replacing * will not matter.\n         */\n        const path = plugin.getPath(field);\n\n        acc[path] = plugin.getSortOptions(order);\n\n        return acc;\n    }, {} as Record<string, FieldSortOptions>);\n};\n"],"mappings":";;;;;;;;;AAAA;;AAIA,MAAMA,UAAU,GAAG,IAAIC,MAAJ,CAAW,gCAAX,CAAnB;;AAeA;AACO,MAAMC,UAAU,GAAIC,MAAD,IAAwC;EAC9D,MAAM;IAAEC,IAAF;IAAQC,QAAR;IAAkBC;EAAlB,IAAmCH,MAAzC;;EACA,IAAI,CAACC,IAAD,IAASA,IAAI,CAACG,MAAL,KAAgB,CAA7B,EAAgC;IAC5B,MAAM;MAAEC,KAAF;MAASC,KAAT;MAAgBC;IAAhB,IAAiCL,QAAQ,IAAI,EAAnD;IACA;AACR;AACA;;IACQ,OAAO;MACH,CAACG,KAAK,IAAI,YAAV,GAAyB;QACrBC,KAAK,EAAEA,KAAK,IAAI,MADK;QAErBE,aAAa,EAAED,YAAY,IAAIE;MAFV;IADtB,CAAP;EAMH;EACD;AACJ;AACA;EACI;;;EACA,OAAQR,IAAD,CAAmBS,MAAnB,CAA0B,CAACC,GAAD,EAAMC,KAAN,KAAgB;IAC7C,IAAI,OAAOA,KAAP,KAAiB,QAArB,EAA+B;MAC3B,MAAM,IAAIC,cAAJ,CAAiB,mCAAjB,CAAN;IACH;;IACD,MAAMC,KAAK,GAAGF,KAAK,CAACE,KAAN,CAAYjB,UAAZ,CAAd;;IAEA,IAAI,CAACiB,KAAL,EAAY;MACR,MAAM,IAAID,cAAJ,CAAiB,mBAAkBD,KAAM,IAAzC,CAAN;IACH;;IAED,MAAM,GAAGP,KAAH,EAAUU,YAAV,IAA0BD,KAAhC;IACA,MAAMR,KAAgB,GAAGS,YAAY,CAACC,WAAb,OAA+B,KAA/B,GAAuC,KAAvC,GAA+C,MAAxE;IAEA,MAAMC,MAAgC,GAAGd,YAAY,CAACE,KAAD,CAAZ,IAAuBF,YAAY,CAAC,GAAD,CAA5E;;IACA,IAAI,CAACc,MAAL,EAAa;MACT,MAAM,IAAIJ,cAAJ,CAAiB,iCAAgCR,KAAM,GAAvD,EAA2D,mBAA3D,EAAgF;QAClFA;MADkF,CAAhF,CAAN;IAGH;IACD;AACR;AACA;AACA;;;IACQ,MAAMa,IAAI,GAAGD,MAAM,CAACE,OAAP,CAAed,KAAf,CAAb;IAEAM,GAAG,CAACO,IAAD,CAAH,GAAYD,MAAM,CAACG,cAAP,CAAsBd,KAAtB,CAAZ;IAEA,OAAOK,GAAP;EACH,CA5BM,EA4BJ,EA5BI,CAAP;AA6BH,CA/CM"}

package/types.d.ts

@@ -1,8 +1,13 @@
 import { Client } from "@elastic/elasticsearch";
+import { ApiResponse } from "@elastic/elasticsearch/lib/Transport";
 import { BoolQueryConfig as esBoolQueryConfig, Query as esQuery } from "elastic-ts";
-import { ContextInterface } from "@webiny/handler/types";
+import { Context } from "@webiny/api/types";
+/**
+ * Re-export some dep lib types.
+ */
 export * from "elastic-ts";
-export interface ElasticsearchContext extends ContextInterface {
+export { ApiResponse };
+export interface ElasticsearchContext extends Context {
     elasticsearch: Client;
 }
 /**
@@ -47,3 +52,149 @@ export interface ElasticsearchQueryBuilderArgsPlugin {
      */
     keyword: boolean;
 }
+/**
+ * Elasticsearch responses.
+ */
+export interface ElasticsearchSearchResponseHit<T> {
+    _source: T;
+    sort: string;
+}
+export interface ElasticsearchSearchResponseAggregationBucket<T> {
+    key: T;
+}
+export interface ElasticsearchSearchResponse<T = any> {
+    body: {
+        hits: {
+            hits: ElasticsearchSearchResponseHit<T>[];
+            total: {
+                value: number;
+            };
+        };
+        aggregations: {
+            [key: string]: {
+                buckets: ElasticsearchSearchResponseAggregationBucket<T>[];
+            };
+        };
+    };
+}
+export interface ElasticsearchIndexRequestBodyMappingsDynamicTemplate {
+    [key: string]: {
+        match_mapping_type?: string;
+        match?: string;
+        unmatch?: string;
+        mapping?: {
+            type?: "text" | "date" | "binary" | "boolean" | "object" | "ip" | "geo" | string;
+            search_analyzer?: string;
+            analyzer?: string;
+            fields?: {
+                [key: string]: {
+                    type: string;
+                    search_analyzer?: string;
+                    analyzer?: string;
+                    ignore_above?: number;
+                    [key: string]: any;
+                } | undefined;
+            };
+            [key: string]: any;
+        };
+        [key: string]: any;
+    };
+}
+interface ElasticsearchIndexRequestBodySettings {
+    analysis?: {
+        [key: string]: any;
+    };
+    number_of_shards?: number;
+    number_of_routing_shards?: number;
+    codec?: string;
+    routing_partition_size?: number;
+    soft_deletes?: {
+        enabled?: boolean;
+        retention_lease?: {
+            period?: string;
+        };
+    };
+    load_fixed_bitset_filters_eagerly?: boolean;
+    shard?: {
+        check_on_startup?: boolean | "checksum";
+    };
+    number_of_replicas?: number;
+    auto_expand_replicas?: string | "all" | false;
+    search?: {
+        idle?: {
+            after?: string;
+        };
+    };
+    refresh_interval?: string;
+    max_result_window?: number;
+    max_inner_result_window?: number;
+    max_rescore_window?: number;
+    max_docvalue_fields_search?: number;
+    max_script_fields?: number;
+    max_ngram_diff?: number;
+    max_shingle_diff?: number;
+    max_refresh_listeners?: number;
+    analyze?: {
+        max_token_count?: number;
+    };
+    highlight?: {
+        max_analyzed_offset?: number;
+    };
+    max_terms_count?: number;
+    max_regex_length?: number;
+    query?: {
+        default_field?: string;
+    };
+    routing?: {
+        allocation?: {
+            enable?: "all" | "primaries" | "new_primaries" | "none";
+        };
+        rebalance?: {
+            enable?: "all" | "primaries" | "new_primaries" | "none";
+        };
+    };
+    gc_deletes?: string;
+    default_pipeline?: string;
+    final_pipeline?: string;
+    hidden?: boolean;
+    [key: string]: any;
+}
+export interface ElasticsearchIndexRequestBody {
+    settings?: {
+        index?: Partial<ElasticsearchIndexRequestBodySettings>;
+    };
+    mappings: {
+        dynamic_templates?: ElasticsearchIndexRequestBodyMappingsDynamicTemplate[];
+        properties?: {
+            [key: string]: {
+                analyzer?: string;
+                type?: string;
+                normalizer?: string;
+                index?: string;
+                fields?: {
+                    [key: string]: {
+                        type: string;
+                        ignore_above?: number;
+                        search_analyzer?: string;
+                        analyzer?: string;
+                        [key: string]: any;
+                    };
+                };
+                [key: string]: any;
+            };
+        };
+        [key: string]: any;
+    };
+    aliases?: {
+        [key: string]: {
+            filter?: {
+                [key: string]: any;
+            };
+            index_routing?: string;
+            is_hidden?: boolean;
+            is_write_index?: boolean;
+            routing?: string;
+            search_routing?: string;
+        };
+    };
+}

package/types.js

@@ -3,11 +3,23 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+var _exportNames = {
+  ApiResponse: true
+};
+Object.defineProperty(exports, "ApiResponse", {
+  enumerable: true,
+  get: function () {
+    return _Transport.ApiResponse;
+  }
+});
+
+var _Transport = require("@elastic/elasticsearch/lib/Transport");
 
 var _elasticTs = require("elastic-ts");
 
 Object.keys(_elasticTs).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
   if (key in exports && exports[key] === _elasticTs[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { Client } from \"@elastic/elasticsearch\";\nimport { ApiResponse } from \"@elastic/elasticsearch/lib/Transport\";\nimport { BoolQueryConfig as esBoolQueryConfig, Query as esQuery } from \"elastic-ts\";\nimport { Context } from \"@webiny/api/types\";\n/**\n * Re-export some dep lib types.\n */\nexport * from \"elastic-ts\";\nexport { ApiResponse };\n\nexport interface ElasticsearchContext extends Context {\n    elasticsearch: Client;\n}\n\n/**\n * To simplify our plugins, we say that query contains arrays of objects, not single objects.\n * And that they all are defined as empty arrays at the start.\n */\nexport interface ElasticsearchBoolQueryConfig extends esBoolQueryConfig {\n    must: esQuery[];\n    filter: esQuery[];\n    should: esQuery[];\n    must_not: esQuery[];\n}\n\n/**\n * Definitions of possible Elasticsearch operators.\n *\n * @category Elasticsearch\n */\nexport type ElasticsearchQueryOperator =\n    | \"eq\"\n    | \"not\"\n    | \"in\"\n    | \"not_in\"\n    | \"contains\"\n    | \"not_contains\"\n    | \"between\"\n    | \"not_between\"\n    | \"gt\"\n    | \"gte\"\n    | \"lt\"\n    | \"lte\";\n\n/**\n * Definition for arguments of the ElasticsearchQueryBuilderOperatorPlugin.apply method.\n *\n * @see ElasticsearchQueryBuilderOperatorPlugin.apply\n *\n * @category Plugin\n * @category Elasticsearch\n */\nexport interface ElasticsearchQueryBuilderArgsPlugin {\n    /**\n     * A full path to the field. Including the \".keyword\" if it is added.\n     */\n    path: string;\n    /**\n     * A path to the field, plain.\n     */\n    basePath: string;\n    /**\n     * Value to apply.\n     */\n    value: any;\n    /**\n     * Is path containing the \".keyword\"\n     */\n    keyword: boolean;\n}\n\n/**\n * Elasticsearch responses.\n */\nexport interface ElasticsearchSearchResponseHit<T> {\n    _source: T;\n    sort: string;\n}\nexport interface ElasticsearchSearchResponseAggregationBucket<T> {\n    key: T;\n}\nexport interface ElasticsearchSearchResponse<T = any> {\n    body: {\n        hits: {\n            hits: ElasticsearchSearchResponseHit<T>[];\n            total: {\n                value: number;\n            };\n        };\n        aggregations: {\n            [key: string]: {\n                buckets: ElasticsearchSearchResponseAggregationBucket<T>[];\n            };\n        };\n    };\n}\n\nexport interface ElasticsearchIndexRequestBodyMappingsDynamicTemplate {\n    [key: string]: {\n        match_mapping_type?: string;\n        match?: string;\n        unmatch?: string;\n        mapping?: {\n            type?: \"text\" | \"date\" | \"binary\" | \"boolean\" | \"object\" | \"ip\" | \"geo\" | string;\n            search_analyzer?: string;\n            analyzer?: string;\n            fields?: {\n                [key: string]:\n                    | {\n                          type: string;\n                          search_analyzer?: string;\n                          analyzer?: string;\n                          ignore_above?: number;\n                          [key: string]: any;\n                      }\n                    | undefined;\n            };\n            [key: string]: any;\n        };\n        [key: string]: any;\n    };\n}\n\ninterface ElasticsearchIndexRequestBodySettings {\n    analysis?: {\n        [key: string]: any;\n    };\n    number_of_shards?: number;\n    number_of_routing_shards?: number;\n    codec?: string;\n    routing_partition_size?: number;\n    soft_deletes?: {\n        enabled?: boolean;\n        retention_lease?: {\n            period?: string;\n        };\n    };\n    load_fixed_bitset_filters_eagerly?: boolean;\n    shard?: {\n        check_on_startup?: boolean | \"checksum\";\n    };\n    number_of_replicas?: number;\n    auto_expand_replicas?: string | \"all\" | false;\n    search?: {\n        idle?: {\n            after?: string;\n        };\n    };\n    refresh_interval?: string;\n    max_result_window?: number;\n    max_inner_result_window?: number;\n    max_rescore_window?: number;\n    max_docvalue_fields_search?: number;\n    max_script_fields?: number;\n    max_ngram_diff?: number;\n    max_shingle_diff?: number;\n    max_refresh_listeners?: number;\n    analyze?: {\n        max_token_count?: number;\n    };\n    highlight?: {\n        max_analyzed_offset?: number;\n    };\n    max_terms_count?: number;\n    max_regex_length?: number;\n    query?: {\n        default_field?: string;\n    };\n    routing?: {\n        allocation?: {\n            enable?: \"all\" | \"primaries\" | \"new_primaries\" | \"none\";\n        };\n        rebalance?: {\n            enable?: \"all\" | \"primaries\" | \"new_primaries\" | \"none\";\n        };\n    };\n    gc_deletes?: string;\n    default_pipeline?: string;\n    final_pipeline?: string;\n    hidden?: boolean;\n    [key: string]: any;\n}\n\nexport interface ElasticsearchIndexRequestBody {\n    settings?: {\n        index?: Partial<ElasticsearchIndexRequestBodySettings>;\n    };\n    mappings: {\n        dynamic_templates?: ElasticsearchIndexRequestBodyMappingsDynamicTemplate[];\n        properties?: {\n            [key: string]: {\n                analyzer?: string;\n                type?: string;\n                normalizer?: string;\n                index?: string;\n                fields?: {\n                    [key: string]: {\n                        type: string;\n                        ignore_above?: number;\n                        search_analyzer?: string;\n                        analyzer?: string;\n                        [key: string]: any;\n                    };\n                };\n                [key: string]: any;\n            };\n        };\n        [key: string]: any;\n    };\n    aliases?: {\n        [key: string]: {\n            filter?: {\n                [key: string]: any;\n            };\n            index_routing?: string;\n            is_hidden?: boolean;\n            is_write_index?: boolean;\n            routing?: string;\n            search_routing?: string;\n        };\n    };\n}\n"],"mappings":";;;;;;;;;;;;;;;AACA;;AAMA;;AAAA;EAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}

package/where.d.ts

@@ -2,7 +2,7 @@ import { ElasticsearchBoolQueryConfig } from "./types";
 import { ElasticsearchFieldPlugin } from "./plugins/definition/ElasticsearchFieldPlugin";
 import { ElasticsearchQueryBuilderOperatorPlugin } from "./plugins/definition/ElasticsearchQueryBuilderOperatorPlugin";
 declare type Records<T> = Record<string, T>;
-export interface Params {
+export interface ApplyWhereParams {
     query: ElasticsearchBoolQueryConfig;
     where: Records<any>;
     fields: Records<ElasticsearchFieldPlugin>;
@@ -13,5 +13,5 @@ export interface ParseWhereKeyResult {
     operator: string;
 }
 export declare const parseWhereKey: (key: string) => ParseWhereKeyResult;
-export declare const applyWhere: (params: Params) => void;
+export declare const applyWhere: (params: ApplyWhereParams) => void;
 export {};

package/where.js

@@ -26,7 +26,7 @@ const parseWhereKey = key => {
     throw new Error(`Cannot filter by "${field}".`);
   }
 
-  const operator = operation.match(/^_/) ? operation.substr(1) : operation;
+  const operator = operation.match(/^_/) ? operation.slice(1) : operation;
   return {
     field,
     operator

package/where.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["parseWhereKeyRegExp","RegExp","parseWhereKey","key","match","Error","field","operation","operator","slice","ALL","ElasticsearchFieldPlugin","applyWhere","params","query","where","fields","operators","hasOwnProperty","initialValue","undefined","fieldPlugin","WebinyError","operatorPlugin","path","getPath","basePath","getBasePath","value","toSearchValue","apply","keyword"],"sources":["where.ts"],"sourcesContent":["import { ElasticsearchBoolQueryConfig } from \"~/types\";\nimport { ElasticsearchFieldPlugin } from \"~/plugins/definition/ElasticsearchFieldPlugin\";\nimport { ElasticsearchQueryBuilderOperatorPlugin } from \"~/plugins/definition/ElasticsearchQueryBuilderOperatorPlugin\";\nimport WebinyError from \"@webiny/error\";\n\ntype Records<T> = Record<string, T>;\n\nexport interface ApplyWhereParams {\n    query: ElasticsearchBoolQueryConfig;\n    where: Records<any>;\n    fields: Records<ElasticsearchFieldPlugin>;\n    operators: Records<ElasticsearchQueryBuilderOperatorPlugin>;\n}\n\nexport interface ParseWhereKeyResult {\n    field: string;\n    operator: string;\n}\n\nconst parseWhereKeyRegExp = new RegExp(/^([a-zA-Z0-9]+)(_[a-zA-Z0-9_]+)?$/);\n\nexport const parseWhereKey = (key: string): ParseWhereKeyResult => {\n    const match = key.match(parseWhereKeyRegExp);\n\n    if (!match) {\n        throw new Error(`It is not possible to search by key \"${key}\"`);\n    }\n\n    const [, field, operation = \"eq\"] = match;\n\n    if (!field.match(/^([a-zA-Z]+)$/)) {\n        throw new Error(`Cannot filter by \"${field}\".`);\n    }\n\n    const operator = operation.match(/^_/) ? operation.slice(1) : operation;\n\n    return { field, operator };\n};\n\nconst ALL = ElasticsearchFieldPlugin.ALL;\n\nexport const applyWhere = (params: ApplyWhereParams): void => {\n    const { query, where, fields, operators } = params;\n\n    for (const key in where) {\n        if (where.hasOwnProperty(key) === false) {\n            continue;\n        }\n        const initialValue = where[key];\n        /**\n         * There is a possibility that undefined is sent as a value, so just skip it.\n         */\n        if (initialValue === undefined) {\n            continue;\n        }\n        const { field, operator } = parseWhereKey(key);\n        const fieldPlugin: ElasticsearchFieldPlugin = fields[field] || fields[ALL];\n        if (!fieldPlugin) {\n            throw new WebinyError(\n                `Missing plugin for the field \"${field}\".`,\n                \"PLUGIN_WHERE_ERROR\",\n                {\n                    field\n                }\n            );\n        }\n        const operatorPlugin = operators[operator];\n        if (!operatorPlugin) {\n            throw new WebinyError(\n                `Missing plugin for the operator \"${operator}\"`,\n                \"PLUGIN_WHERE_ERROR\",\n                {\n                    operator\n                }\n            );\n        }\n\n        /**\n         * Get the path but in the case of * (all fields, replace * with the field.\n         * Custom path would return its own value anyways.\n         */\n        const path = fieldPlugin.getPath(field);\n        const basePath = fieldPlugin.getBasePath(field);\n        /**\n         * Transform the value for the search.\n         */\n        const value = fieldPlugin.toSearchValue({\n            value: initialValue,\n            path,\n            basePath\n        });\n\n        operatorPlugin.apply(query, {\n            value,\n            path,\n            basePath,\n            keyword: fieldPlugin.keyword\n        });\n    }\n};\n"],"mappings":";;;;;;;;;AACA;;AAEA;;AAgBA,MAAMA,mBAAmB,GAAG,IAAIC,MAAJ,CAAW,mCAAX,CAA5B;;AAEO,MAAMC,aAAa,GAAIC,GAAD,IAAsC;EAC/D,MAAMC,KAAK,GAAGD,GAAG,CAACC,KAAJ,CAAUJ,mBAAV,CAAd;;EAEA,IAAI,CAACI,KAAL,EAAY;IACR,MAAM,IAAIC,KAAJ,CAAW,wCAAuCF,GAAI,GAAtD,CAAN;EACH;;EAED,MAAM,GAAGG,KAAH,EAAUC,SAAS,GAAG,IAAtB,IAA8BH,KAApC;;EAEA,IAAI,CAACE,KAAK,CAACF,KAAN,CAAY,eAAZ,CAAL,EAAmC;IAC/B,MAAM,IAAIC,KAAJ,CAAW,qBAAoBC,KAAM,IAArC,CAAN;EACH;;EAED,MAAME,QAAQ,GAAGD,SAAS,CAACH,KAAV,CAAgB,IAAhB,IAAwBG,SAAS,CAACE,KAAV,CAAgB,CAAhB,CAAxB,GAA6CF,SAA9D;EAEA,OAAO;IAAED,KAAF;IAASE;EAAT,CAAP;AACH,CAhBM;;;AAkBP,MAAME,GAAG,GAAGC,kDAAA,CAAyBD,GAArC;;AAEO,MAAME,UAAU,GAAIC,MAAD,IAAoC;EAC1D,MAAM;IAAEC,KAAF;IAASC,KAAT;IAAgBC,MAAhB;IAAwBC;EAAxB,IAAsCJ,MAA5C;;EAEA,KAAK,MAAMV,GAAX,IAAkBY,KAAlB,EAAyB;IACrB,IAAIA,KAAK,CAACG,cAAN,CAAqBf,GAArB,MAA8B,KAAlC,EAAyC;MACrC;IACH;;IACD,MAAMgB,YAAY,GAAGJ,KAAK,CAACZ,GAAD,CAA1B;IACA;AACR;AACA;;IACQ,IAAIgB,YAAY,KAAKC,SAArB,EAAgC;MAC5B;IACH;;IACD,MAAM;MAAEd,KAAF;MAASE;IAAT,IAAsBN,aAAa,CAACC,GAAD,CAAzC;IACA,MAAMkB,WAAqC,GAAGL,MAAM,CAACV,KAAD,CAAN,IAAiBU,MAAM,CAACN,GAAD,CAArE;;IACA,IAAI,CAACW,WAAL,EAAkB;MACd,MAAM,IAAIC,cAAJ,CACD,iCAAgChB,KAAM,IADrC,EAEF,oBAFE,EAGF;QACIA;MADJ,CAHE,CAAN;IAOH;;IACD,MAAMiB,cAAc,GAAGN,SAAS,CAACT,QAAD,CAAhC;;IACA,IAAI,CAACe,cAAL,EAAqB;MACjB,MAAM,IAAID,cAAJ,CACD,oCAAmCd,QAAS,GAD3C,EAEF,oBAFE,EAGF;QACIA;MADJ,CAHE,CAAN;IAOH;IAED;AACR;AACA;AACA;;;IACQ,MAAMgB,IAAI,GAAGH,WAAW,CAACI,OAAZ,CAAoBnB,KAApB,CAAb;IACA,MAAMoB,QAAQ,GAAGL,WAAW,CAACM,WAAZ,CAAwBrB,KAAxB,CAAjB;IACA;AACR;AACA;;IACQ,MAAMsB,KAAK,GAAGP,WAAW,CAACQ,aAAZ,CAA0B;MACpCD,KAAK,EAAET,YAD6B;MAEpCK,IAFoC;MAGpCE;IAHoC,CAA1B,CAAd;IAMAH,cAAc,CAACO,KAAf,CAAqBhB,KAArB,EAA4B;MACxBc,KADwB;MAExBJ,IAFwB;MAGxBE,QAHwB;MAIxBK,OAAO,EAAEV,WAAW,CAACU;IAJG,CAA5B;EAMH;AACJ,CA1DM"}