1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
odoo.define("web/static/src/js/views/action_model.js", function (require) {
"use strict";
const Domain = require("web.Domain");
const { FACET_ICONS } = require("web.searchUtils");
const { Model } = require("web/static/src/js/model.js");
const { parseArch } = require("web.viewUtils");
const pyUtils = require("web.py_utils");
const Registry = require("web.Registry");
const isNotNull = (value) => value !== null && value !== undefined;
const isObject = (obj) => typeof obj === "object" && obj !== null;
/**
* @extends Model.Extension
*/
class ActionModelExtension extends Model.Extension {
//---------------------------------------------------------------------
// Public
//---------------------------------------------------------------------
/**
* Initiates the asynchronous tasks of the extension and returns a
* promise resolved as soon as all the informations necessary to build
* the search query are ready.
* @returns {Promise}
*/
async callLoad() {
this.loadPromise = super.callLoad(...arguments);
await this.loadPromise;
}
/**
* Returns a promise resolved when the extension is completely ready.
* @returns {Promise}
*/
async isReady() {
await this.loadPromise;
}
//---------------------------------------------------------------------
// Static
//---------------------------------------------------------------------
/**
* @abstract
* @param {Object} archs
* @param {string | null} [viewType=null]
* @returns {null}
*/
static extractArchInfo() {
return null;
}
}
/**
* @extends Model
*/
class ActionModel extends Model {
//---------------------------------------------------------------------
// Public
//---------------------------------------------------------------------
/**
* @override
*/
get(property) {
switch (property) {
case "query": return this.config.searchQuery || this._getQuery();
case "facets": return this._getFacets();
}
return super.get(...arguments);
}
/**
* Returns a promise resolved when all extensions are completely ready.
* @returns {Promise}
*/
async isReady() {
await this._awaitExtensions();
}
//---------------------------------------------------------------------
// Private
//---------------------------------------------------------------------
/**
* @private
* @returns {Promise}
*/
async _awaitExtensions() {
await Promise.all(this.extensions.flat().map(
(extension) => extension.isReady()
));
}
/**
* @override
*/
__get(excluded, property) {
const results = super.__get(...arguments);
switch (property) {
case "domain": return [this.config.domain, ...results];
case "context": return [this.config.context, ...results];
}
return results;
}
/**
* Validates and formats all facets given by the extensions. This is
* done here rather than in the search bar because the searchMenuTypes
* are available only to the model.
* @private
* @returns {Object[]}
*/
_getFacets() {
const types = this.config.searchMenuTypes || [];
const isValidType = (type) => (
!['groupBy', 'comparison'].includes(type) || types.includes(type)
);
const facets = [];
for (const extension of this.extensions.flat()) {
for (const facet of extension.get("facets") || []) {
if (!isValidType(facet.type)) {
continue;
}
facet.separator = facet.type === 'groupBy' ? ">" : this.env._t("or");
if (facet.type in FACET_ICONS) {
facet.icon = FACET_ICONS[facet.type];
}
facets.push(facet);
}
}
return facets;
}
/**
* @typedef TimeRanges
* @property {string} fieldName
* @property {string} comparisonRangeId
* @property {Array[]} range
* @property {string} rangeDescription
* @property {Array[]} comparisonRange
* @property {string} comparisonRangeDescription
*/
/**
* @typedef Query
* @property {Object} context
* @property {Array[]} domain
* @property {string[]} groupBy
* @property {string[]} orderedBy
* @property {TimeRanges?} timeRanges
*/
/**
* @private
* @returns {Query}
*/
_getQuery() {
const evalContext = this.env.session.user_context;
const contexts = this.__get(null, "context");
const domains = this.__get(null, "domain");
const query = {
context: pyUtils.eval("contexts", contexts, evalContext),
domain: Domain.prototype.normalizeArray(
pyUtils.eval("domains", domains, evalContext)
),
orderedBy: this.get("orderedBy") || [],
};
const searchMenuTypes = this.config.searchMenuTypes || [];
if (searchMenuTypes.includes("groupBy")) {
query.groupBy = this.get("groupBy") || [];
} else {
query.groupBy = [];
}
if (searchMenuTypes.includes("comparison")) {
query.timeRanges = this.get("timeRanges") || {};
}
return query;
}
/**
* Overridden to trigger a "search" event as soon as the query data
* are ready.
* @override
*/
async _loadExtensions({ isInitialLoad }) {
await super._loadExtensions(...arguments);
if (!isInitialLoad) {
this.trigger("search", this.get("query"));
await this._awaitExtensions();
}
}
//---------------------------------------------------------------------
// Static
//---------------------------------------------------------------------
/**
* @param {Object} archs
* @param {string | null} [viewType=null]
* @returns {Object}
*/
static extractArchInfo(archs, viewType = null) {
const parsedArchs = {};
if (!archs.search) {
archs.search = "<search/>";
}
for (const key in archs) {
const { attrs, children } = parseArch(archs[key]);
const objectChildren = children.filter(isObject);
parsedArchs[key] = {
attrs,
children: objectChildren,
};
}
const archInfo = {};
for (const key of this.registry.keys()) {
const extension = this.registry.get(key);
const result = extension.extractArchInfo(parsedArchs, viewType);
if (isNotNull(result)) {
archInfo[key] = result;
}
}
return archInfo;
}
}
ActionModel.Extension = ActionModelExtension;
ActionModel.registry = new Registry(null,
(value) => value.prototype instanceof ActionModel.Extension
);
return ActionModel;
});
|
