@webiny/api-elasticsearch 0.0.0-mt-3 → 0.0.0-unstable.2af142b57e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/client.js +20 -24
  2. package/client.js.map +1 -0
  3. package/compression.js +0 -17
  4. package/compression.js.map +1 -0
  5. package/cursors.d.ts +3 -2
  6. package/cursors.js +5 -11
  7. package/cursors.js.map +1 -0
  8. package/index.d.ts +14 -2
  9. package/index.js +146 -13
  10. package/index.js.map +1 -0
  11. package/indexConfiguration/base.d.ts +6 -0
  12. package/indexConfiguration/base.js +40 -0
  13. package/indexConfiguration/base.js.map +1 -0
  14. package/indexConfiguration/common.d.ts +9 -0
  15. package/indexConfiguration/common.js +41 -0
  16. package/indexConfiguration/common.js.map +1 -0
  17. package/indexConfiguration/index.d.ts +3 -0
  18. package/indexConfiguration/index.js +38 -0
  19. package/indexConfiguration/index.js.map +1 -0
  20. package/indexConfiguration/japanese.d.ts +6 -0
  21. package/indexConfiguration/japanese.js +119 -0
  22. package/indexConfiguration/japanese.js.map +1 -0
  23. package/indices.d.ts +9 -0
  24. package/indices.js +28 -0
  25. package/indices.js.map +1 -0
  26. package/limit.js +0 -8
  27. package/limit.js.map +1 -0
  28. package/normalize.js +11 -12
  29. package/normalize.js.map +1 -0
  30. package/operators.d.ts +5 -14
  31. package/operators.js +35 -32
  32. package/operators.js.map +1 -0
  33. package/package.json +14 -14
  34. package/plugins/GzipCompression.d.ts +5 -0
  35. package/plugins/GzipCompression.js +10 -17
  36. package/plugins/GzipCompression.js.map +1 -0
  37. package/plugins/definition/CompressionPlugin.d.ts +1 -1
  38. package/plugins/definition/CompressionPlugin.js +1 -6
  39. package/plugins/definition/CompressionPlugin.js.map +1 -0
  40. package/plugins/definition/ElasticsearchBodyModifierPlugin.js +1 -10
  41. package/plugins/definition/ElasticsearchBodyModifierPlugin.js.map +1 -0
  42. package/plugins/definition/ElasticsearchFieldPlugin.d.ts +8 -14
  43. package/plugins/definition/ElasticsearchFieldPlugin.js +24 -71
  44. package/plugins/definition/ElasticsearchFieldPlugin.js.map +1 -0
  45. package/plugins/definition/ElasticsearchIndexPlugin.d.ts +18 -0
  46. package/plugins/definition/ElasticsearchIndexPlugin.js +36 -0
  47. package/plugins/definition/ElasticsearchIndexPlugin.js.map +1 -0
  48. package/plugins/definition/ElasticsearchQueryBuilderOperatorPlugin.d.ts +5 -1
  49. package/plugins/definition/ElasticsearchQueryBuilderOperatorPlugin.js +10 -7
  50. package/plugins/definition/ElasticsearchQueryBuilderOperatorPlugin.js.map +1 -0
  51. package/plugins/definition/ElasticsearchQueryModifierPlugin.js +1 -10
  52. package/plugins/definition/ElasticsearchQueryModifierPlugin.js.map +1 -0
  53. package/plugins/definition/ElasticsearchSortModifierPlugin.js +1 -10
  54. package/plugins/definition/ElasticsearchSortModifierPlugin.js.map +1 -0
  55. package/plugins/definition/index.d.ts +7 -0
  56. package/plugins/definition/index.js +82 -0
  57. package/plugins/definition/index.js.map +1 -0
  58. package/plugins/index.d.ts +2 -0
  59. package/plugins/index.js +27 -0
  60. package/plugins/index.js.map +1 -0
  61. package/plugins/operator/andIn.js +4 -15
  62. package/plugins/operator/andIn.js.map +1 -0
  63. package/plugins/operator/between.js +8 -17
  64. package/plugins/operator/between.js.map +1 -0
  65. package/plugins/operator/contains.js +2 -11
  66. package/plugins/operator/contains.js.map +1 -0
  67. package/plugins/operator/equal.js +29 -14
  68. package/plugins/operator/equal.js.map +1 -0
  69. package/plugins/operator/gt.js +2 -10
  70. package/plugins/operator/gt.js.map +1 -0
  71. package/plugins/operator/gte.js +2 -10
  72. package/plugins/operator/gte.js.map +1 -0
  73. package/plugins/operator/in.js +7 -22
  74. package/plugins/operator/in.js.map +1 -0
  75. package/plugins/operator/index.d.ts +3 -0
  76. package/plugins/operator/index.js +33 -26
  77. package/plugins/operator/index.js.map +1 -0
  78. package/plugins/operator/japanese/contains.d.ts +8 -0
  79. package/plugins/operator/japanese/contains.js +47 -0
  80. package/plugins/operator/japanese/contains.js.map +1 -0
  81. package/plugins/operator/lt.js +2 -10
  82. package/plugins/operator/lt.js.map +1 -0
  83. package/plugins/operator/lte.js +2 -10
  84. package/plugins/operator/lte.js.map +1 -0
  85. package/plugins/operator/not.js +21 -11
  86. package/plugins/operator/not.js.map +1 -0
  87. package/plugins/operator/notBetween.js +7 -16
  88. package/plugins/operator/notBetween.js.map +1 -0
  89. package/plugins/operator/notContains.js +2 -11
  90. package/plugins/operator/notContains.js.map +1 -0
  91. package/plugins/operator/notIn.js +4 -13
  92. package/plugins/operator/notIn.js.map +1 -0
  93. package/plugins/operator/notStartsWith.d.ts +7 -0
  94. package/plugins/operator/notStartsWith.js +30 -0
  95. package/plugins/operator/notStartsWith.js.map +1 -0
  96. package/plugins/operator/startsWith.d.ts +7 -0
  97. package/plugins/operator/startsWith.js +30 -0
  98. package/plugins/operator/startsWith.js.map +1 -0
  99. package/sort.d.ts +4 -3
  100. package/sort.js +10 -16
  101. package/sort.js.map +1 -0
  102. package/types.d.ts +163 -4
  103. package/types.js +11 -2
  104. package/types.js.map +1 -0
  105. package/where.d.ts +2 -2
  106. package/where.js +4 -24
  107. package/where.js.map +1 -0
