arocapi 4.0.1 → 5.0.0-beta.10
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 +37 -781
- package/dist/app.d.ts +38 -21
- package/dist/app.js +63 -45
- package/dist/app.js.map +1 -1
- package/dist/routes/capabilities.d.ts +7 -0
- package/dist/routes/capabilities.js +13 -0
- package/dist/routes/capabilities.js.map +1 -0
- package/dist/routes/entities.d.ts +5 -2
- package/dist/routes/entities.js +38 -58
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/entity.d.ts +7 -2
- package/dist/routes/entity.js +14 -30
- package/dist/routes/entity.js.map +1 -1
- package/dist/routes/file.d.ts +8 -2
- package/dist/routes/file.js +38 -73
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/files.d.ts +5 -2
- package/dist/routes/files.js +25 -40
- package/dist/routes/files.js.map +1 -1
- package/dist/routes/metadata.d.ts +15 -0
- package/dist/routes/metadata.js +38 -0
- package/dist/routes/metadata.js.map +1 -0
- package/dist/routes/search.d.ts +8 -7
- package/dist/routes/search.js +91 -120
- 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/storage/backend.d.ts +58 -0
- package/dist/storage/backend.js +2 -0
- package/dist/storage/backend.js.map +1 -0
- package/dist/storage/deliver.d.ts +12 -0
- package/dist/storage/deliver.js +34 -0
- package/dist/storage/deliver.js.map +1 -0
- package/dist/storage/directory/directory.d.ts +6 -0
- package/dist/storage/directory/directory.js +24 -0
- package/dist/storage/directory/directory.js.map +1 -0
- package/dist/storage/entity-meta/entity-meta.d.ts +5 -0
- package/dist/storage/entity-meta/entity-meta.js +14 -0
- package/dist/storage/entity-meta/entity-meta.js.map +1 -0
- package/dist/storage/location.d.ts +19 -0
- package/dist/storage/location.js +36 -0
- package/dist/storage/location.js.map +1 -0
- package/dist/storage/ocfl/ocfl.d.ts +6 -0
- package/dist/storage/ocfl/ocfl.js +45 -0
- package/dist/storage/ocfl/ocfl.js.map +1 -0
- package/dist/storage/results.d.ts +7 -0
- package/dist/storage/results.js +22 -0
- package/dist/storage/results.js.map +1 -0
- package/dist/storage/s3/s3.d.ts +10 -0
- package/dist/storage/s3/s3.js +47 -0
- package/dist/storage/s3/s3.js.map +1 -0
- package/dist/transformers/default.d.ts +11 -22
- package/dist/transformers/default.js +41 -15
- package/dist/transformers/default.js.map +1 -1
- package/dist/types/access.d.ts +9 -0
- package/dist/types/access.js +2 -0
- package/dist/types/access.js.map +1 -0
- package/dist/types/context.d.ts +6 -0
- package/dist/types/context.js +2 -0
- package/dist/types/context.js.map +1 -0
- package/dist/types/transformers.d.ts +4 -10
- package/dist/types/visibility.d.ts +6 -0
- package/dist/types/visibility.js +2 -0
- package/dist/types/visibility.js.map +1 -0
- package/dist/utils/access.d.ts +17 -0
- package/dist/utils/access.js +41 -0
- package/dist/utils/access.js.map +1 -0
- package/dist/utils/errors.d.ts +19 -10
- package/dist/utils/errors.js +44 -8
- package/dist/utils/errors.js.map +1 -1
- package/dist/utils/headers.d.ts +1 -1
- package/dist/utils/headers.js +10 -1
- package/dist/utils/headers.js.map +1 -1
- package/dist/utils/validation.d.ts +2 -0
- package/dist/utils/validation.js +8 -0
- package/dist/utils/validation.js.map +1 -0
- package/dist/utils/visibility.d.ts +18 -0
- package/dist/utils/visibility.js +16 -0
- package/dist/utils/visibility.js.map +1 -0
- package/package.json +84 -45
- 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 +169 -102
- package/src/routes/capabilities.ts +22 -0
- package/src/routes/entities.ts +49 -68
- package/src/routes/entity.ts +22 -36
- package/src/routes/file.ts +54 -104
- package/src/routes/files.ts +32 -48
- package/src/routes/metadata.ts +67 -0
- package/src/routes/search.ts +132 -152
- 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/storage/backend.ts +75 -0
- package/src/storage/deliver.ts +65 -0
- package/src/storage/directory/directory.ts +39 -0
- package/src/storage/entity-meta/entity-meta.ts +25 -0
- package/src/storage/location.ts +78 -0
- package/src/storage/ocfl/ocfl.ts +71 -0
- package/src/storage/results.ts +32 -0
- package/src/storage/s3/s3.ts +79 -0
- package/src/transformers/default.ts +115 -85
- package/src/types/access.ts +25 -0
- package/src/types/context.ts +15 -0
- package/src/types/transformers.ts +8 -34
- package/src/types/visibility.ts +21 -0
- package/src/utils/access.ts +80 -0
- package/src/utils/errors.ts +68 -11
- package/src/utils/headers.ts +22 -2
- package/src/utils/validation.ts +11 -0
- package/src/utils/visibility.ts +56 -0
- package/dist/app.test.d.ts +0 -1
- package/dist/app.test.js +0 -89
- package/dist/app.test.js.map +0 -1
- package/dist/express.d.ts +0 -4
- package/dist/express.js +0 -14
- package/dist/express.js.map +0 -1
- package/dist/index.dev.d.ts +0 -1
- package/dist/index.dev.js +0 -156
- package/dist/index.dev.js.map +0 -1
- package/dist/routes/crate.d.ts +0 -9
- package/dist/routes/crate.js +0 -82
- package/dist/routes/crate.js.map +0 -1
- package/dist/routes/crate.test.d.ts +0 -1
- package/dist/routes/crate.test.js +0 -342
- 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 -273
- 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 -130
- 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 -315
- 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 -222
- 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 -780
- 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 -18
- package/dist/test/helpers/fastify.js.map +0 -1
- package/dist/test/integration.setup.d.ts +0 -29
- package/dist/test/integration.setup.js +0 -188
- 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 -396
- 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 -163
- 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 -187
- package/dist/transformers/transformer.test.js.map +0 -1
- package/dist/types/fileHandlers.d.ts +0 -41
- package/dist/types/fileHandlers.js +0 -2
- package/dist/types/fileHandlers.js.map +0 -1
- package/dist/utils/errors.test.d.ts +0 -1
- package/dist/utils/errors.test.js +0 -66
- package/dist/utils/errors.test.js.map +0 -1
- package/dist/utils/queryBuilder.d.ts +0 -35
- package/dist/utils/queryBuilder.js +0 -98
- package/dist/utils/queryBuilder.js.map +0 -1
- package/prisma.config.ts +0 -9
- package/src/app.test.ts +0 -119
- package/src/express.ts +0 -21
- package/src/index.dev.ts +0 -200
- package/src/reset.d.ts +0 -1
- 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/crate.test.ts +0 -423
- package/src/routes/crate.ts +0 -123
- package/src/routes/entities.test.ts +0 -320
- package/src/routes/entity.test.ts +0 -160
- package/src/routes/file.test.ts +0 -395
- package/src/routes/files.test.ts +0 -278
- package/src/routes/search.test.ts +0 -903
- package/src/test/__snapshots__/integration.test.ts.snap +0 -18
- package/src/test/helpers/fastify.ts +0 -27
- package/src/test/integration.setup.ts +0 -210
- package/src/test/integration.test.ts +0 -482
- package/src/transformers/default.test.ts +0 -184
- package/src/transformers/transformer.test.ts +0 -252
- package/src/types/fileHandlers.ts +0 -65
- package/src/utils/errors.test.ts +0 -75
- package/src/utils/queryBuilder.ts +0 -132
package/dist/routes/file.js
CHANGED
|
@@ -1,93 +1,58 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { z } from 'zod
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
1
|
+
import { create as contentDisposition } from 'content-disposition';
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
import { sendDelivery } from '../storage/deliver.js';
|
|
4
|
+
import { createAccessGuard } from '../utils/access.js';
|
|
5
|
+
import { createNotFoundError } from '../utils/errors.js';
|
|
6
|
+
import { createNotVisibleResponder } from '../utils/visibility.js';
|
|
5
7
|
const paramsSchema = z.object({
|
|
6
8
|
id: z.url(),
|
|
7
9
|
});
|
|
8
10
|
const querySchema = z.object({
|
|
9
11
|
disposition: z.enum(['inline', 'attachment']).optional().default('inline'),
|
|
10
12
|
filename: z.string().optional(),
|
|
11
|
-
noRedirect: z
|
|
13
|
+
noRedirect: z
|
|
14
|
+
.enum(['true', 'false'])
|
|
15
|
+
.optional()
|
|
16
|
+
.default('false')
|
|
17
|
+
.transform((value) => value === 'true'),
|
|
12
18
|
});
|
|
13
19
|
const file = async (fastify, opts) => {
|
|
14
|
-
const { prisma,
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
const { id } = request.params;
|
|
21
|
-
try {
|
|
22
|
-
const file = await prisma.file.findUnique({
|
|
23
|
-
where: { id },
|
|
24
|
-
});
|
|
25
|
-
if (!file) {
|
|
26
|
-
return reply.code(404).send(createNotFoundError('The requested file was not found', id));
|
|
27
|
-
}
|
|
28
|
-
const metadata = await fileHandler.head(file, { request, fastify });
|
|
29
|
-
if (!metadata) {
|
|
30
|
-
return reply.code(404).send(createNotFoundError('The requested file metadata was not found', id));
|
|
31
|
-
}
|
|
32
|
-
setFileHeaders(reply, metadata);
|
|
33
|
-
return reply.code(200).send();
|
|
34
|
-
}
|
|
35
|
-
catch (error) {
|
|
36
|
-
const err = error;
|
|
37
|
-
fastify.log.error(`File metadata retrieval error: ${err.message}`);
|
|
38
|
-
return reply.code(500).send(createInternalError());
|
|
39
|
-
}
|
|
20
|
+
const { prisma, content, access, entityVisibilityFilter, refusal } = opts;
|
|
21
|
+
const denyContent = createAccessGuard({ access, isAuthenticated: refusal.isAuthenticated, level: 'content' });
|
|
22
|
+
const sendFileNotVisible = createNotVisibleResponder({
|
|
23
|
+
...refusal,
|
|
24
|
+
notFoundMessage: 'The requested file was not found',
|
|
25
|
+
exists: async (id) => (await prisma.file.count({ where: { id } })) > 0,
|
|
40
26
|
});
|
|
41
|
-
fastify.withTypeProvider().
|
|
27
|
+
fastify.withTypeProvider().route({
|
|
28
|
+
method: ['GET', 'HEAD'],
|
|
29
|
+
url: '/file/:id',
|
|
42
30
|
schema: {
|
|
43
31
|
params: paramsSchema,
|
|
44
32
|
querystring: querySchema,
|
|
45
33
|
},
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
const
|
|
50
|
-
where: { id },
|
|
34
|
+
handler: async (request, reply) => {
|
|
35
|
+
const { id } = request.params;
|
|
36
|
+
const context = { request, fastify };
|
|
37
|
+
const found = await prisma.file.findFirst({
|
|
38
|
+
where: { id, entity: await entityVisibilityFilter(context) },
|
|
39
|
+
include: { entity: true },
|
|
51
40
|
});
|
|
52
|
-
if (!
|
|
53
|
-
return reply
|
|
41
|
+
if (!found) {
|
|
42
|
+
return sendFileNotVisible(reply, id, context);
|
|
54
43
|
}
|
|
55
|
-
const
|
|
56
|
-
if (
|
|
57
|
-
return reply
|
|
58
|
-
}
|
|
59
|
-
if (result.type === 'redirect') {
|
|
60
|
-
if (request.query.noRedirect) {
|
|
61
|
-
return reply.code(200).send({ location: result.url });
|
|
62
|
-
}
|
|
63
|
-
return reply.code(302).redirect(result.url);
|
|
64
|
-
}
|
|
65
|
-
const { disposition, filename: customFilename } = request.query;
|
|
66
|
-
const filename = customFilename || file.filename;
|
|
67
|
-
setFileHeaders(reply, result.metadata);
|
|
68
|
-
reply.header('Content-Disposition', `${disposition}; filename="${filename}"`);
|
|
69
|
-
if (result.type === 'stream') {
|
|
70
|
-
return reply.code(200).send(result.stream);
|
|
44
|
+
const { entity, ...file } = found;
|
|
45
|
+
if (await denyContent(reply, entity, context)) {
|
|
46
|
+
return reply;
|
|
71
47
|
}
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
const stream = createReadStream(result.path);
|
|
78
|
-
return reply.code(200).send(stream);
|
|
48
|
+
const { disposition, filename, noRedirect } = request.query;
|
|
49
|
+
const disposed = contentDisposition(filename || file.filename, { type: disposition });
|
|
50
|
+
const delivery = await content(file, entity, { ...context, contentDisposition: disposed });
|
|
51
|
+
if (!delivery) {
|
|
52
|
+
return reply.code(404).send(createNotFoundError('The requested file could not be retrieved', id));
|
|
79
53
|
}
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
reply.removeHeader('Content-Type');
|
|
83
|
-
reply.removeHeader('Content-Length');
|
|
84
|
-
return reply.code(500).send(createInternalError());
|
|
85
|
-
}
|
|
86
|
-
catch (error) {
|
|
87
|
-
const err = error;
|
|
88
|
-
fastify.log.error(`File retrieval error: ${err}`);
|
|
89
|
-
return reply.code(500).send(createInternalError());
|
|
90
|
-
}
|
|
54
|
+
return sendDelivery(request, reply, delivery, { contentDisposition: disposed, noRedirect });
|
|
55
|
+
},
|
|
91
56
|
});
|
|
92
57
|
};
|
|
93
58
|
export default file;
|
package/dist/routes/file.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/routes/file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/routes/file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAGnE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAuB,MAAM,wBAAwB,CAAC;AAExF,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE;CACZ,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC1E,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC;SACV,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACvB,QAAQ,EAAE;SACV,OAAO,CAAC,OAAO,CAAC;SAChB,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC;CAC1C,CAAC,CAAC;AAUH,MAAM,IAAI,GAAyC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IACzE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAE1E,MAAM,WAAW,GAAG,iBAAiB,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAE9G,MAAM,kBAAkB,GAAG,yBAAyB,CAAC;QACnD,GAAG,OAAO;QACV,eAAe,EAAE,kCAAkC;QACnD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC;KACvE,CAAC,CAAC;IAEH,OAAO,CAAC,gBAAgB,EAAmB,CAAC,KAAK,CAAC;QAChD,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,GAAG,EAAE,WAAW;QAChB,MAAM,EAAE;YACN,MAAM,EAAE,YAAY;YACpB,WAAW,EAAE,WAAW;SACzB;QACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAChC,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;YAE9B,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;YACrC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBACxC,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC,OAAO,CAAC,EAAE;gBAC5D,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;aAC1B,CAAC,CAAC;YAEH,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,kBAAkB,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;YAClC,IAAI,MAAM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC9C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;YAC5D,MAAM,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;YACtF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC,CAAC;YAE3F,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,2CAA2C,EAAE,EAAE,CAAC,CAAC,CAAC;YACpG,CAAC;YAED,OAAO,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,kBAAkB,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9F,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
package/dist/routes/files.d.ts
CHANGED
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
2
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
3
|
-
import type {
|
|
3
|
+
import type { AccessFunction } from '../types/access.js';
|
|
4
|
+
import type { FileTransformer } from '../types/transformers.js';
|
|
5
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
4
6
|
type FilesRouteOptions = {
|
|
5
7
|
prisma: PrismaClient;
|
|
6
|
-
|
|
8
|
+
access: AccessFunction;
|
|
7
9
|
fileTransformers?: FileTransformer[];
|
|
10
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
8
11
|
};
|
|
9
12
|
declare const files: FastifyPluginAsync<FilesRouteOptions>;
|
|
10
13
|
export default files;
|
package/dist/routes/files.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import { z } from 'zod
|
|
2
|
-
import {
|
|
3
|
-
import { createInternalError } from '../utils/errors.js';
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { applyTransformers, authoriseFiles } from '../transformers/default.js';
|
|
4
3
|
const querySchema = z.object({
|
|
5
4
|
memberOf: z.url().optional(),
|
|
6
5
|
limit: z.coerce.number().int().min(1).max(1000).default(100),
|
|
@@ -9,48 +8,34 @@ const querySchema = z.object({
|
|
|
9
8
|
order: z.enum(['asc', 'desc']).default('asc'),
|
|
10
9
|
});
|
|
11
10
|
const files = async (fastify, opts) => {
|
|
12
|
-
const { prisma,
|
|
11
|
+
const { prisma, access, fileTransformers = [], entityVisibilityFilter } = opts;
|
|
13
12
|
fastify.withTypeProvider().get('/files', {
|
|
14
13
|
schema: {
|
|
15
14
|
querystring: querySchema,
|
|
16
15
|
},
|
|
17
|
-
}, async (request
|
|
16
|
+
}, async (request) => {
|
|
18
17
|
const { memberOf, limit, offset, sort, order } = request.query;
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
result = await transformer(result, { request, fastify });
|
|
41
|
-
}
|
|
42
|
-
return result;
|
|
43
|
-
}));
|
|
44
|
-
return {
|
|
45
|
-
total,
|
|
46
|
-
files: filesWithAccess,
|
|
47
|
-
};
|
|
48
|
-
}
|
|
49
|
-
catch (error) {
|
|
50
|
-
const err = error;
|
|
51
|
-
fastify.log.error(`Database error: ${err.message}`);
|
|
52
|
-
return reply.code(500).send(createInternalError());
|
|
53
|
-
}
|
|
18
|
+
const context = { request, fastify };
|
|
19
|
+
const visibilityWhere = await entityVisibilityFilter(context);
|
|
20
|
+
const where = { entity: { AND: [{ memberOf }, visibilityWhere] } };
|
|
21
|
+
const [dbFiles, total] = await Promise.all([
|
|
22
|
+
prisma.file.findMany({
|
|
23
|
+
where,
|
|
24
|
+
include: { entity: true },
|
|
25
|
+
orderBy: {
|
|
26
|
+
[sort]: order,
|
|
27
|
+
},
|
|
28
|
+
skip: offset,
|
|
29
|
+
take: limit,
|
|
30
|
+
}),
|
|
31
|
+
prisma.file.count({ where }),
|
|
32
|
+
]);
|
|
33
|
+
const authorisedFiles = await authoriseFiles(dbFiles, access, context);
|
|
34
|
+
const filesWithAccess = await Promise.all(authorisedFiles.map((file, i) => applyTransformers(file, fileTransformers, context, dbFiles[i])));
|
|
35
|
+
return {
|
|
36
|
+
total,
|
|
37
|
+
files: filesWithAccess,
|
|
38
|
+
};
|
|
54
39
|
});
|
|
55
40
|
};
|
|
56
41
|
export default files;
|
package/dist/routes/files.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/routes/files.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/routes/files.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAK/E,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3B,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;IAC5D,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACxE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;CAC9C,CAAC,CAAC;AASH,MAAM,KAAK,GAA0C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IAC3E,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,EAAE,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC;IAE/E,OAAO,CAAC,gBAAgB,EAAmB,CAAC,GAAG,CAC7C,QAAQ,EACR;QACE,MAAM,EAAE;YACN,WAAW,EAAE,WAAW;SACzB;KACF,EACD,KAAK,EAAE,OAAO,EAAE,EAAE;QAChB,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;QAE/D,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QACrC,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,KAAK,GAAG,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,eAAe,CAAC,EAAE,EAAE,CAAC;QAEnE,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACzC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACnB,KAAK;gBACL,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;gBACzB,OAAO,EAAE;oBACP,CAAC,IAAI,CAAC,EAAE,KAAK;iBACd;gBACD,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,KAAK;aACZ,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC;SAC7B,CAAC,CAAC;QAEH,MAAM,eAAe,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACvE,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,eAAe,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CACjG,CAAC;QAEF,OAAO;YACL,KAAK;YACL,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,KAAK,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { FastifyPluginAsync } from 'fastify';
|
|
2
|
+
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
3
|
+
import type { MetadataSource } from '../storage/backend.js';
|
|
4
|
+
import type { AccessFunction } from '../types/access.js';
|
|
5
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
6
|
+
import { type RefusalOptions } from '../utils/visibility.js';
|
|
7
|
+
type MetadataRouteOptions = {
|
|
8
|
+
prisma: PrismaClient;
|
|
9
|
+
metadata: MetadataSource;
|
|
10
|
+
access: AccessFunction;
|
|
11
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
12
|
+
refusal: RefusalOptions;
|
|
13
|
+
};
|
|
14
|
+
declare const metadataRoute: FastifyPluginAsync<MetadataRouteOptions>;
|
|
15
|
+
export default metadataRoute;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { sendDelivery } from '../storage/deliver.js';
|
|
3
|
+
import { createAccessGuard } from '../utils/access.js';
|
|
4
|
+
import { createNotFoundError } from '../utils/errors.js';
|
|
5
|
+
import { createEntityNotVisibleResponder } from '../utils/visibility.js';
|
|
6
|
+
const paramsSchema = z.object({
|
|
7
|
+
id: z.url(),
|
|
8
|
+
});
|
|
9
|
+
const metadataRoute = async (fastify, opts) => {
|
|
10
|
+
const { prisma, metadata, access, entityVisibilityFilter, refusal } = opts;
|
|
11
|
+
const sendEntityNotVisible = createEntityNotVisibleResponder(prisma, refusal);
|
|
12
|
+
const denyMetadata = createAccessGuard({ access, isAuthenticated: refusal.isAuthenticated, level: 'metadata' });
|
|
13
|
+
fastify.withTypeProvider().route({
|
|
14
|
+
method: ['GET', 'HEAD'],
|
|
15
|
+
url: '/entity/:id/metadata',
|
|
16
|
+
schema: {
|
|
17
|
+
params: paramsSchema,
|
|
18
|
+
},
|
|
19
|
+
handler: async (request, reply) => {
|
|
20
|
+
const { id } = request.params;
|
|
21
|
+
const context = { request, fastify };
|
|
22
|
+
const entity = await prisma.entity.findFirst({ where: { AND: [{ id }, await entityVisibilityFilter(context)] } });
|
|
23
|
+
if (!entity) {
|
|
24
|
+
return sendEntityNotVisible(reply, id, context);
|
|
25
|
+
}
|
|
26
|
+
if (await denyMetadata(reply, entity, context)) {
|
|
27
|
+
return reply;
|
|
28
|
+
}
|
|
29
|
+
const delivery = await metadata(entity, context);
|
|
30
|
+
if (!delivery) {
|
|
31
|
+
return reply.code(404).send(createNotFoundError('The requested Metadata was not found', id));
|
|
32
|
+
}
|
|
33
|
+
return sendDelivery(request, reply, delivery.type === 'redirect' ? delivery : { ...delivery, contentType: 'application/ld+json' }, { json: true });
|
|
34
|
+
},
|
|
35
|
+
});
|
|
36
|
+
};
|
|
37
|
+
export default metadataRoute;
|
|
38
|
+
//# sourceMappingURL=metadata.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/routes/metadata.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,+BAA+B,EAAuB,MAAM,wBAAwB,CAAC;AAE9F,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE;CACZ,CAAC,CAAC;AAUH,MAAM,aAAa,GAA6C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IACtF,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAE3E,MAAM,oBAAoB,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9E,MAAM,YAAY,GAAG,iBAAiB,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;IAEhH,OAAO,CAAC,gBAAgB,EAAmB,CAAC,KAAK,CAAC;QAChD,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,GAAG,EAAE,sBAAsB;QAC3B,MAAM,EAAE;YACN,MAAM,EAAE,YAAY;SACrB;QACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAChC,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;YAE9B,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAElH,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,oBAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YAClD,CAAC;YAED,IAAI,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC/C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEjD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,sCAAsC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC/F,CAAC;YAED,OAAO,YAAY,CACjB,OAAO,EACP,KAAK,EACL,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,WAAW,EAAE,qBAAqB,EAAE,EAC7F,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC"}
|
package/dist/routes/search.d.ts
CHANGED
|
@@ -1,15 +1,16 @@
|
|
|
1
|
-
import type { Client } from '@opensearch-project/opensearch';
|
|
2
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
3
2
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
4
|
-
import
|
|
5
|
-
import {
|
|
3
|
+
import { type SearchBackend } from '../search/backend.js';
|
|
4
|
+
import type { AccessFunction } from '../types/access.js';
|
|
5
|
+
import type { EntityTransformer } from '../types/transformers.js';
|
|
6
|
+
import type { EntityVisibilityFilter, SearchVisibilityFilter } from '../types/visibility.js';
|
|
6
7
|
type SearchRouteOptions = {
|
|
7
8
|
prisma: PrismaClient;
|
|
8
|
-
|
|
9
|
-
|
|
9
|
+
search: SearchBackend;
|
|
10
|
+
access: AccessFunction;
|
|
10
11
|
entityTransformers?: EntityTransformer[];
|
|
11
|
-
|
|
12
|
-
|
|
12
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
13
|
+
searchVisibilityFilter: SearchVisibilityFilter;
|
|
13
14
|
};
|
|
14
15
|
declare const search: FastifyPluginAsync<SearchRouteOptions>;
|
|
15
16
|
export default search;
|
package/dist/routes/search.js
CHANGED
|
@@ -1,143 +1,114 @@
|
|
|
1
|
-
import { z } from 'zod
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
lat: z.number(),
|
|
8
|
-
lng: z.number(),
|
|
9
|
-
}),
|
|
10
|
-
bottomLeft: z.object({
|
|
11
|
-
lat: z.number(),
|
|
12
|
-
lng: z.number(),
|
|
13
|
-
}),
|
|
14
|
-
});
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { normaliseQuery } from '../search/advanced.js';
|
|
3
|
+
import { SearchQueryError, } from '../search/backend.js';
|
|
4
|
+
import { boundingBoxSchema, filterValueSchema, geoViolations, splitFilters, } from '../search/requestFilters.js';
|
|
5
|
+
import { applyTransformers, authoriseEntities } from '../transformers/default.js';
|
|
6
|
+
import { createError, createValidationError, ERROR_CODES } from '../utils/errors.js';
|
|
15
7
|
const searchParamsSchema = z.object({
|
|
16
8
|
searchType: z.enum(['basic', 'advanced']).default('basic'),
|
|
17
9
|
query: z.string(),
|
|
18
|
-
filters: z.record(z.string(),
|
|
10
|
+
filters: z.record(z.string(), filterValueSchema).default({}),
|
|
19
11
|
boundingBox: boundingBoxSchema.optional(),
|
|
20
12
|
geohashPrecision: z.number().int().min(1).max(12).optional(),
|
|
21
13
|
limit: z.number().int().min(1).max(1000).default(100),
|
|
22
14
|
offset: z.number().int().min(0).default(0),
|
|
23
|
-
sort: z.
|
|
15
|
+
sort: z.string().default('relevance'),
|
|
24
16
|
order: z.enum(['asc', 'desc']).default('asc'),
|
|
25
17
|
});
|
|
18
|
+
const visibleExtra = (searchExtra, { metadata, content }) => {
|
|
19
|
+
if (!searchExtra || (metadata && content)) {
|
|
20
|
+
return searchExtra;
|
|
21
|
+
}
|
|
22
|
+
const { highlight: _, ...rest } = searchExtra;
|
|
23
|
+
return Object.keys(rest).length > 0 ? rest : undefined;
|
|
24
|
+
};
|
|
26
25
|
const search = async (fastify, opts) => {
|
|
27
|
-
const { prisma,
|
|
28
|
-
const
|
|
26
|
+
const { prisma, search: backend, access, entityTransformers = [], entityVisibilityFilter, searchVisibilityFilter, } = opts;
|
|
27
|
+
const { capabilities } = backend;
|
|
28
|
+
const noFacets = Object.fromEntries(Object.keys(capabilities.facets).map((name) => [name, []]));
|
|
29
|
+
const violations = ({ searchType, sort }) => {
|
|
30
|
+
const found = [];
|
|
31
|
+
if (!Object.hasOwn(capabilities.searchTypes, searchType)) {
|
|
32
|
+
found.push({ field: '/searchType', message: `${searchType} search isn't supported`, value: searchType });
|
|
33
|
+
}
|
|
34
|
+
if (sort !== 'relevance' && !Object.hasOwn(capabilities.sorts, sort)) {
|
|
35
|
+
found.push({ field: '/sort', message: `${sort} isn't a declared sort`, value: sort });
|
|
36
|
+
}
|
|
37
|
+
return found;
|
|
38
|
+
};
|
|
29
39
|
fastify.withTypeProvider().post('/search', {
|
|
30
40
|
schema: {
|
|
31
41
|
body: searchParamsSchema,
|
|
32
42
|
},
|
|
33
43
|
}, async (request, reply) => {
|
|
34
|
-
const {
|
|
44
|
+
const { filters, violations: filterProblems } = splitFilters(capabilities.filters, request.body.filters);
|
|
45
|
+
const problems = [
|
|
46
|
+
...violations(request.body),
|
|
47
|
+
...filterProblems,
|
|
48
|
+
...geoViolations(capabilities.geo, request.body),
|
|
49
|
+
];
|
|
50
|
+
if (problems.length > 0) {
|
|
51
|
+
return reply.code(400).send(createValidationError('The request parameters are invalid', problems));
|
|
52
|
+
}
|
|
53
|
+
const { searchType, query, filters: _, boundingBox, geohashPrecision, ...paging } = request.body;
|
|
54
|
+
const searchQuery = normaliseQuery(searchType, query, capabilities.searchTypes.advanced?.fields ?? {});
|
|
55
|
+
if ('problem' in searchQuery) {
|
|
56
|
+
const { problem } = searchQuery;
|
|
57
|
+
return reply.code(422).send(createValidationError(problem, [{ field: 'query', message: problem }]));
|
|
58
|
+
}
|
|
59
|
+
const context = { request, fastify };
|
|
60
|
+
const visibilityWhere = Promise.resolve(entityVisibilityFilter(context));
|
|
61
|
+
visibilityWhere.catch(() => undefined);
|
|
62
|
+
const visibility = await searchVisibilityFilter(context);
|
|
63
|
+
const searchRequest = {
|
|
64
|
+
...searchQuery,
|
|
65
|
+
filters,
|
|
66
|
+
...(boundingBox && { boundingBox }),
|
|
67
|
+
...(geohashPrecision !== undefined && { geohashPrecision }),
|
|
68
|
+
...paging,
|
|
69
|
+
visibility,
|
|
70
|
+
};
|
|
71
|
+
const start = performance.now();
|
|
72
|
+
let result;
|
|
35
73
|
try {
|
|
36
|
-
|
|
37
|
-
index: 'entities',
|
|
38
|
-
body: {
|
|
39
|
-
query: queryBuilder.buildQuery(searchType, query, filters, boundingBox),
|
|
40
|
-
aggs: queryBuilder.buildAggregations(geohashPrecision, boundingBox),
|
|
41
|
-
highlight: {
|
|
42
|
-
fields: {
|
|
43
|
-
name: {},
|
|
44
|
-
description: {},
|
|
45
|
-
},
|
|
46
|
-
},
|
|
47
|
-
sort: queryBuilder.buildSort(sort, order),
|
|
48
|
-
from: offset,
|
|
49
|
-
size: limit,
|
|
50
|
-
},
|
|
51
|
-
};
|
|
52
|
-
fastify.log.debug(opensearchQuery);
|
|
53
|
-
const response = await opensearch.search(opensearchQuery);
|
|
54
|
-
if (!response.body?.hits?.hits) {
|
|
55
|
-
throw new Error('Invalid search response: missing hits data');
|
|
56
|
-
}
|
|
57
|
-
const entityIds = response.body.hits.hits.map((hit) => hit._source?.id).filter(Boolean);
|
|
58
|
-
const dbEntities = await prisma.entity.findMany({
|
|
59
|
-
where: {
|
|
60
|
-
id: {
|
|
61
|
-
in: entityIds,
|
|
62
|
-
},
|
|
63
|
-
},
|
|
64
|
-
include: { file: { select: { id: true } } },
|
|
65
|
-
});
|
|
66
|
-
const entityMap = new Map(dbEntities.map((entity) => [entity.id, entity]));
|
|
67
|
-
const refMap = await resolveEntityReferences(dbEntities, prisma);
|
|
68
|
-
const entities = await Promise.all(response.body.hits.hits.map(async (hit) => {
|
|
69
|
-
if (!hit._source?.id) {
|
|
70
|
-
throw new Error('Missing id in search hit');
|
|
71
|
-
}
|
|
72
|
-
const dbEntity = entityMap.get(hit._source.id);
|
|
73
|
-
if (!dbEntity) {
|
|
74
|
-
fastify.log.warn(`Entity ${hit._source.id} found in OpenSearch but not in database`);
|
|
75
|
-
return null;
|
|
76
|
-
}
|
|
77
|
-
const base = baseEntityTransformer(dbEntity);
|
|
78
|
-
const standardEntity = {
|
|
79
|
-
...base,
|
|
80
|
-
memberOf: base.memberOf ? (refMap.get(base.memberOf) ?? null) : null,
|
|
81
|
-
rootCollection: base.rootCollection ? (refMap.get(base.rootCollection) ?? null) : null,
|
|
82
|
-
};
|
|
83
|
-
const authorisedEntity = await accessTransformer(standardEntity, { request, fastify });
|
|
84
|
-
let result = authorisedEntity;
|
|
85
|
-
for (const transformer of entityTransformers) {
|
|
86
|
-
result = await transformer(result, { request, fastify });
|
|
87
|
-
}
|
|
88
|
-
return {
|
|
89
|
-
...result,
|
|
90
|
-
searchExtra: {
|
|
91
|
-
score: hit._score,
|
|
92
|
-
highlight: hit.highlight,
|
|
93
|
-
},
|
|
94
|
-
};
|
|
95
|
-
})).then((results) => results.filter(Boolean));
|
|
96
|
-
const facets = {};
|
|
97
|
-
if (response.body.aggregations) {
|
|
98
|
-
Object.keys(response.body.aggregations).forEach((key) => {
|
|
99
|
-
if (key !== 'geohash_grid') {
|
|
100
|
-
const agg = response.body.aggregations?.[key];
|
|
101
|
-
if (agg?.buckets && Array.isArray(agg.buckets)) {
|
|
102
|
-
facets[key] = agg.buckets.map((bucket) => ({
|
|
103
|
-
name: bucket.key,
|
|
104
|
-
count: bucket.doc_count,
|
|
105
|
-
}));
|
|
106
|
-
}
|
|
107
|
-
}
|
|
108
|
-
});
|
|
109
|
-
}
|
|
110
|
-
let geohashGrid;
|
|
111
|
-
if (response.body.aggregations?.geohash_grid) {
|
|
112
|
-
const geohashAgg = response.body.aggregations.geohash_grid;
|
|
113
|
-
if (geohashAgg?.buckets && Array.isArray(geohashAgg.buckets)) {
|
|
114
|
-
geohashAgg.buckets.forEach((bucket) => {
|
|
115
|
-
geohashGrid ||= {};
|
|
116
|
-
geohashGrid[bucket.key] = bucket.doc_count;
|
|
117
|
-
});
|
|
118
|
-
}
|
|
119
|
-
}
|
|
120
|
-
const total = typeof response.body.hits.total === 'number'
|
|
121
|
-
? response.body.hits.total
|
|
122
|
-
: response.body.hits.total?.value || 0;
|
|
123
|
-
const result = {
|
|
124
|
-
total,
|
|
125
|
-
searchTime: response.body.took,
|
|
126
|
-
entities,
|
|
127
|
-
facets: Object.keys(facets).length > 0 ? facets : undefined,
|
|
128
|
-
geohashGrid,
|
|
129
|
-
};
|
|
130
|
-
return result;
|
|
74
|
+
result = await backend.search(searchRequest, context);
|
|
131
75
|
}
|
|
132
76
|
catch (error) {
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
77
|
+
await visibilityWhere.catch((visibilityError) => {
|
|
78
|
+
fastify.log.error({ err: error }, 'Search backend failed');
|
|
79
|
+
throw visibilityError;
|
|
80
|
+
});
|
|
81
|
+
if (!(error instanceof SearchQueryError)) {
|
|
82
|
+
throw error;
|
|
137
83
|
}
|
|
138
|
-
fastify.log.
|
|
139
|
-
return reply.code(
|
|
84
|
+
fastify.log.warn(`Invalid search query: ${error.message}`);
|
|
85
|
+
return reply.code(422).send(createError(ERROR_CODES.VALIDATION_ERROR, error.message));
|
|
140
86
|
}
|
|
87
|
+
const searchTime = Math.round(performance.now() - start);
|
|
88
|
+
const dbEntities = await prisma.entity.findMany({
|
|
89
|
+
where: {
|
|
90
|
+
AND: [{ id: { in: result.hits.map(({ id }) => id) } }, await visibilityWhere],
|
|
91
|
+
},
|
|
92
|
+
});
|
|
93
|
+
const authorisedEntities = await authoriseEntities(dbEntities, prisma, access, context);
|
|
94
|
+
const entityMap = new Map(authorisedEntities.map((entity, i) => [entity.id, { entity, row: dbEntities[i] }]));
|
|
95
|
+
const entities = await Promise.all(result.hits.map(async ({ id, searchExtra }) => {
|
|
96
|
+
const found = entityMap.get(id);
|
|
97
|
+
if (!found) {
|
|
98
|
+
fastify.log.warn(`Entity ${id} found by the search backend but missing or not visible in database`);
|
|
99
|
+
return null;
|
|
100
|
+
}
|
|
101
|
+
const transformed = await applyTransformers(found.entity, entityTransformers, context, found.row);
|
|
102
|
+
const extra = visibleExtra(searchExtra, found.entity.access);
|
|
103
|
+
return extra === undefined ? transformed : { ...transformed, searchExtra: extra };
|
|
104
|
+
})).then((results) => results.filter((entity) => entity !== null));
|
|
105
|
+
return {
|
|
106
|
+
total: result.total,
|
|
107
|
+
searchTime,
|
|
108
|
+
entities,
|
|
109
|
+
facets: { ...noFacets, ...result.facets },
|
|
110
|
+
...(result.geohashGrid && { geohashGrid: result.geohashGrid }),
|
|
111
|
+
};
|
|
141
112
|
});
|
|
142
113
|
};
|
|
143
114
|
export default search;
|