@webiny/api-elasticsearch 0.0.0-ee-vpcs.549378cf03

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 (129) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +1 -0
  3. package/client.d.ts +5 -0
  4. package/client.js +55 -0
  5. package/client.js.map +1 -0
  6. package/compression.d.ts +6 -0
  7. package/compression.js +68 -0
  8. package/compression.js.map +1 -0
  9. package/cursors.d.ts +10 -0
  10. package/cursors.js +55 -0
  11. package/cursors.js.map +1 -0
  12. package/index.d.ts +21 -0
  13. package/index.js +203 -0
  14. package/index.js.map +1 -0
  15. package/indexConfiguration/base.d.ts +6 -0
  16. package/indexConfiguration/base.js +45 -0
  17. package/indexConfiguration/base.js.map +1 -0
  18. package/indexConfiguration/common.d.ts +9 -0
  19. package/indexConfiguration/common.js +45 -0
  20. package/indexConfiguration/common.js.map +1 -0
  21. package/indexConfiguration/index.d.ts +3 -0
  22. package/indexConfiguration/index.js +44 -0
  23. package/indexConfiguration/index.js.map +1 -0
  24. package/indexConfiguration/japanese.d.ts +6 -0
  25. package/indexConfiguration/japanese.js +124 -0
  26. package/indexConfiguration/japanese.js.map +1 -0
  27. package/indices.d.ts +9 -0
  28. package/indices.js +35 -0
  29. package/indices.js.map +1 -0
  30. package/limit.d.ts +1 -0
  31. package/limit.js +45 -0
  32. package/limit.js.map +1 -0
  33. package/normalize.d.ts +5 -0
  34. package/normalize.js +24 -0
  35. package/normalize.js.map +1 -0
  36. package/operators.d.ts +9 -0
  37. package/operators.js +56 -0
  38. package/operators.js.map +1 -0
  39. package/package.json +49 -0
  40. package/plugins/GzipCompression.d.ts +24 -0
  41. package/plugins/GzipCompression.js +86 -0
  42. package/plugins/GzipCompression.js.map +1 -0
  43. package/plugins/definition/CompressionPlugin.d.ts +20 -0
  44. package/plugins/definition/CompressionPlugin.js +17 -0
  45. package/plugins/definition/CompressionPlugin.js.map +1 -0
  46. package/plugins/definition/ElasticsearchBodyModifierPlugin.d.ts +13 -0
  47. package/plugins/definition/ElasticsearchBodyModifierPlugin.js +35 -0
  48. package/plugins/definition/ElasticsearchBodyModifierPlugin.js.map +1 -0
  49. package/plugins/definition/ElasticsearchFieldPlugin.d.ts +81 -0
  50. package/plugins/definition/ElasticsearchFieldPlugin.js +104 -0
  51. package/plugins/definition/ElasticsearchFieldPlugin.js.map +1 -0
  52. package/plugins/definition/ElasticsearchIndexPlugin.d.ts +18 -0
  53. package/plugins/definition/ElasticsearchIndexPlugin.js +46 -0
  54. package/plugins/definition/ElasticsearchIndexPlugin.js.map +1 -0
  55. package/plugins/definition/ElasticsearchQueryBuilderOperatorPlugin.d.ts +14 -0
  56. package/plugins/definition/ElasticsearchQueryBuilderOperatorPlugin.js +29 -0
  57. package/plugins/definition/ElasticsearchQueryBuilderOperatorPlugin.js.map +1 -0
  58. package/plugins/definition/ElasticsearchQueryModifierPlugin.d.ts +14 -0
  59. package/plugins/definition/ElasticsearchQueryModifierPlugin.js +35 -0
  60. package/plugins/definition/ElasticsearchQueryModifierPlugin.js.map +1 -0
  61. package/plugins/definition/ElasticsearchSortModifierPlugin.d.ts +13 -0
  62. package/plugins/definition/ElasticsearchSortModifierPlugin.js +35 -0
  63. package/plugins/definition/ElasticsearchSortModifierPlugin.js.map +1 -0
  64. package/plugins/definition/index.d.ts +7 -0
  65. package/plugins/definition/index.js +96 -0
  66. package/plugins/definition/index.js.map +1 -0
  67. package/plugins/index.d.ts +2 -0
  68. package/plugins/index.js +31 -0
  69. package/plugins/index.js.map +1 -0
  70. package/plugins/operator/andIn.d.ts +7 -0
  71. package/plugins/operator/andIn.js +56 -0
  72. package/plugins/operator/andIn.js.map +1 -0
  73. package/plugins/operator/between.d.ts +7 -0
  74. package/plugins/operator/between.js +52 -0
  75. package/plugins/operator/between.js.map +1 -0
  76. package/plugins/operator/contains.d.ts +7 -0
  77. package/plugins/operator/contains.js +43 -0
  78. package/plugins/operator/contains.js.map +1 -0
  79. package/plugins/operator/equal.d.ts +7 -0
  80. package/plugins/operator/equal.js +74 -0
  81. package/plugins/operator/equal.js.map +1 -0
  82. package/plugins/operator/gt.d.ts +7 -0
  83. package/plugins/operator/gt.js +40 -0
  84. package/plugins/operator/gt.js.map +1 -0
  85. package/plugins/operator/gte.d.ts +7 -0
  86. package/plugins/operator/gte.js +40 -0
  87. package/plugins/operator/gte.js.map +1 -0
  88. package/plugins/operator/in.d.ts +7 -0
  89. package/plugins/operator/in.js +48 -0
  90. package/plugins/operator/in.js.map +1 -0
  91. package/plugins/operator/index.d.ts +16 -0
  92. package/plugins/operator/index.js +213 -0
  93. package/plugins/operator/index.js.map +1 -0
  94. package/plugins/operator/japanese/contains.d.ts +8 -0
  95. package/plugins/operator/japanese/contains.js +58 -0
  96. package/plugins/operator/japanese/contains.js.map +1 -0
  97. package/plugins/operator/lt.d.ts +7 -0
  98. package/plugins/operator/lt.js +40 -0
  99. package/plugins/operator/lt.js.map +1 -0
  100. package/plugins/operator/lte.d.ts +7 -0
  101. package/plugins/operator/lte.js +40 -0
  102. package/plugins/operator/lte.js.map +1 -0
  103. package/plugins/operator/not.d.ts +7 -0
  104. package/plugins/operator/not.js +62 -0
  105. package/plugins/operator/not.js.map +1 -0
  106. package/plugins/operator/notBetween.d.ts +7 -0
  107. package/plugins/operator/notBetween.js +52 -0
  108. package/plugins/operator/notBetween.js.map +1 -0
  109. package/plugins/operator/notContains.d.ts +7 -0
  110. package/plugins/operator/notContains.js +43 -0
  111. package/plugins/operator/notContains.js.map +1 -0
  112. package/plugins/operator/notIn.d.ts +7 -0
  113. package/plugins/operator/notIn.js +47 -0
  114. package/plugins/operator/notIn.js.map +1 -0
  115. package/plugins/operator/notStartsWith.d.ts +7 -0
  116. package/plugins/operator/notStartsWith.js +38 -0
  117. package/plugins/operator/notStartsWith.js.map +1 -0
  118. package/plugins/operator/startsWith.d.ts +7 -0
  119. package/plugins/operator/startsWith.js +38 -0
  120. package/plugins/operator/startsWith.js.map +1 -0
  121. package/sort.d.ts +13 -0
  122. package/sort.js +75 -0
  123. package/sort.js.map +1 -0
  124. package/types.d.ts +208 -0
  125. package/types.js +30 -0
  126. package/types.js.map +1 -0
  127. package/where.d.ts +17 -0
  128. package/where.js +107 -0
  129. package/where.js.map +1 -0
