arocapi 5.0.0-beta.4 → 5.0.0-beta.6
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.
- package/LICENSE.md +1 -1
- package/README.md +3 -3
- package/dist/app.d.ts +19 -13
- package/dist/app.js +13 -10
- package/dist/app.js.map +1 -1
- package/dist/routes/capabilities.d.ts +2 -2
- package/dist/routes/capabilities.js +2 -2
- package/dist/routes/capabilities.js.map +1 -1
- package/dist/routes/entities.js +8 -9
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/file.js +5 -1
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/search.d.ts +2 -4
- package/dist/routes/search.js +75 -97
- package/dist/routes/search.js.map +1 -1
- package/dist/search/advanced.d.ts +8 -0
- package/dist/search/advanced.js +198 -0
- package/dist/search/advanced.js.map +1 -0
- package/dist/search/backend.d.ts +95 -0
- package/dist/search/backend.js +5 -0
- package/dist/search/backend.js.map +1 -0
- package/dist/search/fields.d.ts +63 -0
- package/dist/search/fields.js +203 -0
- package/dist/search/fields.js.map +1 -0
- package/dist/search/opensearch/advanced.d.ts +4 -0
- package/dist/search/opensearch/advanced.js +28 -0
- package/dist/search/opensearch/advanced.js.map +1 -0
- package/dist/search/opensearch/opensearch.d.ts +16 -0
- package/dist/search/opensearch/opensearch.js +187 -0
- package/dist/search/opensearch/opensearch.js.map +1 -0
- package/dist/search/opensearch/visibility.d.ts +3 -0
- package/dist/search/opensearch/visibility.js +27 -0
- package/dist/search/opensearch/visibility.js.map +1 -0
- package/dist/search/postgres/advanced.d.ts +7 -0
- package/dist/search/postgres/advanced.js +54 -0
- package/dist/search/postgres/advanced.js.map +1 -0
- package/dist/search/postgres/facets.d.ts +2 -0
- package/dist/search/postgres/facets.js +27 -0
- package/dist/search/postgres/facets.js.map +1 -0
- package/dist/search/postgres/geo.d.ts +6 -0
- package/dist/search/postgres/geo.js +42 -0
- package/dist/search/postgres/geo.js.map +1 -0
- package/dist/search/postgres/postgres.d.ts +19 -0
- package/dist/search/postgres/postgres.js +157 -0
- package/dist/search/postgres/postgres.js.map +1 -0
- package/dist/search/postgres/values.d.ts +8 -0
- package/dist/search/postgres/values.js +20 -0
- package/dist/search/postgres/values.js.map +1 -0
- package/dist/search/postgres/visibility.d.ts +4 -0
- package/dist/search/postgres/visibility.js +38 -0
- package/dist/search/postgres/visibility.js.map +1 -0
- package/dist/search/requestFilters.d.ts +39 -0
- package/dist/search/requestFilters.js +125 -0
- package/dist/search/requestFilters.js.map +1 -0
- package/dist/search/visibility.d.ts +51 -0
- package/dist/search/visibility.js +100 -0
- package/dist/search/visibility.js.map +1 -0
- package/dist/types/visibility.d.ts +3 -2
- package/dist/utils/visibility.js +1 -1
- package/dist/utils/visibility.js.map +1 -1
- package/package.json +46 -26
- package/prisma/models/entity.prisma +9 -8
- package/prisma/models/entitySearch.prisma +21 -0
- package/prisma/models/file.prisma +3 -3
- package/src/app.ts +53 -24
- package/src/routes/capabilities.ts +4 -4
- package/src/routes/entities.ts +10 -9
- package/src/routes/file.ts +5 -1
- package/src/routes/search.ts +104 -118
- package/src/search/advanced.ts +258 -0
- package/src/search/backend.ts +91 -0
- package/src/search/fields.ts +320 -0
- package/src/search/opensearch/advanced.ts +36 -0
- package/src/search/opensearch/opensearch.ts +290 -0
- package/src/search/opensearch/visibility.ts +38 -0
- package/src/search/postgres/advanced.ts +76 -0
- package/src/search/postgres/facets.ts +34 -0
- package/src/search/postgres/geo.ts +58 -0
- package/src/search/postgres/postgres.ts +232 -0
- package/src/search/postgres/values.ts +33 -0
- package/src/search/postgres/visibility.ts +54 -0
- package/src/search/requestFilters.ts +178 -0
- package/src/search/visibility.ts +193 -0
- package/src/types/visibility.ts +6 -3
- package/src/utils/visibility.ts +1 -1
- package/dist/app.test.d.ts +0 -1
- package/dist/app.test.js +0 -67
- package/dist/app.test.js.map +0 -1
- package/dist/errorHandling.test.d.ts +0 -1
- package/dist/errorHandling.test.js +0 -222
- package/dist/errorHandling.test.js.map +0 -1
- package/dist/index.dev.d.ts +0 -1
- package/dist/index.dev.js +0 -157
- package/dist/index.dev.js.map +0 -1
- package/dist/routes/capabilities.test.d.ts +0 -1
- package/dist/routes/capabilities.test.js +0 -81
- package/dist/routes/capabilities.test.js.map +0 -1
- package/dist/routes/crate.test.d.ts +0 -1
- package/dist/routes/crate.test.js +0 -390
- package/dist/routes/crate.test.js.map +0 -1
- package/dist/routes/entities.test.d.ts +0 -1
- package/dist/routes/entities.test.js +0 -277
- package/dist/routes/entities.test.js.map +0 -1
- package/dist/routes/entity.test.d.ts +0 -1
- package/dist/routes/entity.test.js +0 -136
- package/dist/routes/entity.test.js.map +0 -1
- package/dist/routes/file.test.d.ts +0 -1
- package/dist/routes/file.test.js +0 -425
- package/dist/routes/file.test.js.map +0 -1
- package/dist/routes/files.test.d.ts +0 -1
- package/dist/routes/files.test.js +0 -245
- package/dist/routes/files.test.js.map +0 -1
- package/dist/routes/search.test.d.ts +0 -1
- package/dist/routes/search.test.js +0 -833
- package/dist/routes/search.test.js.map +0 -1
- package/dist/test/helpers/fastify.d.ts +0 -9
- package/dist/test/helpers/fastify.js +0 -17
- package/dist/test/helpers/fastify.js.map +0 -1
- package/dist/test/integration.setup.d.ts +0 -47
- package/dist/test/integration.setup.js +0 -195
- package/dist/test/integration.setup.js.map +0 -1
- package/dist/test/integration.test.d.ts +0 -1
- package/dist/test/integration.test.js +0 -762
- package/dist/test/integration.test.js.map +0 -1
- package/dist/transformers/default.test.d.ts +0 -1
- package/dist/transformers/default.test.js +0 -225
- package/dist/transformers/default.test.js.map +0 -1
- package/dist/transformers/transformer.test.d.ts +0 -1
- package/dist/transformers/transformer.test.js +0 -165
- package/dist/transformers/transformer.test.js.map +0 -1
- package/dist/utils/errors.test.d.ts +0 -1
- package/dist/utils/errors.test.js +0 -79
- package/dist/utils/errors.test.js.map +0 -1
- package/dist/utils/queryBuilder.d.ts +0 -47
- package/dist/utils/queryBuilder.js +0 -107
- package/dist/utils/queryBuilder.js.map +0 -1
- package/prisma.config.ts +0 -9
- package/src/app.test.ts +0 -91
- package/src/errorHandling.test.ts +0 -288
- package/src/index.dev.ts +0 -202
- package/src/reset.d.ts +0 -1
- package/src/routes/__snapshots__/capabilities.test.ts.snap +0 -34
- package/src/routes/__snapshots__/entities.test.ts.snap +0 -96
- package/src/routes/__snapshots__/entity.test.ts.snap +0 -74
- package/src/routes/__snapshots__/search.test.ts.snap +0 -165
- package/src/routes/capabilities.test.ts +0 -102
- package/src/routes/crate.test.ts +0 -484
- package/src/routes/entities.test.ts +0 -324
- package/src/routes/entity.test.ts +0 -166
- package/src/routes/file.test.ts +0 -526
- package/src/routes/files.test.ts +0 -304
- package/src/routes/search.test.ts +0 -959
- package/src/test/__snapshots__/integration.test.ts.snap +0 -18
- package/src/test/helpers/fastify.ts +0 -26
- package/src/test/integration.setup.ts +0 -220
- package/src/test/integration.test.ts +0 -953
- package/src/transformers/default.test.ts +0 -276
- package/src/transformers/transformer.test.ts +0 -226
- package/src/utils/errors.test.ts +0 -90
- package/src/utils/queryBuilder.ts +0 -157
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
import { SearchQueryError } from './backend.js';
|
|
2
|
+
import { dateSpan } from './fields.js';
|
|
3
|
+
const MAX_QUERY_LENGTH = 1024;
|
|
4
|
+
const MAX_DEPTH = 10;
|
|
5
|
+
const MAX_CLAUSES = 64;
|
|
6
|
+
class InvalidQueryError extends Error {
|
|
7
|
+
name = 'InvalidQueryError';
|
|
8
|
+
}
|
|
9
|
+
const OPERATORS = ['AND', 'OR', 'NOT'];
|
|
10
|
+
const PUNCTUATION = ['(', ')', ':'];
|
|
11
|
+
const isSpace = (char) => /\s/u.test(char);
|
|
12
|
+
const endsWord = (char) => isSpace(char) || PUNCTUATION.includes(char) || char === '"';
|
|
13
|
+
const tokenise = (chars) => {
|
|
14
|
+
const tokens = [];
|
|
15
|
+
let at = 0;
|
|
16
|
+
while (at < chars.length) {
|
|
17
|
+
const char = chars[at];
|
|
18
|
+
const position = at + 1;
|
|
19
|
+
if (isSpace(char)) {
|
|
20
|
+
at++;
|
|
21
|
+
}
|
|
22
|
+
else if (PUNCTUATION.includes(char)) {
|
|
23
|
+
tokens.push({ kind: char, text: char, position });
|
|
24
|
+
at++;
|
|
25
|
+
}
|
|
26
|
+
else if (char === '"') {
|
|
27
|
+
const close = chars.indexOf('"', at + 1);
|
|
28
|
+
if (close === -1) {
|
|
29
|
+
throw new InvalidQueryError(`Expected a closing " for the phrase at position ${position}, found the end of the query`);
|
|
30
|
+
}
|
|
31
|
+
tokens.push({ kind: 'phrase', text: chars.slice(at + 1, close).join(''), position });
|
|
32
|
+
at = close + 1;
|
|
33
|
+
}
|
|
34
|
+
else {
|
|
35
|
+
const start = at;
|
|
36
|
+
while (at < chars.length && !endsWord(chars[at])) {
|
|
37
|
+
at++;
|
|
38
|
+
}
|
|
39
|
+
const text = chars.slice(start, at).join('');
|
|
40
|
+
tokens.push({ kind: OPERATORS.includes(text) ? text : 'word', text, position });
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
tokens.push({ kind: 'end', text: '', position: chars.length + 1 });
|
|
44
|
+
return tokens;
|
|
45
|
+
};
|
|
46
|
+
const describe = ({ kind, text }) => {
|
|
47
|
+
switch (kind) {
|
|
48
|
+
case 'end':
|
|
49
|
+
return 'the end of the query';
|
|
50
|
+
case 'phrase':
|
|
51
|
+
return `the phrase "${text}"`;
|
|
52
|
+
case 'word':
|
|
53
|
+
return `"${text}"`;
|
|
54
|
+
default:
|
|
55
|
+
return kind.length === 1 ? `"${kind}"` : kind;
|
|
56
|
+
}
|
|
57
|
+
};
|
|
58
|
+
const combine = (type, parts) => parts.length === 1
|
|
59
|
+
? parts[0]
|
|
60
|
+
: { type, clauses: parts.flatMap((part) => (part.type === type ? part.clauses : [part])) };
|
|
61
|
+
const parse = (query, fields) => {
|
|
62
|
+
const tokens = tokenise([...query]);
|
|
63
|
+
let at = 0;
|
|
64
|
+
const peek = (offset = 0) => tokens[at + offset];
|
|
65
|
+
const fail = (expected) => {
|
|
66
|
+
throw new InvalidQueryError(`Expected ${expected} at position ${peek().position}, found ${describe(peek())}`);
|
|
67
|
+
};
|
|
68
|
+
const expect = (kind, expected) => {
|
|
69
|
+
if (peek().kind !== kind) {
|
|
70
|
+
fail(expected);
|
|
71
|
+
}
|
|
72
|
+
at++;
|
|
73
|
+
};
|
|
74
|
+
const parseOr = (field) => {
|
|
75
|
+
const parts = [parseAnd(field)];
|
|
76
|
+
while (peek().kind === 'OR') {
|
|
77
|
+
at++;
|
|
78
|
+
parts.push(parseAnd(field));
|
|
79
|
+
}
|
|
80
|
+
return combine('or', parts);
|
|
81
|
+
};
|
|
82
|
+
const parseAnd = (field) => {
|
|
83
|
+
const parts = [parseUnary(field)];
|
|
84
|
+
while (peek().kind === 'AND') {
|
|
85
|
+
at++;
|
|
86
|
+
parts.push(parseUnary(field));
|
|
87
|
+
}
|
|
88
|
+
return combine('and', parts);
|
|
89
|
+
};
|
|
90
|
+
const parseUnary = (field) => {
|
|
91
|
+
if (peek().kind === 'NOT') {
|
|
92
|
+
at++;
|
|
93
|
+
return { type: 'not', clause: parseUnary(field) };
|
|
94
|
+
}
|
|
95
|
+
return parsePrimary(field);
|
|
96
|
+
};
|
|
97
|
+
const parseBracketed = (field) => {
|
|
98
|
+
at++;
|
|
99
|
+
const clause = parseOr(field);
|
|
100
|
+
expect(')', 'AND, OR or ")"');
|
|
101
|
+
return clause;
|
|
102
|
+
};
|
|
103
|
+
const parsePrimary = (field) => {
|
|
104
|
+
if (peek().kind === '(') {
|
|
105
|
+
return parseBracketed(field);
|
|
106
|
+
}
|
|
107
|
+
if (field !== undefined) {
|
|
108
|
+
return parseValue(field);
|
|
109
|
+
}
|
|
110
|
+
const name = peek();
|
|
111
|
+
if (name.kind !== 'word') {
|
|
112
|
+
fail('a field name');
|
|
113
|
+
}
|
|
114
|
+
at++;
|
|
115
|
+
expect(':', `":" after the field name "${name.text}"`);
|
|
116
|
+
if (!Object.hasOwn(fields, name.text)) {
|
|
117
|
+
throw new InvalidQueryError(`"${name.text}" at position ${name.position} isn't a declared advanced field`);
|
|
118
|
+
}
|
|
119
|
+
return peek().kind === '(' ? parseBracketed(name.text) : parseValue(name.text);
|
|
120
|
+
};
|
|
121
|
+
const startsValueWord = () => peek().kind === 'word' && peek(1).kind !== ':';
|
|
122
|
+
const parseValue = (field) => {
|
|
123
|
+
if (peek().kind === 'phrase') {
|
|
124
|
+
const { text } = peek();
|
|
125
|
+
at++;
|
|
126
|
+
return { type: 'match', field, value: text, phrase: true };
|
|
127
|
+
}
|
|
128
|
+
if (!startsValueWord()) {
|
|
129
|
+
fail(`a value for "${field}"`);
|
|
130
|
+
}
|
|
131
|
+
const words = [];
|
|
132
|
+
while (startsValueWord()) {
|
|
133
|
+
words.push(peek().text);
|
|
134
|
+
at++;
|
|
135
|
+
}
|
|
136
|
+
return { type: 'match', field, value: words.join(' '), phrase: false };
|
|
137
|
+
};
|
|
138
|
+
const tree = parseOr();
|
|
139
|
+
expect('end', 'AND, OR or the end of the query');
|
|
140
|
+
return tree;
|
|
141
|
+
};
|
|
142
|
+
const depthOf = (query) => {
|
|
143
|
+
switch (query.type) {
|
|
144
|
+
case 'and':
|
|
145
|
+
case 'or':
|
|
146
|
+
return 1 + Math.max(...query.clauses.map(depthOf));
|
|
147
|
+
case 'not':
|
|
148
|
+
return 1 + depthOf(query.clause);
|
|
149
|
+
default:
|
|
150
|
+
return 0;
|
|
151
|
+
}
|
|
152
|
+
};
|
|
153
|
+
const clausesIn = (query) => {
|
|
154
|
+
switch (query.type) {
|
|
155
|
+
case 'and':
|
|
156
|
+
case 'or':
|
|
157
|
+
return query.clauses.reduce((sum, clause) => sum + clausesIn(clause), 0);
|
|
158
|
+
case 'not':
|
|
159
|
+
return clausesIn(query.clause);
|
|
160
|
+
default:
|
|
161
|
+
return 1;
|
|
162
|
+
}
|
|
163
|
+
};
|
|
164
|
+
const parseWithinCaps = (query, advancedFields) => {
|
|
165
|
+
const tree = parse(query, advancedFields);
|
|
166
|
+
if (depthOf(tree) > MAX_DEPTH) {
|
|
167
|
+
throw new InvalidQueryError(`The query nests deeper than the limit of ${MAX_DEPTH} levels`);
|
|
168
|
+
}
|
|
169
|
+
if (clausesIn(tree) > MAX_CLAUSES) {
|
|
170
|
+
throw new InvalidQueryError(`The query has more than the limit of ${MAX_CLAUSES} clauses`);
|
|
171
|
+
}
|
|
172
|
+
return tree;
|
|
173
|
+
};
|
|
174
|
+
export const normaliseQuery = (searchType, query, advancedFields) => {
|
|
175
|
+
if ([...query].length > MAX_QUERY_LENGTH) {
|
|
176
|
+
return { problem: `The query is longer than the limit of ${MAX_QUERY_LENGTH} characters` };
|
|
177
|
+
}
|
|
178
|
+
if (searchType === 'basic') {
|
|
179
|
+
return { searchType, query };
|
|
180
|
+
}
|
|
181
|
+
if (query.trim() === '') {
|
|
182
|
+
return { searchType, query: { type: 'all' } };
|
|
183
|
+
}
|
|
184
|
+
try {
|
|
185
|
+
return { searchType, query: parseWithinCaps(query, advancedFields) };
|
|
186
|
+
}
|
|
187
|
+
catch (error) {
|
|
188
|
+
return { problem: error.message };
|
|
189
|
+
}
|
|
190
|
+
};
|
|
191
|
+
export const matchedDateSpan = (field, value) => {
|
|
192
|
+
const span = dateSpan(value);
|
|
193
|
+
if (!span) {
|
|
194
|
+
throw new SearchQueryError(`"${field}" is a date field: "${value}" isn't a date`);
|
|
195
|
+
}
|
|
196
|
+
return span;
|
|
197
|
+
};
|
|
198
|
+
//# sourceMappingURL=advanced.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"advanced.js","sourceRoot":"","sources":["../../src/search/advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACtF,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,SAAS,GAAG,EAAE,CAAC;AAErB,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,MAAM,iBAAkB,SAAQ,KAAK;IAC1B,IAAI,GAAG,mBAAmB,CAAC;CACrC;AASD,MAAM,SAAS,GAAsB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1D,MAAM,WAAW,GAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAEvD,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnD,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,GAAG,CAAC;AAE/F,MAAM,QAAQ,GAAG,CAAC,KAAe,EAAE,EAAE;IACnC,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,IAAI,EAAE,GAAG,CAAC,CAAC;IAEX,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;QACvB,MAAM,QAAQ,GAAG,EAAE,GAAG,CAAC,CAAC;QAExB,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAClB,EAAE,EAAE,CAAC;QACP,CAAC;aAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAqB,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;YACnE,EAAE,EAAE,CAAC;QACP,CAAC;aAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,iBAAiB,CACzB,mDAAmD,QAAQ,8BAA8B,CAC1F,CAAC;YACJ,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACrF,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACjD,EAAE,EAAE,CAAC;YACP,CAAC;YACD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC7C,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,IAAsB,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACrG,CAAC;IACH,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC;IAEnE,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAS,EAAE,EAAE;IACzC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,KAAK;YACR,OAAO,sBAAsB,CAAC;QAChC,KAAK,QAAQ;YACX,OAAO,eAAe,IAAI,GAAG,CAAC;QAChC,KAAK,MAAM;YACT,OAAO,IAAI,IAAI,GAAG,CAAC;QACrB;YACE,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;IAClD,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,IAAkB,EAAE,KAAsB,EAAiB,EAAE,CAC5E,KAAK,CAAC,MAAM,KAAK,CAAC;IAChB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACV,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;AAE/F,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,MAA+B,EAAiB,EAAE;IAC9E,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IACpC,IAAI,EAAE,GAAG,CAAC,CAAC;IAEX,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,CAAC,QAAgB,EAAS,EAAE;QACvC,MAAM,IAAI,iBAAiB,CAAC,YAAY,QAAQ,gBAAgB,IAAI,EAAE,CAAC,QAAQ,WAAW,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;IAChH,CAAC,CAAC;IACF,MAAM,MAAM,GAAG,CAAC,IAAmB,EAAE,QAAgB,EAAE,EAAE;QACvD,IAAI,IAAI,EAAE,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjB,CAAC;QACD,EAAE,EAAE,CAAC;IACP,CAAC,CAAC;IAGF,MAAM,OAAO,GAAG,CAAC,KAAc,EAAiB,EAAE;QAChD,MAAM,KAAK,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,OAAO,IAAI,EAAE,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC5B,EAAE,EAAE,CAAC;YACL,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAiB,EAAE;QACjD,MAAM,KAAK,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAClC,OAAO,IAAI,EAAE,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YAC7B,EAAE,EAAE,CAAC;YACL,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,CAAC;QAED,OAAO,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,CAAC,KAAc,EAAiB,EAAE;QACnD,IAAI,IAAI,EAAE,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YAC1B,EAAE,EAAE,CAAC;YAEL,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,CAAC;QAED,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAC,KAAc,EAAE,EAAE;QACxC,EAAE,EAAE,CAAC;QACL,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;QAE9B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,KAAc,EAAiB,EAAE;QACrD,IAAI,IAAI,EAAE,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;YACxB,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,EAAE,CAAC;QACpB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACzB,IAAI,CAAC,cAAc,CAAC,CAAC;QACvB,CAAC;QACD,EAAE,EAAE,CAAC;QACL,MAAM,CAAC,GAAG,EAAE,6BAA6B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,iBAAiB,CAAC,IAAI,IAAI,CAAC,IAAI,iBAAiB,IAAI,CAAC,QAAQ,kCAAkC,CAAC,CAAC;QAC7G,CAAC;QAED,OAAO,IAAI,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjF,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC;IAE7E,MAAM,UAAU,GAAG,CAAC,KAAa,EAAiB,EAAE;QAClD,IAAI,IAAI,EAAE,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC;YACxB,EAAE,EAAE,CAAC;YAEL,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAC7D,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;YACvB,IAAI,CAAC,gBAAgB,KAAK,GAAG,CAAC,CAAC;QACjC,CAAC;QACD,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,OAAO,eAAe,EAAE,EAAE,CAAC;YACzB,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC;YACxB,EAAE,EAAE,CAAC;QACP,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IACzE,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;IACvB,MAAM,CAAC,KAAK,EAAE,iCAAiC,CAAC,CAAC;IAEjD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,KAAoB,EAAU,EAAE;IAC/C,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,KAAK,CAAC;QACX,KAAK,IAAI;YACP,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACrD,KAAK,KAAK;YACR,OAAO,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnC;YACE,OAAO,CAAC,CAAC;IACb,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,KAAoB,EAAU,EAAE;IACjD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,KAAK,CAAC;QACX,KAAK,IAAI;YACP,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3E,KAAK,KAAK;YACR,OAAO,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC;YACE,OAAO,CAAC,CAAC;IACb,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,cAAuC,EAAiB,EAAE;IAChG,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IAC1C,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,iBAAiB,CAAC,4CAA4C,SAAS,SAAS,CAAC,CAAC;IAC9F,CAAC;IACD,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,CAAC;QAClC,MAAM,IAAI,iBAAiB,CAAC,wCAAwC,WAAW,UAAU,CAAC,CAAC;IAC7F,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,UAAgC,EAChC,KAAa,EACb,cAAuC,EACJ,EAAE;IACrC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;QACzC,OAAO,EAAE,OAAO,EAAE,yCAAyC,gBAAgB,aAAa,EAAE,CAAC;IAC7F,CAAC;IACD,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACxB,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;IAChD,CAAC;IAED,IAAI,CAAC;QACH,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,cAAc,CAAC,EAAE,CAAC;IACvE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAEf,OAAO,EAAE,OAAO,EAAG,KAA2B,CAAC,OAAO,EAAE,CAAC;IAC3D,CAAC;AACH,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,KAAa,EAAE,EAAE;IAC9D,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,gBAAgB,CAAC,IAAI,KAAK,uBAAuB,KAAK,gBAAgB,CAAC,CAAC;IACpF,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import type { RequestContext } from '../types/context.js';
|
|
2
|
+
import type { GeoPoint, SearchDocument } from './fields.js';
|
|
3
|
+
import type { SearchVisibilityWhere } from './visibility.js';
|
|
4
|
+
type Labelled = {
|
|
5
|
+
label?: string;
|
|
6
|
+
};
|
|
7
|
+
export type BackendSearchCapability = {
|
|
8
|
+
filters: Record<string, Labelled & {
|
|
9
|
+
type: 'string' | 'date' | 'number' | 'boolean';
|
|
10
|
+
}>;
|
|
11
|
+
facets: Record<string, Labelled>;
|
|
12
|
+
sorts: Record<string, Labelled>;
|
|
13
|
+
searchTypes: {
|
|
14
|
+
basic: Record<string, never>;
|
|
15
|
+
advanced?: {
|
|
16
|
+
fields: Record<string, Labelled>;
|
|
17
|
+
};
|
|
18
|
+
};
|
|
19
|
+
geo: {
|
|
20
|
+
supported: boolean;
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
export type AdvancedQuery = {
|
|
24
|
+
type: 'and' | 'or';
|
|
25
|
+
clauses: AdvancedQuery[];
|
|
26
|
+
} | {
|
|
27
|
+
type: 'not';
|
|
28
|
+
clause: AdvancedQuery;
|
|
29
|
+
} | {
|
|
30
|
+
type: 'match';
|
|
31
|
+
field: string;
|
|
32
|
+
value: string;
|
|
33
|
+
phrase: boolean;
|
|
34
|
+
} | {
|
|
35
|
+
type: 'all';
|
|
36
|
+
};
|
|
37
|
+
export type RangeBound = number | Date;
|
|
38
|
+
export type RangeFilter = {
|
|
39
|
+
gte?: RangeBound;
|
|
40
|
+
lte?: RangeBound;
|
|
41
|
+
};
|
|
42
|
+
export type BoundingBox = {
|
|
43
|
+
topRight: GeoPoint;
|
|
44
|
+
bottomLeft: GeoPoint;
|
|
45
|
+
};
|
|
46
|
+
export type SearchQuery = {
|
|
47
|
+
searchType: 'basic';
|
|
48
|
+
query: string;
|
|
49
|
+
} | {
|
|
50
|
+
searchType: 'advanced';
|
|
51
|
+
query: AdvancedQuery;
|
|
52
|
+
};
|
|
53
|
+
export type SearchRequest = SearchQuery & {
|
|
54
|
+
filters: {
|
|
55
|
+
terms: Record<string, string[]>;
|
|
56
|
+
ranges: Record<string, RangeFilter[]>;
|
|
57
|
+
};
|
|
58
|
+
boundingBox?: BoundingBox;
|
|
59
|
+
geohashPrecision?: number;
|
|
60
|
+
limit: number;
|
|
61
|
+
offset: number;
|
|
62
|
+
sort: string;
|
|
63
|
+
order: 'asc' | 'desc';
|
|
64
|
+
visibility: SearchVisibilityWhere;
|
|
65
|
+
};
|
|
66
|
+
export type SearchExtra = {
|
|
67
|
+
score?: number;
|
|
68
|
+
highlight?: Record<string, string[]>;
|
|
69
|
+
};
|
|
70
|
+
export type FacetBucket = {
|
|
71
|
+
name: string;
|
|
72
|
+
count: number;
|
|
73
|
+
};
|
|
74
|
+
export declare const GEOHASH_GRID_CELLS = 10000;
|
|
75
|
+
export type SearchResult = {
|
|
76
|
+
total: number;
|
|
77
|
+
hits: {
|
|
78
|
+
id: string;
|
|
79
|
+
searchExtra?: SearchExtra;
|
|
80
|
+
}[];
|
|
81
|
+
facets?: Record<string, FacetBucket[]>;
|
|
82
|
+
geohashGrid?: Record<string, number>;
|
|
83
|
+
};
|
|
84
|
+
export interface SearchBackend {
|
|
85
|
+
readonly capabilities: BackendSearchCapability;
|
|
86
|
+
search(request: SearchRequest, context: RequestContext): Promise<SearchResult>;
|
|
87
|
+
index(docs: SearchDocument[], options?: {
|
|
88
|
+
tx?: unknown;
|
|
89
|
+
}): Promise<void>;
|
|
90
|
+
remove(ids: string[]): Promise<void>;
|
|
91
|
+
}
|
|
92
|
+
export declare class SearchQueryError extends Error {
|
|
93
|
+
name: string;
|
|
94
|
+
}
|
|
95
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"backend.js","sourceRoot":"","sources":["../../src/search/backend.ts"],"names":[],"mappings":"AA6DA,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AA2BzC,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAChC,IAAI,GAAG,kBAAkB,CAAC;CACpC"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import type { BackendSearchCapability } from './backend.js';
|
|
2
|
+
export type FieldType = 'text' | 'keyword' | 'date' | 'number' | 'boolean' | 'geo';
|
|
3
|
+
export type FieldDeclaration = {
|
|
4
|
+
type: FieldType;
|
|
5
|
+
label?: string;
|
|
6
|
+
weight?: number;
|
|
7
|
+
basic?: boolean;
|
|
8
|
+
advanced?: boolean;
|
|
9
|
+
filter?: boolean;
|
|
10
|
+
facet?: boolean | {
|
|
11
|
+
size: number;
|
|
12
|
+
};
|
|
13
|
+
sort?: boolean;
|
|
14
|
+
};
|
|
15
|
+
export type FieldDeclarations = Record<string, FieldDeclaration>;
|
|
16
|
+
export declare const capabilitiesFromFields: (fields: FieldDeclarations) => BackendSearchCapability;
|
|
17
|
+
export declare const isBasic: ({ type, basic }: FieldDeclaration) => boolean;
|
|
18
|
+
export declare const resolveFields: (fields: FieldDeclarations) => {
|
|
19
|
+
basic: {
|
|
20
|
+
name: string;
|
|
21
|
+
type: FieldType;
|
|
22
|
+
weight: number;
|
|
23
|
+
}[];
|
|
24
|
+
facets: {
|
|
25
|
+
name: string;
|
|
26
|
+
type: FieldType;
|
|
27
|
+
size: number;
|
|
28
|
+
}[];
|
|
29
|
+
geoField: string | undefined;
|
|
30
|
+
};
|
|
31
|
+
export declare const withId: (fields: FieldDeclarations) => FieldDeclarations;
|
|
32
|
+
export type GeoPoint = {
|
|
33
|
+
lat: number;
|
|
34
|
+
lng: number;
|
|
35
|
+
};
|
|
36
|
+
type ScalarOf<Type extends FieldType> = Type extends 'number' ? number : Type extends 'boolean' ? boolean : Type extends 'geo' ? GeoPoint : string;
|
|
37
|
+
type ValueOf<Declaration extends FieldDeclaration> = Declaration['type'] extends 'geo' ? GeoPoint : Declaration extends {
|
|
38
|
+
sort: true;
|
|
39
|
+
} ? ScalarOf<Declaration['type']> : ScalarOf<Declaration['type']> | ScalarOf<Declaration['type']>[];
|
|
40
|
+
export type SearchDocument<Fields extends FieldDeclarations = FieldDeclarations> = {
|
|
41
|
+
id: string;
|
|
42
|
+
} & {
|
|
43
|
+
-readonly [Name in keyof Fields]?: ValueOf<Fields[Name]>;
|
|
44
|
+
};
|
|
45
|
+
export type Scalar = string | number | boolean | Date;
|
|
46
|
+
export declare const toWire: (value: Scalar) => string | number | boolean;
|
|
47
|
+
type StoredSearchDocument = {
|
|
48
|
+
id: string;
|
|
49
|
+
values: Record<string, Scalar | Scalar[]>;
|
|
50
|
+
point?: GeoPoint;
|
|
51
|
+
};
|
|
52
|
+
export declare const dateSpan: (value: string) => {
|
|
53
|
+
first: Date;
|
|
54
|
+
last: Date;
|
|
55
|
+
} | undefined;
|
|
56
|
+
export declare const DATE_FORMS = "a YYYY, YYYY-MM, YYYY-MM-DD or RFC 3339 date";
|
|
57
|
+
export declare const storeScalar: (type: FieldType, value: unknown) => {
|
|
58
|
+
value: Scalar | GeoPoint;
|
|
59
|
+
} | {
|
|
60
|
+
problem: string;
|
|
61
|
+
};
|
|
62
|
+
export declare const storeDocuments: (fields: FieldDeclarations, docs: SearchDocument[]) => StoredSearchDocument[];
|
|
63
|
+
export {};
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
const FIELD_NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
|
|
2
|
+
const RESERVED = ['id', 'AND', 'OR', 'NOT'];
|
|
3
|
+
const FIELD_TYPES = ['text', 'keyword', 'date', 'number', 'boolean', 'geo'];
|
|
4
|
+
const isPositiveInteger = (value) => Number.isInteger(value) && value > 0;
|
|
5
|
+
const checkDeclaration = (name, declaration) => {
|
|
6
|
+
if (!FIELD_NAME.test(name)) {
|
|
7
|
+
return `must match ${FIELD_NAME}`;
|
|
8
|
+
}
|
|
9
|
+
if (RESERVED.includes(name)) {
|
|
10
|
+
return 'is reserved';
|
|
11
|
+
}
|
|
12
|
+
const { type, weight, facet } = declaration;
|
|
13
|
+
if (!FIELD_TYPES.includes(type)) {
|
|
14
|
+
return `has unknown type "${type}"`;
|
|
15
|
+
}
|
|
16
|
+
if (type === 'geo') {
|
|
17
|
+
const role = ['basic', 'advanced', 'filter', 'facet', 'sort'].find((r) => declaration[r]);
|
|
18
|
+
if (role) {
|
|
19
|
+
return `is a geo field, which can't have the ${role} role`;
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
if (name === 'relevance' && declaration.sort) {
|
|
23
|
+
return "can't be a sort field, as relevance is always a sort";
|
|
24
|
+
}
|
|
25
|
+
if (weight !== undefined && (type !== 'text' || !isPositiveInteger(weight) || weight > 4)) {
|
|
26
|
+
return 'has a bad weight: only a text field has one, from 1 to 4';
|
|
27
|
+
}
|
|
28
|
+
if (typeof facet === 'object' && !isPositiveInteger(facet.size)) {
|
|
29
|
+
return 'has a bad facet size: it must be a positive integer';
|
|
30
|
+
}
|
|
31
|
+
if (facet && type === 'number') {
|
|
32
|
+
return "is a number field, which can't be a facet";
|
|
33
|
+
}
|
|
34
|
+
if (declaration.basic && type !== 'text' && type !== 'keyword') {
|
|
35
|
+
return `is a ${type} field, which can't be in basic search`;
|
|
36
|
+
}
|
|
37
|
+
return undefined;
|
|
38
|
+
};
|
|
39
|
+
const validateFields = (fields) => {
|
|
40
|
+
let geoField;
|
|
41
|
+
for (const [name, declaration] of Object.entries(fields)) {
|
|
42
|
+
const problem = checkDeclaration(name, declaration);
|
|
43
|
+
if (problem) {
|
|
44
|
+
throw new Error(`Search field "${name}" ${problem}`);
|
|
45
|
+
}
|
|
46
|
+
if (declaration.type === 'geo') {
|
|
47
|
+
if (geoField) {
|
|
48
|
+
throw new Error(`Search field "${name}" is a second geo field, after "${geoField}": only one is allowed`);
|
|
49
|
+
}
|
|
50
|
+
geoField = name;
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
export const capabilitiesFromFields = (fields) => {
|
|
55
|
+
validateFields(fields);
|
|
56
|
+
const declared = Object.entries(fields);
|
|
57
|
+
const publish = (hasRole, describe = () => ({})) => Object.fromEntries(declared
|
|
58
|
+
.filter(([, declaration]) => hasRole(declaration))
|
|
59
|
+
.map(([name, declaration]) => [
|
|
60
|
+
name,
|
|
61
|
+
{ ...describe(declaration), ...(declaration.label !== undefined && { label: declaration.label }) },
|
|
62
|
+
]));
|
|
63
|
+
const advanced = publish(({ advanced }) => advanced);
|
|
64
|
+
return {
|
|
65
|
+
filters: publish(({ filter, facet }) => filter || facet, ({ type }) => ({
|
|
66
|
+
type: type === 'text' || type === 'keyword' ? 'string' : type,
|
|
67
|
+
})),
|
|
68
|
+
facets: publish(({ facet }) => facet),
|
|
69
|
+
sorts: publish(({ sort }) => sort),
|
|
70
|
+
searchTypes: { basic: {}, ...(Object.keys(advanced).length > 0 && { advanced: { fields: advanced } }) },
|
|
71
|
+
geo: { supported: declared.some(([, { type }]) => type === 'geo') },
|
|
72
|
+
};
|
|
73
|
+
};
|
|
74
|
+
const DEFAULT_FACET_SIZE = 20;
|
|
75
|
+
export const isBasic = ({ type, basic }) => (type === 'text' ? basic !== false : Boolean(basic));
|
|
76
|
+
export const resolveFields = (fields) => {
|
|
77
|
+
const declared = Object.entries(fields);
|
|
78
|
+
return {
|
|
79
|
+
basic: declared
|
|
80
|
+
.filter(([, declaration]) => isBasic(declaration))
|
|
81
|
+
.map(([name, { type, weight = 1 }]) => ({ name, type, weight })),
|
|
82
|
+
facets: declared
|
|
83
|
+
.filter(([, { facet }]) => facet)
|
|
84
|
+
.map(([name, { type, facet }]) => ({
|
|
85
|
+
name,
|
|
86
|
+
type,
|
|
87
|
+
size: typeof facet === 'object' ? facet.size : DEFAULT_FACET_SIZE,
|
|
88
|
+
})),
|
|
89
|
+
geoField: declared.find(([, { type }]) => type === 'geo')?.[0],
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
export const withId = (fields) => ({ ...fields, id: { type: 'keyword' } });
|
|
93
|
+
export const toWire = (value) => (value instanceof Date ? value.toISOString() : value);
|
|
94
|
+
const DATE = /^(\d{4})(?:-(\d{2})(?:-(\d{2})(?:[Tt ](\d{2}):(\d{2}):(\d{2})(?:\.(\d+))?([Zz]|[+-]\d{2}:\d{2})?)?)?)?$/;
|
|
95
|
+
const parseDate = (value) => {
|
|
96
|
+
const match = DATE.exec(value);
|
|
97
|
+
if (!match) {
|
|
98
|
+
return undefined;
|
|
99
|
+
}
|
|
100
|
+
const [, year, month = '01', day = '01', hour = '00', minute = '00', second = '00', fraction = '', offset = 'Z'] = match;
|
|
101
|
+
const parts = [year, month, day, hour, minute, second].map(Number);
|
|
102
|
+
const date = new Date(0);
|
|
103
|
+
date.setUTCFullYear(parts[0], parts[1] - 1, parts[2]);
|
|
104
|
+
date.setUTCHours(parts[3], parts[4], parts[5], Number(fraction.padEnd(3, '0').slice(0, 3)));
|
|
105
|
+
const stored = [
|
|
106
|
+
date.getUTCFullYear(),
|
|
107
|
+
date.getUTCMonth() + 1,
|
|
108
|
+
date.getUTCDate(),
|
|
109
|
+
date.getUTCHours(),
|
|
110
|
+
date.getUTCMinutes(),
|
|
111
|
+
date.getUTCSeconds(),
|
|
112
|
+
];
|
|
113
|
+
if (stored.some((part, index) => part !== parts[index])) {
|
|
114
|
+
return undefined;
|
|
115
|
+
}
|
|
116
|
+
if (offset.toUpperCase() !== 'Z') {
|
|
117
|
+
const [offsetHours, offsetMinutes] = offset.slice(1).split(':').map(Number);
|
|
118
|
+
if (offsetHours > 23 || offsetMinutes > 59) {
|
|
119
|
+
return undefined;
|
|
120
|
+
}
|
|
121
|
+
const sign = offset.startsWith('-') ? -1 : 1;
|
|
122
|
+
date.setTime(date.getTime() - sign * (offsetHours * 60 + offsetMinutes) * 60_000);
|
|
123
|
+
}
|
|
124
|
+
return date;
|
|
125
|
+
};
|
|
126
|
+
export const dateSpan = (value) => {
|
|
127
|
+
const first = parseDate(value);
|
|
128
|
+
if (!first) {
|
|
129
|
+
return undefined;
|
|
130
|
+
}
|
|
131
|
+
const [, , month, day, hour] = DATE.exec(value);
|
|
132
|
+
if (hour !== undefined) {
|
|
133
|
+
return { first, last: first };
|
|
134
|
+
}
|
|
135
|
+
const next = new Date(first);
|
|
136
|
+
if (day !== undefined) {
|
|
137
|
+
next.setUTCDate(next.getUTCDate() + 1);
|
|
138
|
+
}
|
|
139
|
+
else if (month !== undefined) {
|
|
140
|
+
next.setUTCMonth(next.getUTCMonth() + 1);
|
|
141
|
+
}
|
|
142
|
+
else {
|
|
143
|
+
next.setUTCFullYear(next.getUTCFullYear() + 1);
|
|
144
|
+
}
|
|
145
|
+
return { first, last: new Date(next.getTime() - 1) };
|
|
146
|
+
};
|
|
147
|
+
const isGeoPoint = (value) => {
|
|
148
|
+
if (typeof value !== 'object' || value === null || Object.keys(value).length !== 2) {
|
|
149
|
+
return false;
|
|
150
|
+
}
|
|
151
|
+
const { lat, lng } = value;
|
|
152
|
+
return typeof lat === 'number' && typeof lng === 'number' && Math.abs(lat) <= 90 && Math.abs(lng) <= 180;
|
|
153
|
+
};
|
|
154
|
+
export const DATE_FORMS = 'a YYYY, YYYY-MM, YYYY-MM-DD or RFC 3339 date';
|
|
155
|
+
export const storeScalar = (type, value) => {
|
|
156
|
+
switch (type) {
|
|
157
|
+
case 'text':
|
|
158
|
+
case 'keyword':
|
|
159
|
+
return typeof value === 'string' ? { value } : { problem: 'must be a string' };
|
|
160
|
+
case 'date': {
|
|
161
|
+
const date = typeof value === 'string' ? parseDate(value) : undefined;
|
|
162
|
+
return date ? { value: date } : { problem: `must be ${DATE_FORMS}` };
|
|
163
|
+
}
|
|
164
|
+
case 'number':
|
|
165
|
+
return typeof value === 'number' && Number.isFinite(value) ? { value } : { problem: 'must be a finite number' };
|
|
166
|
+
case 'boolean':
|
|
167
|
+
return typeof value === 'boolean' ? { value } : { problem: 'must be a boolean' };
|
|
168
|
+
case 'geo':
|
|
169
|
+
return isGeoPoint(value)
|
|
170
|
+
? { value }
|
|
171
|
+
: { problem: 'must be { lat, lng } with lat from -90 to 90 and lng from -180 to 180' };
|
|
172
|
+
}
|
|
173
|
+
};
|
|
174
|
+
export const storeDocuments = (fields, docs) => docs.map(({ id, ...rest }) => {
|
|
175
|
+
if (typeof id !== 'string' || id === '') {
|
|
176
|
+
throw new Error('Search document has no id');
|
|
177
|
+
}
|
|
178
|
+
const fail = (key, problem) => {
|
|
179
|
+
throw new Error(`Search document "${id}": "${key}" ${problem}`);
|
|
180
|
+
};
|
|
181
|
+
const stored = { id, values: {} };
|
|
182
|
+
for (const [key, value] of Object.entries(rest)) {
|
|
183
|
+
const declaration = Object.hasOwn(fields, key) ? fields[key] : undefined;
|
|
184
|
+
if (!declaration) {
|
|
185
|
+
return fail(key, "isn't a declared field");
|
|
186
|
+
}
|
|
187
|
+
if (Array.isArray(value) && (declaration.sort || declaration.type === 'geo')) {
|
|
188
|
+
return fail(key, 'takes a single value, not an array');
|
|
189
|
+
}
|
|
190
|
+
const items = (Array.isArray(value) ? value : [value]).map((item) => {
|
|
191
|
+
const result = storeScalar(declaration.type, item);
|
|
192
|
+
return 'value' in result ? result.value : fail(key, `${result.problem}, not ${JSON.stringify(item)}`);
|
|
193
|
+
});
|
|
194
|
+
if (declaration.type === 'geo') {
|
|
195
|
+
stored.point = items[0];
|
|
196
|
+
}
|
|
197
|
+
else {
|
|
198
|
+
stored.values[key] = Array.isArray(value) ? items : items[0];
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
return stored;
|
|
202
|
+
});
|
|
203
|
+
//# sourceMappingURL=fields.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../src/search/fields.ts"],"names":[],"mappings":"AAoBA,MAAM,UAAU,GAAG,0BAA0B,CAAC;AAC9C,MAAM,QAAQ,GAAsB,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAC/D,MAAM,WAAW,GAAsB,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAE/F,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;AAElF,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,WAA6B,EAAE,EAAE;IACvE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,OAAO,cAAc,UAAU,EAAE,CAAC;IACpC,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5B,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,WAAW,CAAC;IAC5C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,OAAO,qBAAqB,IAAI,GAAG,CAAC;IACtC,CAAC;IACD,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;QACnB,MAAM,IAAI,GAAI,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QACrG,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,wCAAwC,IAAI,OAAO,CAAC;QAC7D,CAAC;IACH,CAAC;IACD,IAAI,IAAI,KAAK,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;QAC7C,OAAO,sDAAsD,CAAC;IAChE,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QAC1F,OAAO,0DAA0D,CAAC;IACpE,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAChE,OAAO,qDAAqD,CAAC;IAC/D,CAAC;IACD,IAAI,KAAK,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,2CAA2C,CAAC;IACrD,CAAC;IACD,IAAI,WAAW,CAAC,KAAK,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/D,OAAO,QAAQ,IAAI,wCAAwC,CAAC;IAC9D,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAKF,MAAM,cAAc,GAAG,CAAC,MAAyB,EAAE,EAAE;IACnD,IAAI,QAA4B,CAAC;IAEjC,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACzD,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACpD,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,WAAW,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,mCAAmC,QAAQ,wBAAwB,CAAC,CAAC;YAC5G,CAAC;YACD,QAAQ,GAAG,IAAI,CAAC;QAClB,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,MAAyB,EAA2B,EAAE;IAC3F,cAAc,CAAC,MAAM,CAAC,CAAC;IAEvB,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,CACd,OAAmD,EACnD,QAAQ,GAAiD,GAAG,EAAE,CAAC,CAAC,EAAE,CAAc,EAChF,EAAE,CACF,MAAM,CAAC,WAAW,CAChB,QAAQ;SACL,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SACjD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC;QAC5B,IAAI;QACJ,EAAE,GAAG,QAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC,EAAE;KACnG,CAAC,CACL,CAAC;IAEJ,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IAErD,OAAO;QACL,OAAO,EAAE,OAAO,CACd,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,MAAM,IAAI,KAAK,EACtC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;YACb,IAAI,EAAE,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAE,IAAsC;SACjG,CAAC,CACH;QACD,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC;QACrC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC;QAClC,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,EAAE;QACvG,GAAG,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE;KACpE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAoB,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AAKnH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAyB,EAAE,EAAE;IACzD,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAExC,OAAO;QACL,KAAK,EAAE,QAAQ;aACZ,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;aACjD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAClE,MAAM,EAAE,QAAQ;aACb,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC;aAChC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACjC,IAAI;YACJ,IAAI;YACJ,IAAI,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB;SAClE,CAAC,CAAC;QACL,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;KAC/D,CAAC;AACJ,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,MAAyB,EAAqB,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;AA4BjH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAQ/F,MAAM,IAAI,GAAG,yGAAyG,CAAC;AAEvH,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,EAAE;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,GAAG,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,GAAG,EAAE,EAAE,MAAM,GAAG,GAAG,CAAC,GAC9G,KAAK,CAAC;IACR,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEnE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5F,MAAM,MAAM,GAAG;QACb,IAAI,CAAC,cAAc,EAAE;QACrB,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC;QACtB,IAAI,CAAC,UAAU,EAAE;QACjB,IAAI,CAAC,WAAW,EAAE;QAClB,IAAI,CAAC,aAAa,EAAE;QACpB,IAAI,CAAC,aAAa,EAAE;KACrB,CAAC;IACF,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACxD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,MAAM,CAAC,WAAW,EAAE,KAAK,GAAG,EAAE,CAAC;QACjC,MAAM,CAAC,WAAW,EAAE,aAAa,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5E,IAAI,WAAW,GAAG,EAAE,IAAI,aAAa,GAAG,EAAE,EAAE,CAAC;YAC3C,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,CAAC,WAAW,GAAG,EAAE,GAAG,aAAa,CAAC,GAAG,MAAM,CAAC,CAAC;IACpF,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,EAAE;IACxC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,EAAE,AAAD,EAAG,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAoB,CAAC;IACnE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC;IACzC,CAAC;SAAM,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,KAAc,EAAqB,EAAE;IACvD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnF,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAA0B,CAAC;IAEhD,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC;AAC3G,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,8CAA8C,CAAC;AAKzE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAe,EAAE,KAAc,EAAsD,EAAE;IACjH,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS;YACZ,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;QACjF,KAAK,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,UAAU,EAAE,EAAE,CAAC;QACvE,CAAC;QACD,KAAK,QAAQ;YACX,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,yBAAyB,EAAE,CAAC;QAClH,KAAK,SAAS;YACZ,OAAO,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC;QACnF,KAAK,KAAK;YACR,OAAO,UAAU,CAAC,KAAK,CAAC;gBACtB,CAAC,CAAC,EAAE,KAAK,EAAE;gBACX,CAAC,CAAC,EAAE,OAAO,EAAE,uEAAuE,EAAE,CAAC;IAC7F,CAAC;AACH,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAyB,EAAE,IAAsB,EAA0B,EAAE,CAC1G,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE;IAC3B,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,OAAe,EAAE,EAAE;QAC5C,MAAM,IAAI,KAAK,CAAC,oBAAoB,EAAE,OAAO,GAAG,KAAK,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC,CAAC;IAEF,MAAM,MAAM,GAAyB,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACxD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAC7E,OAAO,IAAI,CAAC,GAAG,EAAE,oCAAoC,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAClE,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,OAAO,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,OAAO,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxG,CAAC,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YAC/B,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAa,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,KAAkB,CAAC,CAAC,CAAE,KAAK,CAAC,CAAC,CAAY,CAAC;QACzF,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { QueryContainer } from '@opensearch-project/opensearch/api/_types/_common.query_dsl.js';
|
|
2
|
+
import type { AdvancedQuery } from '../backend.js';
|
|
3
|
+
import type { FieldDeclarations } from '../fields.js';
|
|
4
|
+
export declare const advancedQueryFor: (query: AdvancedQuery, fields: FieldDeclarations) => QueryContainer;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { matchedDateSpan } from '../advanced.js';
|
|
2
|
+
export const advancedQueryFor = (query, fields) => {
|
|
3
|
+
switch (query.type) {
|
|
4
|
+
case 'and':
|
|
5
|
+
return { bool: { must: query.clauses.map((clause) => advancedQueryFor(clause, fields)) } };
|
|
6
|
+
case 'or':
|
|
7
|
+
return {
|
|
8
|
+
bool: { should: query.clauses.map((clause) => advancedQueryFor(clause, fields)), minimum_should_match: 1 },
|
|
9
|
+
};
|
|
10
|
+
case 'not':
|
|
11
|
+
return { bool: { must_not: [advancedQueryFor(query.clause, fields)] } };
|
|
12
|
+
case 'match': {
|
|
13
|
+
const { field, value, phrase } = query;
|
|
14
|
+
const { type } = fields[field];
|
|
15
|
+
if (type === 'date') {
|
|
16
|
+
const { first, last } = matchedDateSpan(field, value);
|
|
17
|
+
return { range: { [field]: { gte: first.toISOString(), lte: last.toISOString() } } };
|
|
18
|
+
}
|
|
19
|
+
if (type !== 'text') {
|
|
20
|
+
return { term: { [field]: value } };
|
|
21
|
+
}
|
|
22
|
+
return phrase ? { match_phrase: { [field]: value } } : { match: { [field]: { query: value, operator: 'and' } } };
|
|
23
|
+
}
|
|
24
|
+
default:
|
|
25
|
+
return { match_all: {} };
|
|
26
|
+
}
|
|
27
|
+
};
|
|
28
|
+
//# sourceMappingURL=advanced.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"advanced.js","sourceRoot":"","sources":["../../../src/search/opensearch/advanced.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAOjD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAoB,EAAE,MAAyB,EAAkB,EAAE;IAClG,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,KAAK;YACR,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC;QAC7F,KAAK,IAAI;YACP,OAAO;gBACL,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,EAAE;aAC3G,CAAC;QACJ,KAAK,KAAK;YACR,OAAO,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC;QAC1E,KAAK,OAAO,EAAE,CAAC;YACb,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;YACvC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;gBACpB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAEtD,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,CAAC;YACvF,CAAC;YACD,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;gBACpB,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;YACtC,CAAC;YAED,OAAO,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACnH,CAAC;QACD;YACE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { Client } from '@opensearch-project/opensearch';
|
|
2
|
+
import { type SearchRequest, type SearchResult } from '../backend.js';
|
|
3
|
+
import { type FieldDeclarations, type SearchDocument } from '../fields.js';
|
|
4
|
+
export type OpenSearchBackendOptions<Fields extends FieldDeclarations> = {
|
|
5
|
+
client: Client;
|
|
6
|
+
fields: Fields;
|
|
7
|
+
indexName?: string;
|
|
8
|
+
refresh?: boolean | 'wait_for';
|
|
9
|
+
};
|
|
10
|
+
export declare const OpenSearchBackend: <const Fields extends FieldDeclarations>({ client, fields, indexName, refresh, }: OpenSearchBackendOptions<Fields>) => {
|
|
11
|
+
capabilities: import("../backend.js").BackendSearchCapability;
|
|
12
|
+
search: (request: SearchRequest) => Promise<SearchResult>;
|
|
13
|
+
createIndex: () => Promise<void>;
|
|
14
|
+
index: (docs: SearchDocument<Fields>[]) => Promise<void>;
|
|
15
|
+
remove: (ids: string[]) => Promise<void>;
|
|
16
|
+
};
|