package/types.d.ts CHANGED
@@ -1,8 +1,12 @@
1
- import { Client } from "@elastic/elasticsearch";
1
+ import { Client, ApiResponse } from "@elastic/elasticsearch";
2
2
  import { BoolQueryConfig as esBoolQueryConfig, Query as esQuery } from "elastic-ts";
3
- import { ContextInterface } from "@webiny/handler/types";
3
+ import { Context } from "@webiny/api/types";
4
+ /**
5
+ * Re-export some dep lib types.
6
+ */
4
7
  export * from "elastic-ts";
5
- export interface ElasticsearchContext extends ContextInterface {
8
+ export { ApiResponse };
9
+ export interface ElasticsearchContext extends Context {
6
10
  elasticsearch: Client;
7
11
  }
8
12
  /**
@@ -20,7 +24,7 @@ export interface ElasticsearchBoolQueryConfig extends esBoolQueryConfig {
20
24
  *
21
25
  * @category Elasticsearch
22
26
  */
23
- export declare type ElasticsearchQueryOperator = "eq" | "not" | "in" | "not_in" | "contains" | "not_contains" | "between" | "not_between" | "gt" | "gte" | "lt" | "lte";
27
+ export declare type ElasticsearchQueryOperator = "eq" | "not" | "in" | "not_in" | "contains" | "not_contains" | "between" | "not_between" | "gt" | "gte" | "lt" | "lte" | string;
24
28
  /**
25
29
  * Definition for arguments of the ElasticsearchQueryBuilderOperatorPlugin.apply method.
26
30
  *
@@ -30,6 +34,10 @@ export declare type ElasticsearchQueryOperator = "eq" | "not" | "in" | "not_in"
30
34
  * @category Elasticsearch
31
35
  */
32
36
  export interface ElasticsearchQueryBuilderArgsPlugin {
37
+ /**
38
+ * Name of the field.
39
+ */
40
+ name: string;
33
41
  /**
34
42
  * A full path to the field. Including the ".keyword" if it is added.
35
43
  */
@@ -47,3 +55,154 @@ export interface ElasticsearchQueryBuilderArgsPlugin {
47
55
  */
48
56
  keyword: boolean;
49
57
  }
58
+ /**
59
+ * Elasticsearch responses.
60
+ */
61
+ export interface ElasticsearchSearchResponseHit<T> {
62
+ _source: T;
63
+ sort: string;
64
+ }
65
+ export interface ElasticsearchSearchResponseAggregationBucket<T> {
66
+ key: T;
67
+ }
68
+ export interface ElasticsearchSearchResponse<T = any> {
69
+ body: {
70
+ hits: {
71
+ hits: ElasticsearchSearchResponseHit<T>[];
72
+ total: {
73
+ value: number;
74
+ };
75
+ };
76
+ aggregations: {
77
+ [key: string]: {
78
+ buckets: ElasticsearchSearchResponseAggregationBucket<T>[];
79
+ };
80
+ };
81
+ };
82
+ }
83
+ export interface ElasticsearchIndexRequestBodyMappingsDynamicTemplate {
84
+ [key: string]: {
85
+ path_match?: string;
86
+ path_unmatch?: string;
87
+ match_mapping_type?: string;
88
+ match?: string;
89
+ unmatch?: string;
90
+ mapping?: {
91
+ numeric_detection?: boolean;
92
+ date_detection?: boolean;
93
+ type?: "string" | "date" | "binary" | "boolean" | "object" | "ip" | "geo" | "long" | "integer" | "short" | "byte" | "double" | "float" | "half_float" | "scaled_float" | "unsigned_long" | string;
94
+ search_analyzer?: string;
95
+ analyzer?: string;
96
+ fields?: {
97
+ [key: string]: {
98
+ type: string;
99
+ search_analyzer?: string;
100
+ analyzer?: string;
101
+ ignore_above?: number;
102
+ [key: string]: any;
103
+ } | undefined;
104
+ };
105
+ [key: string]: any;
106
+ };
107
+ [key: string]: any;
108
+ };
109
+ }
110
+ interface ElasticsearchIndexRequestBodySettings {
111
+ analysis?: {
112
+ [key: string]: any;
113
+ };
114
+ number_of_shards?: number;
115
+ number_of_routing_shards?: number;
116
+ codec?: string;
117
+ routing_partition_size?: number;
118
+ soft_deletes?: {
119
+ enabled?: boolean;
120
+ retention_lease?: {
121
+ period?: string;
122
+ };
123
+ };
124
+ load_fixed_bitset_filters_eagerly?: boolean;
125
+ shard?: {
126
+ check_on_startup?: boolean | "checksum";
127
+ };
128
+ number_of_replicas?: number;
129
+ auto_expand_replicas?: string | "all" | false;
130
+ search?: {
131
+ idle?: {
132
+ after?: string;
133
+ };
134
+ };
135
+ refresh_interval?: string;
136
+ max_result_window?: number;
137
+ max_inner_result_window?: number;
138
+ max_rescore_window?: number;
139
+ max_docvalue_fields_search?: number;
140
+ max_script_fields?: number;
141
+ max_ngram_diff?: number;
142
+ max_shingle_diff?: number;
143
+ max_refresh_listeners?: number;
144
+ analyze?: {
145
+ max_token_count?: number;
146
+ };
147
+ highlight?: {
148
+ max_analyzed_offset?: number;
149
+ };
150
+ max_terms_count?: number;
151
+ max_regex_length?: number;
152
+ query?: {
153
+ default_field?: string;
154
+ };
155
+ routing?: {
156
+ allocation?: {
157
+ enable?: "all" | "primaries" | "new_primaries" | "none";
158
+ };
159
+ rebalance?: {
160
+ enable?: "all" | "primaries" | "new_primaries" | "none";
161
+ };
162
+ };
163
+ gc_deletes?: string;
164
+ default_pipeline?: string;
165
+ final_pipeline?: string;
166
+ hidden?: boolean;
167
+ [key: string]: any;
168
+ }
169
+ export interface ElasticsearchIndexRequestBody {
170
+ settings?: {
171
+ index?: Partial<ElasticsearchIndexRequestBodySettings>;
172
+ };
173
+ mappings: {
174
+ numeric_detection?: boolean;
175
+ dynamic_templates?: ElasticsearchIndexRequestBodyMappingsDynamicTemplate[];
176
+ properties?: {
177
+ [key: string]: {
178
+ analyzer?: string;
179
+ type?: string;
180
+ normalizer?: string;
181
+ index?: string;
182
+ fields?: {
183
+ [key: string]: {
184
+ type: string;
185
+ ignore_above?: number;
186
+ search_analyzer?: string;
187
+ analyzer?: string;
188
+ [key: string]: any;
189
+ };
190
+ };
191
+ [key: string]: any;
192
+ };
193
+ };
194
+ [key: string]: any;
195
+ };
196
+ aliases?: {
197
+ [key: string]: {
198
+ filter?: {
199
+ [key: string]: any;
200
+ };
201
+ index_routing?: string;
202
+ is_hidden?: boolean;
203
+ is_write_index?: boolean;
204
+ routing?: string;
205
+ search_routing?: string;
206
+ };
207
+ };
208
+ }
package/types.js CHANGED
@@ -3,11 +3,20 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
-
6
+ var _exportNames = {
7
+ ApiResponse: true
8
+ };
9
+ Object.defineProperty(exports, "ApiResponse", {
10
+ enumerable: true,
11
+ get: function () {
12
+ return _elasticsearch.ApiResponse;
13
+ }
14
+ });
15
+ var _elasticsearch = require("@elastic/elasticsearch");
7
16
  var _elasticTs = require("elastic-ts");
8
-
9
17
  Object.keys(_elasticTs).forEach(function (key) {
10
18
  if (key === "default" || key === "__esModule") return;
19
+ if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
11
20
  if (key in exports && exports[key] === _elasticTs[key]) return;
12
21
  Object.defineProperty(exports, key, {
13
22
  enumerable: true,
package/types.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { Client, ApiResponse } from \"@elastic/elasticsearch\";\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 | string;\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 * Name of the field.\n */\n name: string;\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 path_match?: string;\n path_unmatch?: string;\n match_mapping_type?: string;\n match?: string;\n unmatch?: string;\n mapping?: {\n numeric_detection?: boolean;\n date_detection?: boolean;\n type?:\n | \"string\"\n | \"date\"\n | \"binary\"\n | \"boolean\"\n | \"object\"\n | \"ip\"\n | \"geo\"\n | \"long\"\n | \"integer\"\n | \"short\"\n | \"byte\"\n | \"double\"\n | \"float\"\n | \"half_float\"\n | \"scaled_float\"\n | \"unsigned_long\"\n | 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 numeric_detection?: boolean;\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":";;;;;;;;;;;;;;AAAA;AAMA;AAAA;EAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}
package/where.d.ts CHANGED
@@ -2,7 +2,7 @@ import { ElasticsearchBoolQueryConfig } from "./types";
2
2
  import { ElasticsearchFieldPlugin } from "./plugins/definition/ElasticsearchFieldPlugin";
3
3
  import { ElasticsearchQueryBuilderOperatorPlugin } from "./plugins/definition/ElasticsearchQueryBuilderOperatorPlugin";
4
4
  declare type Records<T> = Record<string, T>;
5
- export interface Params {
5
+ export interface ApplyWhereParams {
6
6
  query: ElasticsearchBoolQueryConfig;
7
7
  where: Records<any>;
8
8
  fields: Records<ElasticsearchFieldPlugin>;
@@ -13,5 +13,5 @@ export interface ParseWhereKeyResult {
13
13
  operator: string;
14
14
  }
15
15
  export declare const parseWhereKey: (key: string) => ParseWhereKeyResult;
16
- export declare const applyWhere: (params: Params) => void;
16
+ export declare const applyWhere: (params: ApplyWhereParams) => void;
17
17
  export {};
package/where.js CHANGED
@@ -1,41 +1,30 @@
1
1
  "use strict";
2
2
 
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
-
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
5
4
  Object.defineProperty(exports, "__esModule", {
6
5
  value: true
7
6
  });
8
7
  exports.parseWhereKey = exports.applyWhere = void 0;
9
-
10
8
  var _ElasticsearchFieldPlugin = require("./plugins/definition/ElasticsearchFieldPlugin");
11
-
12
9
  var _error = _interopRequireDefault(require("@webiny/error"));
13
-
14
10
  const parseWhereKeyRegExp = new RegExp(/^([a-zA-Z0-9]+)(_[a-zA-Z0-9_]+)?$/);
15
-
16
11
  const parseWhereKey = key => {
17
12
  const match = key.match(parseWhereKeyRegExp);
18
-
19
13
  if (!match) {
20
14
  throw new Error(`It is not possible to search by key "${key}"`);
21
15
  }
22
-
23
16
  const [, field, operation = "eq"] = match;
24
-
25
17
  if (!field.match(/^([a-zA-Z]+)$/)) {
26
18
  throw new Error(`Cannot filter by "${field}".`);
27
19
  }
28
-
29
- const operator = operation.match(/^_/) ? operation.substr(1) : operation;
20
+ const operator = operation.match(/^_/) ? operation.slice(1) : operation;
30
21
  return {
31
22
  field,
32
23
  operator
33
24
  };
34
25
  };
35
-
36
26
  exports.parseWhereKey = parseWhereKey;
37
27
  const ALL = _ElasticsearchFieldPlugin.ElasticsearchFieldPlugin.ALL;
38
-
39
28
  const applyWhere = params => {
40
29
  const {
41
30
  query,
@@ -43,58 +32,50 @@ const applyWhere = params => {
43
32
  fields,
44
33
  operators
45
34
  } = params;
46
-
47
35
  for (const key in where) {
48
36
  if (where.hasOwnProperty(key) === false) {
49
37
  continue;
50
38
  }
51
-
52
39
  const initialValue = where[key];
53
40
  /**
54
41
  * There is a possibility that undefined is sent as a value, so just skip it.
55
42
  */
56
-
57
43
  if (initialValue === undefined) {
58
44
  continue;
59
45
  }
60
-
61
46
  const {
62
47
  field,
63
48
  operator
64
49
  } = parseWhereKey(key);
65
50
  const fieldPlugin = fields[field] || fields[ALL];
66
-
67
51
  if (!fieldPlugin) {
68
52
  throw new _error.default(`Missing plugin for the field "${field}".`, "PLUGIN_WHERE_ERROR", {
69
53
  field
70
54
  });
71
55
  }
72
-
73
56
  const operatorPlugin = operators[operator];
74
-
75
57
  if (!operatorPlugin) {
76
58
  throw new _error.default(`Missing plugin for the operator "${operator}"`, "PLUGIN_WHERE_ERROR", {
77
59
  operator
78
60
  });
79
61
  }
62
+
80
63
  /**
81
64
  * Get the path but in the case of * (all fields, replace * with the field.
82
65
  * Custom path would return its own value anyways.
83
66
  */
84
-
85
-
86
67
  const path = fieldPlugin.getPath(field);
87
68
  const basePath = fieldPlugin.getBasePath(field);
88
69
  /**
89
70
  * Transform the value for the search.
90
71
  */
91
-
92
72
  const value = fieldPlugin.toSearchValue({
93
73
  value: initialValue,
94
74
  path,
95
75
  basePath
96
76
  });
97
77
  operatorPlugin.apply(query, {
78
+ name: field,
98
79
  value,
99
80
  path,
100
81
  basePath,
@@ -102,5 +83,4 @@ const applyWhere = params => {
102
83
  });
103
84
  }
104
85
  };
105
-
106
86
  exports.applyWhere = applyWhere;
package/where.js.map ADDED
@@ -0,0 +1 @@
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","name","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 name: field,\n value,\n path,\n basePath,\n keyword: fieldPlugin.keyword\n });\n }\n};\n"],"mappings":";;;;;;;AACA;AAEA;AAgBA,MAAMA,mBAAmB,GAAG,IAAIC,MAAM,CAAC,mCAAmC,CAAC;AAEpE,MAAMC,aAAa,GAAIC,GAAW,IAA0B;EAC/D,MAAMC,KAAK,GAAGD,GAAG,CAACC,KAAK,CAACJ,mBAAmB,CAAC;EAE5C,IAAI,CAACI,KAAK,EAAE;IACR,MAAM,IAAIC,KAAK,CAAE,wCAAuCF,GAAI,GAAE,CAAC;EACnE;EAEA,MAAM,GAAGG,KAAK,EAAEC,SAAS,GAAG,IAAI,CAAC,GAAGH,KAAK;EAEzC,IAAI,CAACE,KAAK,CAACF,KAAK,CAAC,eAAe,CAAC,EAAE;IAC/B,MAAM,IAAIC,KAAK,CAAE,qBAAoBC,KAAM,IAAG,CAAC;EACnD;EAEA,MAAME,QAAQ,GAAGD,SAAS,CAACH,KAAK,CAAC,IAAI,CAAC,GAAGG,SAAS,CAACE,KAAK,CAAC,CAAC,CAAC,GAAGF,SAAS;EAEvE,OAAO;IAAED,KAAK;IAAEE;EAAS,CAAC;AAC9B,CAAC;AAAC;AAEF,MAAME,GAAG,GAAGC,kDAAwB,CAACD,GAAG;AAEjC,MAAME,UAAU,GAAIC,MAAwB,IAAW;EAC1D,MAAM;IAAEC,KAAK;IAAEC,KAAK;IAAEC,MAAM;IAAEC;EAAU,CAAC,GAAGJ,MAAM;EAElD,KAAK,MAAMV,GAAG,IAAIY,KAAK,EAAE;IACrB,IAAIA,KAAK,CAACG,cAAc,CAACf,GAAG,CAAC,KAAK,KAAK,EAAE;MACrC;IACJ;IACA,MAAMgB,YAAY,GAAGJ,KAAK,CAACZ,GAAG,CAAC;IAC/B;AACR;AACA;IACQ,IAAIgB,YAAY,KAAKC,SAAS,EAAE;MAC5B;IACJ;IACA,MAAM;MAAEd,KAAK;MAAEE;IAAS,CAAC,GAAGN,aAAa,CAACC,GAAG,CAAC;IAC9C,MAAMkB,WAAqC,GAAGL,MAAM,CAACV,KAAK,CAAC,IAAIU,MAAM,CAACN,GAAG,CAAC;IAC1E,IAAI,CAACW,WAAW,EAAE;MACd,MAAM,IAAIC,cAAW,CAChB,iCAAgChB,KAAM,IAAG,EAC1C,oBAAoB,EACpB;QACIA;MACJ,CAAC,CACJ;IACL;IACA,MAAMiB,cAAc,GAAGN,SAAS,CAACT,QAAQ,CAAC;IAC1C,IAAI,CAACe,cAAc,EAAE;MACjB,MAAM,IAAID,cAAW,CAChB,oCAAmCd,QAAS,GAAE,EAC/C,oBAAoB,EACpB;QACIA;MACJ,CAAC,CACJ;IACL;;IAEA;AACR;AACA;AACA;IACQ,MAAMgB,IAAI,GAAGH,WAAW,CAACI,OAAO,CAACnB,KAAK,CAAC;IACvC,MAAMoB,QAAQ,GAAGL,WAAW,CAACM,WAAW,CAACrB,KAAK,CAAC;IAC/C;AACR;AACA;IACQ,MAAMsB,KAAK,GAAGP,WAAW,CAACQ,aAAa,CAAC;MACpCD,KAAK,EAAET,YAAY;MACnBK,IAAI;MACJE;IACJ,CAAC,CAAC;IAEFH,cAAc,CAACO,KAAK,CAAChB,KAAK,EAAE;MACxBiB,IAAI,EAAEzB,KAAK;MACXsB,KAAK;MACLJ,IAAI;MACJE,QAAQ;MACRM,OAAO,EAAEX,WAAW,CAACW;IACzB,CAAC,CAAC;EACN;AACJ,CAAC;AAAC"}