package/sort.js.map ADDED
@@ -0,0 +1 @@
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\";\n\nconst sortRegExp = new RegExp(/^([a-zA-Z-0-9_@]+)_(ASC|DESC)$/);\n\ninterface CreateSortParams {\n sort: string[];\n defaults?: {\n field?: string;\n order?: SortOrder;\n unmappedType?: string;\n };\n fieldPlugins: Record<string, ElasticsearchFieldPlugin>;\n}\n\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 return sort.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;;AAYO,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,OAAOR,IAAI,CAACS,MAAL,CAAY,CAACC,GAAD,EAAMC,KAAN,KAAgB;IAC/B,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,CA9CM"}
package/types.d.ts ADDED
@@ -0,0 +1,208 @@
1
+ import { Client, ApiResponse } from "@elastic/elasticsearch";
2
+ import { BoolQueryConfig as esBoolQueryConfig, Query as esQuery } from "elastic-ts";
3
+ import { Context } from "@webiny/api/types";
4
+ /**
5
+ * Re-export some dep lib types.
6
+ */
7
+ export * from "elastic-ts";
8
+ export { ApiResponse };
9
+ export interface ElasticsearchContext extends Context {
10
+ elasticsearch: Client;
11
+ }
12
+ /**
13
+ * To simplify our plugins, we say that query contains arrays of objects, not single objects.
14
+ * And that they all are defined as empty arrays at the start.
15
+ */
16
+ export interface ElasticsearchBoolQueryConfig extends esBoolQueryConfig {
17
+ must: esQuery[];
18
+ filter: esQuery[];
19
+ should: esQuery[];
20
+ must_not: esQuery[];
21
+ }
22
+ /**
23
+ * Definitions of possible Elasticsearch operators.
24
+ *
25
+ * @category Elasticsearch
26
+ */
27
+ export declare type ElasticsearchQueryOperator = "eq" | "not" | "in" | "not_in" | "contains" | "not_contains" | "between" | "not_between" | "gt" | "gte" | "lt" | "lte" | string;
28
+ /**
29
+ * Definition for arguments of the ElasticsearchQueryBuilderOperatorPlugin.apply method.
30
+ *
31
+ * @see ElasticsearchQueryBuilderOperatorPlugin.apply
32
+ *
33
+ * @category Plugin
34
+ * @category Elasticsearch
35
+ */
36
+ export interface ElasticsearchQueryBuilderArgsPlugin {
37
+ /**
38
+ * Name of the field.
39
+ */
40
+ name: string;
41
+ /**
42
+ * A full path to the field. Including the ".keyword" if it is added.
43
+ */
44
+ path: string;
45
+ /**
46
+ * A path to the field, plain.
47
+ */
48
+ basePath: string;
49
+ /**
50
+ * Value to apply.
51
+ */
52
+ value: any;
53
+ /**
54
+ * Is path containing the ".keyword"
55
+ */
56
+ keyword: boolean;
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 ADDED
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
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
+
16
+ var _elasticsearch = require("@elastic/elasticsearch");
17
+
18
+ var _elasticTs = require("elastic-ts");
19
+
20
+ Object.keys(_elasticTs).forEach(function (key) {
21
+ if (key === "default" || key === "__esModule") return;
22
+ if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
23
+ if (key in exports && exports[key] === _elasticTs[key]) return;
24
+ Object.defineProperty(exports, key, {
25
+ enumerable: true,
26
+ get: function () {
27
+ return _elasticTs[key];
28
+ }
29
+ });
30
+ });
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 ADDED
@@ -0,0 +1,17 @@
1
+ import { ElasticsearchBoolQueryConfig } from "./types";
2
+ import { ElasticsearchFieldPlugin } from "./plugins/definition/ElasticsearchFieldPlugin";
3
+ import { ElasticsearchQueryBuilderOperatorPlugin } from "./plugins/definition/ElasticsearchQueryBuilderOperatorPlugin";
4
+ declare type Records<T> = Record<string, T>;
5
+ export interface ApplyWhereParams {
6
+ query: ElasticsearchBoolQueryConfig;
7
+ where: Records<any>;
8
+ fields: Records<ElasticsearchFieldPlugin>;
9
+ operators: Records<ElasticsearchQueryBuilderOperatorPlugin>;
10
+ }
11
+ export interface ParseWhereKeyResult {
12
+ field: string;
13
+ operator: string;
14
+ }
15
+ export declare const parseWhereKey: (key: string) => ParseWhereKeyResult;
16
+ export declare const applyWhere: (params: ApplyWhereParams) => void;
17
+ export {};
package/where.js ADDED
@@ -0,0 +1,107 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
4
+
5
+ Object.defineProperty(exports, "__esModule", {
6
+ value: true
7
+ });
8
+ exports.parseWhereKey = exports.applyWhere = void 0;
9
+
10
+ var _ElasticsearchFieldPlugin = require("./plugins/definition/ElasticsearchFieldPlugin");
11
+
12
+ var _error = _interopRequireDefault(require("@webiny/error"));
13
+
14
+ const parseWhereKeyRegExp = new RegExp(/^([a-zA-Z0-9]+)(_[a-zA-Z0-9_]+)?$/);
15
+
16
+ const parseWhereKey = key => {
17
+ const match = key.match(parseWhereKeyRegExp);
18
+
19
+ if (!match) {
20
+ throw new Error(`It is not possible to search by key "${key}"`);
21
+ }
22
+
23
+ const [, field, operation = "eq"] = match;
24
+
25
+ if (!field.match(/^([a-zA-Z]+)$/)) {
26
+ throw new Error(`Cannot filter by "${field}".`);
27
+ }
28
+
29
+ const operator = operation.match(/^_/) ? operation.slice(1) : operation;
30
+ return {
31
+ field,
32
+ operator
33
+ };
34
+ };
35
+
36
+ exports.parseWhereKey = parseWhereKey;
37
+ const ALL = _ElasticsearchFieldPlugin.ElasticsearchFieldPlugin.ALL;
38
+
39
+ const applyWhere = params => {
40
+ const {
41
+ query,
42
+ where,
43
+ fields,
44
+ operators
45
+ } = params;
46
+
47
+ for (const key in where) {
48
+ if (where.hasOwnProperty(key) === false) {
49
+ continue;
50
+ }
51
+
52
+ const initialValue = where[key];
53
+ /**
54
+ * There is a possibility that undefined is sent as a value, so just skip it.
55
+ */
56
+
57
+ if (initialValue === undefined) {
58
+ continue;
59
+ }
60
+
61
+ const {
62
+ field,
63
+ operator
64
+ } = parseWhereKey(key);
65
+ const fieldPlugin = fields[field] || fields[ALL];
66
+
67
+ if (!fieldPlugin) {
68
+ throw new _error.default(`Missing plugin for the field "${field}".`, "PLUGIN_WHERE_ERROR", {
69
+ field
70
+ });
71
+ }
72
+
73
+ const operatorPlugin = operators[operator];
74
+
75
+ if (!operatorPlugin) {
76
+ throw new _error.default(`Missing plugin for the operator "${operator}"`, "PLUGIN_WHERE_ERROR", {
77
+ operator
78
+ });
79
+ }
80
+ /**
81
+ * Get the path but in the case of * (all fields, replace * with the field.
82
+ * Custom path would return its own value anyways.
83
+ */
84
+
85
+
86
+ const path = fieldPlugin.getPath(field);
87
+ const basePath = fieldPlugin.getBasePath(field);
88
+ /**
89
+ * Transform the value for the search.
90
+ */
91
+
92
+ const value = fieldPlugin.toSearchValue({
93
+ value: initialValue,
94
+ path,
95
+ basePath
96
+ });
97
+ operatorPlugin.apply(query, {
98
+ name: field,
99
+ value,
100
+ path,
101
+ basePath,
102
+ keyword: fieldPlugin.keyword
103
+ });
104
+ }
105
+ };
106
+
107
+ 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,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;MACxBiB,IAAI,EAAEzB,KADkB;MAExBsB,KAFwB;MAGxBJ,IAHwB;MAIxBE,QAJwB;MAKxBM,OAAO,EAAEX,WAAW,CAACW;IALG,CAA5B;EAOH;AACJ,CA3DM"}