arocapi 2.0.3 → 2.1.0
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/README.md +24 -0
- package/dist/app.d.ts +6 -0
- package/dist/app.js +4 -2
- package/dist/app.js.map +1 -1
- package/dist/routes/search.d.ts +3 -0
- package/dist/routes/search.js +7 -116
- package/dist/routes/search.js.map +1 -1
- package/dist/transformers/default.d.ts +1 -1
- package/dist/utils/queryBuilder.d.ts +35 -0
- package/dist/utils/queryBuilder.js +99 -0
- package/dist/utils/queryBuilder.js.map +1 -0
- package/package.json +4 -1
- package/prisma/models/file.prisma +1 -1
- package/src/app.ts +9 -1
- package/src/routes/search.ts +15 -141
- package/src/transformers/default.ts +1 -1
- package/src/utils/queryBuilder.ts +134 -0
package/README.md
CHANGED
|
@@ -234,6 +234,30 @@ The arocapi provides the following endpoints:
|
|
|
234
234
|
- `GET /file/:id` - Download or access file content
|
|
235
235
|
- `POST /search` - Search entities using OpenSearch
|
|
236
236
|
|
|
237
|
+
## Customising OpenSearch query
|
|
238
|
+
|
|
239
|
+
The OpenSearch query builder used in the `/search` endpoint can be customised to match any
|
|
240
|
+
structure of the actual OpenSearch data. The default OpensearchQueryBuilder class is used to
|
|
241
|
+
build all the queries for the search and an optional config can be passed on
|
|
242
|
+
to customise the class behaviour.
|
|
243
|
+
|
|
244
|
+
### Query Builder (Optional)
|
|
245
|
+
Use the `queryBuilderClass` optional parameter to specify a custom builder class.
|
|
246
|
+
If not specified, the default `OpensearchQueryBuilder` is used.
|
|
247
|
+
The custom class should extend the `OpensearchQueryBuilder` class and
|
|
248
|
+
may override any or all of the methods as required:
|
|
249
|
+
|
|
250
|
+
- `buildQuery`: For generating the base search query.
|
|
251
|
+
- `buildAggregations`: For generating the facets or aggregations related query.
|
|
252
|
+
- `buildSort`: For generating the ordering/sorting part of the query.
|
|
253
|
+
|
|
254
|
+
### Query Builder Options (Optional)
|
|
255
|
+
The `queryBuilderOptions` optional parameter is passed as a constructor argument
|
|
256
|
+
when instantiating the queryBuilderClass. The default `OpensearchQueryBuilder` can be
|
|
257
|
+
configured with:
|
|
258
|
+
|
|
259
|
+
- `aggregations`: This field controls the aggregation and will be passed verbatim as the `aggs` field in the generated search query.
|
|
260
|
+
|
|
237
261
|
## Customising Entity Responses
|
|
238
262
|
|
|
239
263
|
The API provides a flexible transformer system for customising entity responses
|
package/dist/app.d.ts
CHANGED
|
@@ -3,10 +3,14 @@ import type { FastifyPluginAsync } from 'fastify';
|
|
|
3
3
|
import type { PrismaClient } from './generated/prisma/client.js';
|
|
4
4
|
import type { FileHandler, RoCrateHandler } from './types/fileHandlers.js';
|
|
5
5
|
import type { AccessTransformer, EntityTransformer, FileAccessTransformer, FileTransformer } from './types/transformers.js';
|
|
6
|
+
import type { QueryBuilderOptions } from './utils/queryBuilder.js';
|
|
7
|
+
import { OpensearchQueryBuilder } from './utils/queryBuilder.js';
|
|
6
8
|
export type { AuthorisedEntity, AuthorisedFile, StandardEntity, StandardFile } from './transformers/default.js';
|
|
7
9
|
export { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from './transformers/default.js';
|
|
8
10
|
export type { FileHandler, FileHandlerContext, FileMetadata, FilePathResult, FileRedirectResult, FileResult, FileStreamResult, GetFileHandler, GetRoCrateHandler, HeadFileHandler, HeadRoCrateHandler, RoCrateHandler, } from './types/fileHandlers.js';
|
|
9
11
|
export type { AccessTransformer, EntityTransformer, FileAccessTransformer, FileTransformer, TransformerContext, } from './types/transformers.js';
|
|
12
|
+
export { OpensearchQueryBuilder };
|
|
13
|
+
export type { QueryBuilderOptions };
|
|
10
14
|
declare module 'fastify' {
|
|
11
15
|
interface FastifyInstance {
|
|
12
16
|
prisma: PrismaClient;
|
|
@@ -16,6 +20,8 @@ declare module 'fastify' {
|
|
|
16
20
|
export type Options = {
|
|
17
21
|
prisma: PrismaClient;
|
|
18
22
|
opensearch: Client;
|
|
23
|
+
queryBuilderClass?: typeof OpensearchQueryBuilder;
|
|
24
|
+
queryBuilderOptions?: QueryBuilderOptions;
|
|
19
25
|
disableCors?: boolean;
|
|
20
26
|
accessTransformer: AccessTransformer;
|
|
21
27
|
entityTransformers?: EntityTransformer[];
|
package/dist/app.js
CHANGED
|
@@ -9,7 +9,9 @@ import file from './routes/file.js';
|
|
|
9
9
|
import files from './routes/files.js';
|
|
10
10
|
import search from './routes/search.js';
|
|
11
11
|
import { createValidationError } from './utils/errors.js';
|
|
12
|
+
import { OpensearchQueryBuilder } from './utils/queryBuilder.js';
|
|
12
13
|
export { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from './transformers/default.js';
|
|
14
|
+
export { OpensearchQueryBuilder };
|
|
13
15
|
const setupValidation = (fastify) => {
|
|
14
16
|
fastify.setValidatorCompiler(validatorCompiler);
|
|
15
17
|
fastify.setSerializerCompiler(serializerCompiler);
|
|
@@ -44,7 +46,7 @@ const setupSearch = async (fastify, opensearch) => {
|
|
|
44
46
|
fastify.addHook('onClose', () => opensearch.close());
|
|
45
47
|
};
|
|
46
48
|
const app = async (fastify, options) => {
|
|
47
|
-
const { prisma, opensearch, disableCors = false, accessTransformer, entityTransformers, fileAccessTransformer, fileTransformers, fileHandler, roCrateHandler, } = options;
|
|
49
|
+
const { prisma, opensearch, queryBuilderClass, queryBuilderOptions, disableCors = false, accessTransformer, entityTransformers, fileAccessTransformer, fileTransformers, fileHandler, roCrateHandler, } = options;
|
|
48
50
|
if (!prisma) {
|
|
49
51
|
throw new Error('Prisma client is required');
|
|
50
52
|
}
|
|
@@ -75,7 +77,7 @@ const app = async (fastify, options) => {
|
|
|
75
77
|
fastify.register(files, { fileAccessTransformer, fileTransformers });
|
|
76
78
|
fastify.register(file, { fileHandler });
|
|
77
79
|
fastify.register(crate, { roCrateHandler });
|
|
78
|
-
fastify.register(search, { accessTransformer, entityTransformers });
|
|
80
|
+
fastify.register(search, { accessTransformer, entityTransformers, queryBuilderClass, queryBuilderOptions });
|
|
79
81
|
};
|
|
80
82
|
export default fp(app);
|
|
81
83
|
//# sourceMappingURL=app.js.map
|
package/dist/app.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,eAAe,CAAC;AACjC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAGzC,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAChC,OAAO,EAAE,mCAAmC,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAEvH,OAAO,KAAK,MAAM,mBAAmB,CAAC;AACtC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,IAAI,MAAM,kBAAkB,CAAC;AACpC,OAAO,KAAK,MAAM,mBAAmB,CAAC;AACtC,OAAO,MAAM,MAAM,oBAAoB,CAAC;AAQxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,eAAe,CAAC;AACjC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAGzC,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAChC,OAAO,EAAE,mCAAmC,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAEvH,OAAO,KAAK,MAAM,mBAAmB,CAAC;AACtC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,IAAI,MAAM,kBAAkB,CAAC;AACpC,OAAO,KAAK,MAAM,mBAAmB,CAAC;AACtC,OAAO,MAAM,MAAM,oBAAoB,CAAC;AAQxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAGjE,OAAO,EAAE,0BAA0B,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAsBvG,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAUlC,MAAM,eAAe,GAAG,CAAC,OAAwB,EAAE,EAAE;IACnD,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAChD,OAAO,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAElD,OAAO,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;QAC7C,IAAI,mCAAmC,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,oCAAoC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;QAC7G,CAAC;QAID,MAAM,GAAG,GAAG,KAAc,CAAC;QAC3B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YAC1B,KAAK,EAAE,uBAAuB;YAC9B,OAAO,EAAE,GAAG,CAAC,OAAO;SACrB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,KAAK,EAAE,OAAwB,EAAE,MAAoB,EAAE,EAAE;IAC7E,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;IAExB,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAEnC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,KAAK,EAAE,OAAwB,EAAE,UAAkB,EAAE,EAAE;IACzE,IAAI,CAAC;QACH,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC;QACxB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAC9C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAC;QAC/D,MAAM,KAAK,CAAC;IACd,CAAC;IAED,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAE3C,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;AACvD,CAAC,CAAC;AAeF,MAAM,GAAG,GAAgC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;IAClE,MAAM,EACJ,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,mBAAmB,EACnB,WAAW,GAAG,KAAK,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,WAAW,EACX,cAAc,GACf,GAAG,OAAO,CAAC;IAEZ,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC3B,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IACD,eAAe,CAAC,OAAO,CAAC,CAAC;IACzB,MAAM,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACrC,MAAM,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAEvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACtE,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACpE,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACrE,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC,CAAC;AAC9G,CAAC,CAAC;AAEF,eAAe,EAAE,CAAC,GAAG,CAAC,CAAC"}
|
package/dist/routes/search.d.ts
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
2
|
import type { AccessTransformer, EntityTransformer } from '../types/transformers.js';
|
|
3
|
+
import { OpensearchQueryBuilder, type QueryBuilderOptions } from '../utils/queryBuilder.js';
|
|
3
4
|
type SearchRouteOptions = {
|
|
4
5
|
accessTransformer: AccessTransformer;
|
|
5
6
|
entityTransformers?: EntityTransformer[];
|
|
7
|
+
queryBuilderClass?: typeof OpensearchQueryBuilder;
|
|
8
|
+
queryBuilderOptions?: QueryBuilderOptions;
|
|
6
9
|
};
|
|
7
10
|
declare const search: FastifyPluginAsync<SearchRouteOptions>;
|
|
8
11
|
export default search;
|
package/dist/routes/search.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { z } from 'zod/v4';
|
|
2
2
|
import { baseEntityTransformer, resolveEntityReferences } from '../transformers/default.js';
|
|
3
3
|
import { createInternalError } from '../utils/errors.js';
|
|
4
|
+
import { OpensearchQueryBuilder } from '../utils/queryBuilder.js';
|
|
4
5
|
const boundingBoxSchema = z.object({
|
|
5
6
|
topRight: z.object({
|
|
6
7
|
lat: z.number(),
|
|
@@ -22,120 +23,9 @@ const searchParamsSchema = z.object({
|
|
|
22
23
|
sort: z.enum(['id', 'name', 'createdAt', 'updatedAt', 'relevance']).default('relevance'),
|
|
23
24
|
order: z.enum(['asc', 'desc']).default('asc'),
|
|
24
25
|
});
|
|
25
|
-
const buildQuery = (searchType, query, filters, boundingBox) => {
|
|
26
|
-
const must = [];
|
|
27
|
-
const filter = [];
|
|
28
|
-
if (searchType === 'basic') {
|
|
29
|
-
must.push({
|
|
30
|
-
multi_match: {
|
|
31
|
-
query,
|
|
32
|
-
fields: ['name^2', 'description'],
|
|
33
|
-
type: 'best_fields',
|
|
34
|
-
fuzziness: 'AUTO',
|
|
35
|
-
zero_terms_query: 'all',
|
|
36
|
-
},
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
else {
|
|
40
|
-
must.push({
|
|
41
|
-
query_string: {
|
|
42
|
-
query,
|
|
43
|
-
fields: ['name^2', 'description'],
|
|
44
|
-
default_operator: 'AND',
|
|
45
|
-
},
|
|
46
|
-
});
|
|
47
|
-
}
|
|
48
|
-
if (filters) {
|
|
49
|
-
Object.entries(filters).forEach(([field, values]) => {
|
|
50
|
-
filter.push({
|
|
51
|
-
terms: {
|
|
52
|
-
[field]: values,
|
|
53
|
-
},
|
|
54
|
-
});
|
|
55
|
-
});
|
|
56
|
-
}
|
|
57
|
-
if (boundingBox) {
|
|
58
|
-
filter.push({
|
|
59
|
-
geo_bounding_box: {
|
|
60
|
-
location: {
|
|
61
|
-
top_left: {
|
|
62
|
-
lat: boundingBox.topRight.lat,
|
|
63
|
-
lon: boundingBox.bottomLeft.lng,
|
|
64
|
-
},
|
|
65
|
-
bottom_right: {
|
|
66
|
-
lat: boundingBox.bottomLeft.lat,
|
|
67
|
-
lon: boundingBox.topRight.lng,
|
|
68
|
-
},
|
|
69
|
-
},
|
|
70
|
-
},
|
|
71
|
-
});
|
|
72
|
-
}
|
|
73
|
-
return {
|
|
74
|
-
bool: {
|
|
75
|
-
must,
|
|
76
|
-
filter,
|
|
77
|
-
},
|
|
78
|
-
};
|
|
79
|
-
};
|
|
80
|
-
const buildAggregations = (geohashPrecision, boundingBox) => {
|
|
81
|
-
const aggs = {
|
|
82
|
-
inLanguage: {
|
|
83
|
-
terms: {
|
|
84
|
-
field: 'inLanguage.keyword',
|
|
85
|
-
size: 20,
|
|
86
|
-
},
|
|
87
|
-
},
|
|
88
|
-
mediaType: {
|
|
89
|
-
terms: {
|
|
90
|
-
field: 'mediaType.keyword',
|
|
91
|
-
size: 20,
|
|
92
|
-
},
|
|
93
|
-
},
|
|
94
|
-
communicationMode: {
|
|
95
|
-
terms: {
|
|
96
|
-
field: 'communicationMode.keyword',
|
|
97
|
-
size: 20,
|
|
98
|
-
},
|
|
99
|
-
},
|
|
100
|
-
entityType: {
|
|
101
|
-
terms: {
|
|
102
|
-
field: 'entityType.keyword',
|
|
103
|
-
size: 20,
|
|
104
|
-
},
|
|
105
|
-
},
|
|
106
|
-
};
|
|
107
|
-
if (geohashPrecision && boundingBox) {
|
|
108
|
-
aggs.geohash_grid = {
|
|
109
|
-
geohash_grid: {
|
|
110
|
-
field: 'location',
|
|
111
|
-
precision: geohashPrecision,
|
|
112
|
-
bounds: {
|
|
113
|
-
top_left: {
|
|
114
|
-
lat: boundingBox.topRight.lat,
|
|
115
|
-
lon: boundingBox.bottomLeft.lng,
|
|
116
|
-
},
|
|
117
|
-
bottom_right: {
|
|
118
|
-
lat: boundingBox.bottomLeft.lat,
|
|
119
|
-
lon: boundingBox.topRight.lng,
|
|
120
|
-
},
|
|
121
|
-
},
|
|
122
|
-
},
|
|
123
|
-
};
|
|
124
|
-
}
|
|
125
|
-
return aggs;
|
|
126
|
-
};
|
|
127
|
-
const buildSort = (sort, order) => {
|
|
128
|
-
if (sort === 'relevance') {
|
|
129
|
-
return;
|
|
130
|
-
}
|
|
131
|
-
const sortField = sort === 'id' ? 'rocrateId' : sort;
|
|
132
|
-
if (sortField === 'name') {
|
|
133
|
-
return [{ 'name.keyword': order }];
|
|
134
|
-
}
|
|
135
|
-
return [{ [sortField]: order }];
|
|
136
|
-
};
|
|
137
26
|
const search = async (fastify, opts) => {
|
|
138
|
-
const { accessTransformer, entityTransformers = [] } = opts;
|
|
27
|
+
const { accessTransformer, entityTransformers = [], queryBuilderClass = OpensearchQueryBuilder, queryBuilderOptions, } = opts;
|
|
28
|
+
const queryBuilder = new queryBuilderClass(queryBuilderOptions);
|
|
139
29
|
fastify.withTypeProvider().post('/search', {
|
|
140
30
|
schema: {
|
|
141
31
|
body: searchParamsSchema,
|
|
@@ -146,19 +36,20 @@ const search = async (fastify, opts) => {
|
|
|
146
36
|
const opensearchQuery = {
|
|
147
37
|
index: 'entities',
|
|
148
38
|
body: {
|
|
149
|
-
query: buildQuery(searchType, query, filters, boundingBox),
|
|
150
|
-
aggs: buildAggregations(geohashPrecision, boundingBox),
|
|
39
|
+
query: queryBuilder.buildQuery(searchType, query, filters, boundingBox),
|
|
40
|
+
aggs: queryBuilder.buildAggregations(geohashPrecision, boundingBox),
|
|
151
41
|
highlight: {
|
|
152
42
|
fields: {
|
|
153
43
|
name: {},
|
|
154
44
|
description: {},
|
|
155
45
|
},
|
|
156
46
|
},
|
|
157
|
-
sort: buildSort(sort, order),
|
|
47
|
+
sort: queryBuilder.buildSort(sort, order),
|
|
158
48
|
from: offset,
|
|
159
49
|
size: limit,
|
|
160
50
|
},
|
|
161
51
|
};
|
|
52
|
+
fastify.log.debug(opensearchQuery);
|
|
162
53
|
const response = await fastify.opensearch.search(opensearchQuery);
|
|
163
54
|
if (!response.body?.hits?.hits) {
|
|
164
55
|
throw new Error('Invalid search response: missing hits data');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/routes/search.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/routes/search.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAE5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAA4B,MAAM,0BAA0B,CAAC;AAE5F,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;QACjB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;KAChB,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;QACnB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;KAChB,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC1D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC7D,WAAW,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACzC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;IACrD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IACxF,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;CAC9C,CAAC,CAAC;AASH,MAAM,MAAM,GAA2C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IAC7E,MAAM,EACJ,iBAAiB,EACjB,kBAAkB,GAAG,EAAE,EACvB,iBAAiB,GAAG,sBAAsB,EAC1C,mBAAmB,GACpB,GAAG,IAAI,CAAC;IACT,MAAM,YAAY,GAAG,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;IAChE,OAAO,CAAC,gBAAgB,EAAmB,CAAC,IAAI,CAC9C,SAAS,EACT;QACE,MAAM,EAAE;YACN,IAAI,EAAE,kBAAkB;SACzB;KACF,EACD,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACvB,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;QAE/G,IAAI,CAAC;YACH,MAAM,eAAe,GAAmB;gBACtC,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE;oBACJ,KAAK,EAAE,YAAY,CAAC,UAAU,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC;oBACvE,IAAI,EAAE,YAAY,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,WAAW,CAAC;oBACnE,SAAS,EAAE;wBACT,MAAM,EAAE;4BACN,IAAI,EAAE,EAAE;4BACR,WAAW,EAAE,EAAE;yBAChB;qBACF;oBACD,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC;oBACzC,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,KAAK;iBACZ;aACF,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YACnC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;YAElE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAChE,CAAC;YAED,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;iBACvC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,SAA+B,CAAC;iBAC1D,MAAM,CAAC,OAAO,CAAC,CAAC;YAEnB,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACtD,KAAK,EAAE;oBACL,SAAS,EAAE;wBACT,EAAE,EAAE,UAAU;qBACf;iBACF;aACF,CAAC,CAAC;YAEH,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;YAGlF,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YAEzE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACxC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC;oBAC5B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;gBACrD,CAAC;gBAED,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,OAAO,CAAC,SAAS,0CAA0C,CAAC,CAAC;oBAE5F,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,MAAM,IAAI,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;gBAC7C,MAAM,cAAc,GAAG;oBACrB,GAAG,IAAI;oBACP,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;oBACpE,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;iBACvF,CAAC;gBACF,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,cAAc,EAAE;oBAC/D,OAAO;oBACP,OAAO;iBACR,CAAC,CAAC;gBAEH,IAAI,MAAM,GAAG,gBAAgB,CAAC;gBAC9B,KAAK,MAAM,WAAW,IAAI,kBAAkB,EAAE,CAAC;oBAC7C,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE;wBACjC,OAAO;wBACP,OAAO;qBACR,CAAC,CAAC;gBACL,CAAC;gBAGD,OAAO;oBACL,GAAI,MAAkC;oBACtC,WAAW,EAAE;wBACX,KAAK,EAAE,GAAG,CAAC,MAAM;wBACjB,SAAS,EAAE,GAAG,CAAC,SAAS;qBACzB;iBACF,CAAC;YACJ,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAE7C,MAAM,MAAM,GAA2D,EAAE,CAAC;YAC1E,IAAI,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;oBACtD,IAAI,GAAG,KAAK,cAAc,EAAE,CAAC;wBAC3B,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,GAAG,CAA0C,CAAC;wBACvF,IAAI,GAAG,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;4BAC/C,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gCACzC,IAAI,EAAE,MAAM,CAAC,GAAG;gCAChB,KAAK,EAAE,MAAM,CAAC,SAAS;6BACxB,CAAC,CAAC,CAAC;wBACN,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;YAED,IAAI,WAA+C,CAAC;YACpD,IAAI,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,CAAC;gBAC7C,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,YAAqD,CAAC;gBACpG,IAAI,UAAU,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7D,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBACpC,WAAW,KAAK,EAAE,CAAC;wBACnB,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC;oBAC7C,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAGD,MAAM,KAAK,GACT,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,QAAQ;gBAC1C,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK;gBAC1B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,IAAI,CAAC,CAAC;YAE3C,MAAM,MAAM,GAAG;gBACb,KAAK;gBACL,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI;gBAC9B,QAAQ;gBACR,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;gBAC3D,WAAW;aACZ,CAAC;YAEF,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,GAAG,GAAG,KAAc,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAElD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;QACpE,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,MAAM,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { SortOrder } from '@opensearch-project/opensearch/api/_types/_common.js';
|
|
2
|
+
import type { Search_RequestBody } from '@opensearch-project/opensearch/api/index.js';
|
|
3
|
+
type Aggregations = Required<Search_RequestBody>['aggs'];
|
|
4
|
+
type BoundingBox = {
|
|
5
|
+
topRight: {
|
|
6
|
+
lat: number;
|
|
7
|
+
lng: number;
|
|
8
|
+
};
|
|
9
|
+
bottomLeft: {
|
|
10
|
+
lat: number;
|
|
11
|
+
lng: number;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
export type QueryBuilderOptions = {
|
|
15
|
+
aggregations?: Aggregations;
|
|
16
|
+
};
|
|
17
|
+
export declare class OpensearchQueryBuilder {
|
|
18
|
+
aggregations: Aggregations;
|
|
19
|
+
constructor(opts?: QueryBuilderOptions);
|
|
20
|
+
buildQuery(searchType: string, query: string, filters?: Record<string, string[]>, boundingBox?: BoundingBox): {
|
|
21
|
+
bool: {
|
|
22
|
+
must: import("@opensearch-project/opensearch/api/_types/_common.query_dsl.js").QueryContainer[];
|
|
23
|
+
filter: import("@opensearch-project/opensearch/api/_types/_common.query_dsl.js").QueryContainer[];
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
buildAggregations(geohashPrecision: number, boundingBox?: BoundingBox): {
|
|
27
|
+
[x: string]: import("@opensearch-project/opensearch/api/_types/_common.aggregations.js").AggregationContainer;
|
|
28
|
+
};
|
|
29
|
+
buildSort(sort: string, order: SortOrder): {
|
|
30
|
+
'name.keyword': SortOrder;
|
|
31
|
+
}[] | {
|
|
32
|
+
[x: string]: SortOrder;
|
|
33
|
+
}[] | undefined;
|
|
34
|
+
}
|
|
35
|
+
export {};
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
export class OpensearchQueryBuilder {
|
|
2
|
+
aggregations;
|
|
3
|
+
constructor(opts) {
|
|
4
|
+
this.aggregations =
|
|
5
|
+
opts?.aggregations ||
|
|
6
|
+
Object.fromEntries(['inLanguage', 'mediaType', 'communicationMode', 'entityType'].map((name) => [
|
|
7
|
+
name,
|
|
8
|
+
{ terms: { field: `${name}.keyword`, size: 20 } },
|
|
9
|
+
]));
|
|
10
|
+
}
|
|
11
|
+
buildQuery(searchType, query, filters, boundingBox) {
|
|
12
|
+
const must = [];
|
|
13
|
+
const filter = [];
|
|
14
|
+
if (searchType === 'basic') {
|
|
15
|
+
must.push({
|
|
16
|
+
multi_match: {
|
|
17
|
+
query,
|
|
18
|
+
fields: ['name^2', 'description'],
|
|
19
|
+
type: 'best_fields',
|
|
20
|
+
fuzziness: 'AUTO',
|
|
21
|
+
zero_terms_query: 'all',
|
|
22
|
+
},
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
else {
|
|
26
|
+
must.push({
|
|
27
|
+
query_string: {
|
|
28
|
+
query,
|
|
29
|
+
fields: ['name^2', 'description'],
|
|
30
|
+
default_operator: 'AND',
|
|
31
|
+
},
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
if (filters) {
|
|
35
|
+
Object.entries(filters).forEach(([field, values]) => {
|
|
36
|
+
filter.push({
|
|
37
|
+
terms: {
|
|
38
|
+
[field]: values,
|
|
39
|
+
},
|
|
40
|
+
});
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
if (boundingBox) {
|
|
44
|
+
filter.push({
|
|
45
|
+
geo_bounding_box: {
|
|
46
|
+
location: {
|
|
47
|
+
top_left: {
|
|
48
|
+
lat: boundingBox.topRight.lat,
|
|
49
|
+
lon: boundingBox.bottomLeft.lng,
|
|
50
|
+
},
|
|
51
|
+
bottom_right: {
|
|
52
|
+
lat: boundingBox.bottomLeft.lat,
|
|
53
|
+
lon: boundingBox.topRight.lng,
|
|
54
|
+
},
|
|
55
|
+
},
|
|
56
|
+
},
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
bool: {
|
|
61
|
+
must,
|
|
62
|
+
filter,
|
|
63
|
+
},
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
buildAggregations(geohashPrecision, boundingBox) {
|
|
67
|
+
const aggs = { ...this.aggregations };
|
|
68
|
+
if (geohashPrecision && boundingBox) {
|
|
69
|
+
aggs.geohash_grid = {
|
|
70
|
+
geohash_grid: {
|
|
71
|
+
field: 'location',
|
|
72
|
+
precision: geohashPrecision,
|
|
73
|
+
bounds: {
|
|
74
|
+
top_left: {
|
|
75
|
+
lat: boundingBox.topRight.lat,
|
|
76
|
+
lon: boundingBox.bottomLeft.lng,
|
|
77
|
+
},
|
|
78
|
+
bottom_right: {
|
|
79
|
+
lat: boundingBox.bottomLeft.lat,
|
|
80
|
+
lon: boundingBox.topRight.lng,
|
|
81
|
+
},
|
|
82
|
+
},
|
|
83
|
+
},
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
return aggs;
|
|
87
|
+
}
|
|
88
|
+
buildSort(sort, order) {
|
|
89
|
+
if (sort === 'relevance') {
|
|
90
|
+
return;
|
|
91
|
+
}
|
|
92
|
+
const sortField = sort === 'id' ? 'rocrateId' : sort;
|
|
93
|
+
if (sortField === 'name') {
|
|
94
|
+
return [{ 'name.keyword': order }];
|
|
95
|
+
}
|
|
96
|
+
return [{ [sortField]: order }];
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
//# sourceMappingURL=queryBuilder.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryBuilder.js","sourceRoot":"","sources":["../../src/utils/queryBuilder.ts"],"names":[],"mappings":"AAqBA,MAAM,OAAO,sBAAsB;IACjC,YAAY,CAAe;IAE3B,YAAY,IAA0B;QACpC,IAAI,CAAC,YAAY;YACf,IAAI,EAAE,YAAY;gBAClB,MAAM,CAAC,WAAW,CAChB,CAAC,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;oBAC3E,IAAI;oBACJ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;iBAClD,CAAC,CACH,CAAC;IACN,CAAC;IAED,UAAU,CAAC,UAAkB,EAAE,KAAa,EAAE,OAAkC,EAAE,WAAyB;QACzG,MAAM,IAAI,GAAsB,EAAE,CAAC;QACnC,MAAM,MAAM,GAAwB,EAAE,CAAC;QAEvC,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC;gBACR,WAAW,EAAE;oBACX,KAAK;oBACL,MAAM,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC;oBACjC,IAAI,EAAE,aAAa;oBACnB,SAAS,EAAE,MAAM;oBACjB,gBAAgB,EAAE,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC;gBACR,YAAY,EAAE;oBACZ,KAAK;oBACL,MAAM,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC;oBACjC,gBAAgB,EAAE,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE;gBAClD,MAAM,CAAC,IAAI,CAAC;oBACV,KAAK,EAAE;wBACL,CAAC,KAAK,CAAC,EAAE,MAAM;qBAChB;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC;gBACV,gBAAgB,EAAE;oBAChB,QAAQ,EAAE;wBACR,QAAQ,EAAE;4BACR,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;4BAC7B,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;yBAChC;wBACD,YAAY,EAAE;4BACZ,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;4BAC/B,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;yBAC9B;qBACF;iBACF;aACF,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,IAAI,EAAE;gBACJ,IAAI;gBACJ,MAAM;aACP;SACF,CAAC;IACJ,CAAC;IAED,iBAAiB,CAAC,gBAAwB,EAAE,WAAyB;QACnE,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAGtC,IAAI,gBAAgB,IAAI,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,YAAY,GAAG;gBAClB,YAAY,EAAE;oBACZ,KAAK,EAAE,UAAU;oBACjB,SAAS,EAAE,gBAAgB;oBAC3B,MAAM,EAAE;wBACN,QAAQ,EAAE;4BACR,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;4BAC7B,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;yBAChC;wBACD,YAAY,EAAE;4BACZ,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;4BAC/B,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;yBAC9B;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,KAAgB;QACtC,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;QAErD,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;YACzB,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAClC,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"type": "module",
|
|
3
3
|
"name": "arocapi",
|
|
4
|
-
"version": "2.0
|
|
4
|
+
"version": "2.1.0",
|
|
5
5
|
"description": "An RO-Crate API",
|
|
6
6
|
"main": "dist/app.js",
|
|
7
7
|
"exports": {
|
|
@@ -28,6 +28,8 @@
|
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@biomejs/biome": "^2.3.8",
|
|
31
|
+
"@commitlint/cli": "^20.5.0",
|
|
32
|
+
"@commitlint/config-conventional": "^20.5.0",
|
|
31
33
|
"@prisma/client": "^6.19.0",
|
|
32
34
|
"@semantic-release/changelog": "^6.0.3",
|
|
33
35
|
"@semantic-release/git": "^10.0.1",
|
|
@@ -40,6 +42,7 @@
|
|
|
40
42
|
"conventional-changelog-conventionalcommits": "^9.1.0",
|
|
41
43
|
"fastify-tsconfig": "^3.0.0",
|
|
42
44
|
"knip": "^5.71.0",
|
|
45
|
+
"lefthook": "^2.1.4",
|
|
43
46
|
"prisma": "^6.19.0",
|
|
44
47
|
"prisma-json-types-generator": "^3.6.2",
|
|
45
48
|
"semantic-release": "^25.0.2",
|
package/src/app.ts
CHANGED
|
@@ -19,6 +19,8 @@ import type {
|
|
|
19
19
|
FileTransformer,
|
|
20
20
|
} from './types/transformers.js';
|
|
21
21
|
import { createValidationError } from './utils/errors.js';
|
|
22
|
+
import type { QueryBuilderOptions } from './utils/queryBuilder.js';
|
|
23
|
+
import { OpensearchQueryBuilder } from './utils/queryBuilder.js';
|
|
22
24
|
|
|
23
25
|
export type { AuthorisedEntity, AuthorisedFile, StandardEntity, StandardFile } from './transformers/default.js';
|
|
24
26
|
export { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from './transformers/default.js';
|
|
@@ -43,6 +45,8 @@ export type {
|
|
|
43
45
|
FileTransformer,
|
|
44
46
|
TransformerContext,
|
|
45
47
|
} from './types/transformers.js';
|
|
48
|
+
export { OpensearchQueryBuilder };
|
|
49
|
+
export type { QueryBuilderOptions };
|
|
46
50
|
|
|
47
51
|
declare module 'fastify' {
|
|
48
52
|
interface FastifyInstance {
|
|
@@ -97,6 +101,8 @@ const setupSearch = async (fastify: FastifyInstance, opensearch: Client) => {
|
|
|
97
101
|
export type Options = {
|
|
98
102
|
prisma: PrismaClient;
|
|
99
103
|
opensearch: Client;
|
|
104
|
+
queryBuilderClass?: typeof OpensearchQueryBuilder;
|
|
105
|
+
queryBuilderOptions?: QueryBuilderOptions;
|
|
100
106
|
disableCors?: boolean;
|
|
101
107
|
accessTransformer: AccessTransformer;
|
|
102
108
|
entityTransformers?: EntityTransformer[];
|
|
@@ -109,6 +115,8 @@ const app: FastifyPluginAsync<Options> = async (fastify, options) => {
|
|
|
109
115
|
const {
|
|
110
116
|
prisma,
|
|
111
117
|
opensearch,
|
|
118
|
+
queryBuilderClass,
|
|
119
|
+
queryBuilderOptions,
|
|
112
120
|
disableCors = false,
|
|
113
121
|
accessTransformer,
|
|
114
122
|
entityTransformers,
|
|
@@ -155,7 +163,7 @@ const app: FastifyPluginAsync<Options> = async (fastify, options) => {
|
|
|
155
163
|
fastify.register(files, { fileAccessTransformer, fileTransformers });
|
|
156
164
|
fastify.register(file, { fileHandler });
|
|
157
165
|
fastify.register(crate, { roCrateHandler });
|
|
158
|
-
fastify.register(search, { accessTransformer, entityTransformers });
|
|
166
|
+
fastify.register(search, { accessTransformer, entityTransformers, queryBuilderClass, queryBuilderOptions });
|
|
159
167
|
};
|
|
160
168
|
|
|
161
169
|
export default fp(app);
|
package/src/routes/search.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { MultiBucketAggregateBaseFiltersBucket } from '@opensearch-project/opensearch/api/_types/_common.aggregations.js';
|
|
2
|
-
import type {
|
|
3
|
-
import type { Search_Request, Search_RequestBody } from '@opensearch-project/opensearch/api/index.js';
|
|
2
|
+
import type { Search_Request } from '@opensearch-project/opensearch/api/index.js';
|
|
4
3
|
import type { FastifyPluginAsync } from 'fastify';
|
|
5
4
|
import type { ZodTypeProvider } from 'fastify-type-provider-zod';
|
|
6
5
|
import { z } from 'zod/v4';
|
|
7
6
|
import { baseEntityTransformer, resolveEntityReferences } from '../transformers/default.js';
|
|
8
7
|
import type { AccessTransformer, EntityTransformer } from '../types/transformers.js';
|
|
9
8
|
import { createInternalError } from '../utils/errors.js';
|
|
9
|
+
import { OpensearchQueryBuilder, type QueryBuilderOptions } from '../utils/queryBuilder.js';
|
|
10
10
|
|
|
11
11
|
const boundingBoxSchema = z.object({
|
|
12
12
|
topRight: z.object({
|
|
@@ -30,148 +30,22 @@ const searchParamsSchema = z.object({
|
|
|
30
30
|
sort: z.enum(['id', 'name', 'createdAt', 'updatedAt', 'relevance']).default('relevance'),
|
|
31
31
|
order: z.enum(['asc', 'desc']).default('asc'),
|
|
32
32
|
});
|
|
33
|
-
type SearchParams = z.infer<typeof searchParamsSchema>;
|
|
34
|
-
|
|
35
|
-
const buildQuery = (
|
|
36
|
-
searchType: SearchParams['searchType'],
|
|
37
|
-
query: SearchParams['query'],
|
|
38
|
-
filters: SearchParams['filters'],
|
|
39
|
-
boundingBox: SearchParams['boundingBox'],
|
|
40
|
-
) => {
|
|
41
|
-
const must: BoolQuery['must'] = [];
|
|
42
|
-
const filter: BoolQuery['filter'] = [];
|
|
43
|
-
|
|
44
|
-
if (searchType === 'basic') {
|
|
45
|
-
must.push({
|
|
46
|
-
multi_match: {
|
|
47
|
-
query,
|
|
48
|
-
fields: ['name^2', 'description'],
|
|
49
|
-
type: 'best_fields',
|
|
50
|
-
fuzziness: 'AUTO',
|
|
51
|
-
zero_terms_query: 'all',
|
|
52
|
-
},
|
|
53
|
-
});
|
|
54
|
-
} else {
|
|
55
|
-
must.push({
|
|
56
|
-
query_string: {
|
|
57
|
-
query,
|
|
58
|
-
fields: ['name^2', 'description'],
|
|
59
|
-
default_operator: 'AND',
|
|
60
|
-
},
|
|
61
|
-
});
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
if (filters) {
|
|
65
|
-
Object.entries(filters).forEach(([field, values]) => {
|
|
66
|
-
filter.push({
|
|
67
|
-
terms: {
|
|
68
|
-
[field]: values,
|
|
69
|
-
},
|
|
70
|
-
});
|
|
71
|
-
});
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
if (boundingBox) {
|
|
75
|
-
filter.push({
|
|
76
|
-
geo_bounding_box: {
|
|
77
|
-
location: {
|
|
78
|
-
top_left: {
|
|
79
|
-
lat: boundingBox.topRight.lat,
|
|
80
|
-
lon: boundingBox.bottomLeft.lng,
|
|
81
|
-
},
|
|
82
|
-
bottom_right: {
|
|
83
|
-
lat: boundingBox.bottomLeft.lat,
|
|
84
|
-
lon: boundingBox.topRight.lng,
|
|
85
|
-
},
|
|
86
|
-
},
|
|
87
|
-
},
|
|
88
|
-
});
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
return {
|
|
92
|
-
bool: {
|
|
93
|
-
must,
|
|
94
|
-
filter,
|
|
95
|
-
},
|
|
96
|
-
};
|
|
97
|
-
};
|
|
98
|
-
|
|
99
|
-
// TODO: Pull these from a config file
|
|
100
|
-
const buildAggregations = (
|
|
101
|
-
geohashPrecision: SearchParams['geohashPrecision'],
|
|
102
|
-
boundingBox: SearchParams['boundingBox'],
|
|
103
|
-
) => {
|
|
104
|
-
const aggs: Search_RequestBody['aggs'] = {
|
|
105
|
-
inLanguage: {
|
|
106
|
-
terms: {
|
|
107
|
-
field: 'inLanguage.keyword',
|
|
108
|
-
size: 20,
|
|
109
|
-
},
|
|
110
|
-
},
|
|
111
|
-
mediaType: {
|
|
112
|
-
terms: {
|
|
113
|
-
field: 'mediaType.keyword',
|
|
114
|
-
size: 20,
|
|
115
|
-
},
|
|
116
|
-
},
|
|
117
|
-
communicationMode: {
|
|
118
|
-
terms: {
|
|
119
|
-
field: 'communicationMode.keyword',
|
|
120
|
-
size: 20,
|
|
121
|
-
},
|
|
122
|
-
},
|
|
123
|
-
entityType: {
|
|
124
|
-
terms: {
|
|
125
|
-
field: 'entityType.keyword',
|
|
126
|
-
size: 20,
|
|
127
|
-
},
|
|
128
|
-
},
|
|
129
|
-
};
|
|
130
|
-
|
|
131
|
-
// Add geohash aggregation if precision is specified
|
|
132
|
-
if (geohashPrecision && boundingBox) {
|
|
133
|
-
aggs.geohash_grid = {
|
|
134
|
-
geohash_grid: {
|
|
135
|
-
field: 'location',
|
|
136
|
-
precision: geohashPrecision,
|
|
137
|
-
bounds: {
|
|
138
|
-
top_left: {
|
|
139
|
-
lat: boundingBox.topRight.lat,
|
|
140
|
-
lon: boundingBox.bottomLeft.lng,
|
|
141
|
-
},
|
|
142
|
-
bottom_right: {
|
|
143
|
-
lat: boundingBox.bottomLeft.lat,
|
|
144
|
-
lon: boundingBox.topRight.lng,
|
|
145
|
-
},
|
|
146
|
-
},
|
|
147
|
-
},
|
|
148
|
-
};
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
return aggs;
|
|
152
|
-
};
|
|
153
|
-
|
|
154
|
-
const buildSort = (sort: SearchParams['sort'], order: SearchParams['order']) => {
|
|
155
|
-
if (sort === 'relevance') {
|
|
156
|
-
return;
|
|
157
|
-
}
|
|
158
|
-
|
|
159
|
-
const sortField = sort === 'id' ? 'rocrateId' : sort;
|
|
160
|
-
|
|
161
|
-
if (sortField === 'name') {
|
|
162
|
-
return [{ 'name.keyword': order }];
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
return [{ [sortField]: order }];
|
|
166
|
-
};
|
|
167
33
|
|
|
168
34
|
type SearchRouteOptions = {
|
|
169
35
|
accessTransformer: AccessTransformer;
|
|
170
36
|
entityTransformers?: EntityTransformer[];
|
|
37
|
+
queryBuilderClass?: typeof OpensearchQueryBuilder;
|
|
38
|
+
queryBuilderOptions?: QueryBuilderOptions;
|
|
171
39
|
};
|
|
172
40
|
|
|
173
41
|
const search: FastifyPluginAsync<SearchRouteOptions> = async (fastify, opts) => {
|
|
174
|
-
const {
|
|
42
|
+
const {
|
|
43
|
+
accessTransformer,
|
|
44
|
+
entityTransformers = [],
|
|
45
|
+
queryBuilderClass = OpensearchQueryBuilder,
|
|
46
|
+
queryBuilderOptions,
|
|
47
|
+
} = opts;
|
|
48
|
+
const queryBuilder = new queryBuilderClass(queryBuilderOptions);
|
|
175
49
|
fastify.withTypeProvider<ZodTypeProvider>().post(
|
|
176
50
|
'/search',
|
|
177
51
|
{
|
|
@@ -186,20 +60,20 @@ const search: FastifyPluginAsync<SearchRouteOptions> = async (fastify, opts) =>
|
|
|
186
60
|
const opensearchQuery: Search_Request = {
|
|
187
61
|
index: 'entities',
|
|
188
62
|
body: {
|
|
189
|
-
query: buildQuery(searchType, query, filters, boundingBox),
|
|
190
|
-
aggs: buildAggregations(geohashPrecision, boundingBox),
|
|
63
|
+
query: queryBuilder.buildQuery(searchType, query, filters, boundingBox),
|
|
64
|
+
aggs: queryBuilder.buildAggregations(geohashPrecision, boundingBox),
|
|
191
65
|
highlight: {
|
|
192
66
|
fields: {
|
|
193
67
|
name: {},
|
|
194
68
|
description: {},
|
|
195
69
|
},
|
|
196
70
|
},
|
|
197
|
-
sort: buildSort(sort, order),
|
|
71
|
+
sort: queryBuilder.buildSort(sort, order),
|
|
198
72
|
from: offset,
|
|
199
73
|
size: limit,
|
|
200
74
|
},
|
|
201
75
|
};
|
|
202
|
-
|
|
76
|
+
fastify.log.debug(opensearchQuery);
|
|
203
77
|
const response = await fastify.opensearch.search(opensearchQuery);
|
|
204
78
|
|
|
205
79
|
if (!response.body?.hits?.hits) {
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import type { SortOrder } from '@opensearch-project/opensearch/api/_types/_common.js';
|
|
2
|
+
import type { BoolQuery } from '@opensearch-project/opensearch/api/_types/_common.query_dsl.js';
|
|
3
|
+
import type { Search_RequestBody } from '@opensearch-project/opensearch/api/index.js';
|
|
4
|
+
|
|
5
|
+
type Aggregations = Required<Search_RequestBody>['aggs'];
|
|
6
|
+
|
|
7
|
+
type BoundingBox = {
|
|
8
|
+
topRight: {
|
|
9
|
+
lat: number;
|
|
10
|
+
lng: number;
|
|
11
|
+
};
|
|
12
|
+
bottomLeft: {
|
|
13
|
+
lat: number;
|
|
14
|
+
lng: number;
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
export type QueryBuilderOptions = {
|
|
19
|
+
aggregations?: Aggregations;
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
export class OpensearchQueryBuilder {
|
|
23
|
+
aggregations: Aggregations;
|
|
24
|
+
|
|
25
|
+
constructor(opts?: QueryBuilderOptions) {
|
|
26
|
+
this.aggregations =
|
|
27
|
+
opts?.aggregations ||
|
|
28
|
+
Object.fromEntries(
|
|
29
|
+
['inLanguage', 'mediaType', 'communicationMode', 'entityType'].map((name) => [
|
|
30
|
+
name,
|
|
31
|
+
{ terms: { field: `${name}.keyword`, size: 20 } },
|
|
32
|
+
]),
|
|
33
|
+
);
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
buildQuery(searchType: string, query: string, filters?: Record<string, string[]>, boundingBox?: BoundingBox) {
|
|
37
|
+
const must: BoolQuery['must'] = [];
|
|
38
|
+
const filter: BoolQuery['filter'] = [];
|
|
39
|
+
|
|
40
|
+
if (searchType === 'basic') {
|
|
41
|
+
must.push({
|
|
42
|
+
multi_match: {
|
|
43
|
+
query,
|
|
44
|
+
fields: ['name^2', 'description'],
|
|
45
|
+
type: 'best_fields',
|
|
46
|
+
fuzziness: 'AUTO',
|
|
47
|
+
zero_terms_query: 'all',
|
|
48
|
+
},
|
|
49
|
+
});
|
|
50
|
+
} else {
|
|
51
|
+
must.push({
|
|
52
|
+
query_string: {
|
|
53
|
+
query,
|
|
54
|
+
fields: ['name^2', 'description'],
|
|
55
|
+
default_operator: 'AND',
|
|
56
|
+
},
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
if (filters) {
|
|
61
|
+
Object.entries(filters).forEach(([field, values]) => {
|
|
62
|
+
filter.push({
|
|
63
|
+
terms: {
|
|
64
|
+
[field]: values,
|
|
65
|
+
},
|
|
66
|
+
});
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
if (boundingBox) {
|
|
71
|
+
filter.push({
|
|
72
|
+
geo_bounding_box: {
|
|
73
|
+
location: {
|
|
74
|
+
top_left: {
|
|
75
|
+
lat: boundingBox.topRight.lat,
|
|
76
|
+
lon: boundingBox.bottomLeft.lng,
|
|
77
|
+
},
|
|
78
|
+
bottom_right: {
|
|
79
|
+
lat: boundingBox.bottomLeft.lat,
|
|
80
|
+
lon: boundingBox.topRight.lng,
|
|
81
|
+
},
|
|
82
|
+
},
|
|
83
|
+
},
|
|
84
|
+
});
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
return {
|
|
88
|
+
bool: {
|
|
89
|
+
must,
|
|
90
|
+
filter,
|
|
91
|
+
},
|
|
92
|
+
};
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
buildAggregations(geohashPrecision: number, boundingBox?: BoundingBox) {
|
|
96
|
+
const aggs = { ...this.aggregations };
|
|
97
|
+
|
|
98
|
+
// Add geohash aggregation if precision is specified
|
|
99
|
+
if (geohashPrecision && boundingBox) {
|
|
100
|
+
aggs.geohash_grid = {
|
|
101
|
+
geohash_grid: {
|
|
102
|
+
field: 'location',
|
|
103
|
+
precision: geohashPrecision,
|
|
104
|
+
bounds: {
|
|
105
|
+
top_left: {
|
|
106
|
+
lat: boundingBox.topRight.lat,
|
|
107
|
+
lon: boundingBox.bottomLeft.lng,
|
|
108
|
+
},
|
|
109
|
+
bottom_right: {
|
|
110
|
+
lat: boundingBox.bottomLeft.lat,
|
|
111
|
+
lon: boundingBox.topRight.lng,
|
|
112
|
+
},
|
|
113
|
+
},
|
|
114
|
+
},
|
|
115
|
+
};
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
return aggs;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
buildSort(sort: string, order: SortOrder) {
|
|
122
|
+
if (sort === 'relevance') {
|
|
123
|
+
return;
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
const sortField = sort === 'id' ? 'rocrateId' : sort;
|
|
127
|
+
|
|
128
|
+
if (sortField === 'name') {
|
|
129
|
+
return [{ 'name.keyword': order }];
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
return [{ [sortField]: order }];
|
|
133
|
+
}
|
|
134
|
+
}
|