arocapi 5.0.0-beta.2 → 5.0.0-beta.4
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 +37 -824
- package/dist/app.d.ts +20 -7
- package/dist/app.js +42 -28
- package/dist/app.js.map +1 -1
- package/dist/app.test.js +41 -56
- package/dist/app.test.js.map +1 -1
- package/dist/errorHandling.test.d.ts +1 -0
- package/dist/errorHandling.test.js +222 -0
- package/dist/errorHandling.test.js.map +1 -0
- package/dist/index.dev.js +4 -3
- package/dist/index.dev.js.map +1 -1
- package/dist/routes/capabilities.test.js +8 -8
- package/dist/routes/capabilities.test.js.map +1 -1
- package/dist/routes/crate.test.js +67 -19
- package/dist/routes/crate.test.js.map +1 -1
- package/dist/routes/entities.d.ts +5 -2
- package/dist/routes/entities.js +31 -49
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/entities.test.js +16 -12
- package/dist/routes/entities.test.js.map +1 -1
- package/dist/routes/entity.d.ts +7 -2
- package/dist/routes/entity.js +14 -29
- package/dist/routes/entity.js.map +1 -1
- package/dist/routes/entity.test.js +19 -13
- package/dist/routes/entity.test.js.map +1 -1
- package/dist/routes/file.d.ts +6 -0
- package/dist/routes/file.js +67 -59
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/file.test.js +135 -25
- package/dist/routes/file.test.js.map +1 -1
- package/dist/routes/files.d.ts +5 -2
- package/dist/routes/files.js +24 -39
- package/dist/routes/files.js.map +1 -1
- package/dist/routes/files.test.js +44 -21
- package/dist/routes/files.test.js.map +1 -1
- package/dist/routes/metadata.d.ts +6 -0
- package/dist/routes/metadata.js +49 -54
- package/dist/routes/metadata.js.map +1 -1
- package/dist/routes/search.d.ts +6 -2
- package/dist/routes/search.js +95 -99
- package/dist/routes/search.js.map +1 -1
- package/dist/routes/search.test.js +85 -39
- package/dist/routes/search.test.js.map +1 -1
- package/dist/test/helpers/fastify.js +2 -3
- package/dist/test/helpers/fastify.js.map +1 -1
- package/dist/test/integration.setup.d.ts +18 -0
- package/dist/test/integration.setup.js +15 -7
- package/dist/test/integration.setup.js.map +1 -1
- package/dist/test/integration.test.js +368 -2
- package/dist/test/integration.test.js.map +1 -1
- package/dist/transformers/default.d.ts +10 -18
- package/dist/transformers/default.js +41 -15
- package/dist/transformers/default.js.map +1 -1
- package/dist/transformers/default.test.js +109 -47
- package/dist/transformers/default.test.js.map +1 -1
- package/dist/transformers/transformer.test.js +12 -34
- package/dist/transformers/transformer.test.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/fileHandlers.d.ts +5 -9
- package/dist/types/transformers.d.ts +4 -10
- package/dist/types/visibility.d.ts +5 -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 +13 -4
- package/dist/utils/errors.js +44 -8
- package/dist/utils/errors.js.map +1 -1
- package/dist/utils/errors.test.js +14 -1
- package/dist/utils/errors.test.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 +6 -4
- package/src/app.test.ts +45 -66
- package/src/app.ts +85 -54
- package/src/errorHandling.test.ts +288 -0
- package/src/index.dev.ts +6 -4
- package/src/routes/__snapshots__/search.test.ts.snap +2 -2
- package/src/routes/capabilities.test.ts +8 -8
- package/src/routes/crate.test.ts +80 -19
- package/src/routes/entities.test.ts +16 -12
- package/src/routes/entities.ts +40 -59
- package/src/routes/entity.test.ts +19 -13
- package/src/routes/entity.ts +22 -35
- package/src/routes/file.test.ts +156 -25
- package/src/routes/file.ts +84 -62
- package/src/routes/files.test.ts +52 -26
- package/src/routes/files.ts +31 -47
- package/src/routes/metadata.ts +64 -58
- package/src/routes/search.test.ts +88 -39
- package/src/routes/search.ts +123 -119
- package/src/test/helpers/fastify.ts +2 -3
- package/src/test/integration.setup.ts +18 -7
- package/src/test/integration.test.ts +472 -1
- package/src/transformers/default.test.ts +139 -47
- package/src/transformers/default.ts +103 -83
- package/src/transformers/transformer.test.ts +18 -44
- package/src/types/access.ts +20 -0
- package/src/types/context.ts +15 -0
- package/src/types/fileHandlers.ts +5 -13
- package/src/types/transformers.ts +4 -32
- package/src/types/visibility.ts +18 -0
- package/src/utils/access.ts +80 -0
- package/src/utils/errors.test.ts +16 -1
- package/src/utils/errors.ts +67 -10
- package/src/utils/validation.ts +11 -0
- package/src/utils/visibility.ts +56 -0
|
@@ -1,11 +1,29 @@
|
|
|
1
1
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
2
2
|
import { fastify, fastifyAfter, fastifyBefore, prisma } from '../test/helpers/fastify.js';
|
|
3
|
-
import {
|
|
3
|
+
import { AllPublicAccess } from '../utils/access.js';
|
|
4
|
+
import { AllVisibleEntityFilter } from '../utils/visibility.js';
|
|
4
5
|
import filesRoute from './files.js';
|
|
5
6
|
describe('Files Route', () => {
|
|
7
|
+
const mockEntity = (id, name) => ({
|
|
8
|
+
id,
|
|
9
|
+
name,
|
|
10
|
+
description: '',
|
|
11
|
+
entityType: 'http://schema.org/MediaObject',
|
|
12
|
+
memberOf: null,
|
|
13
|
+
rootCollection: null,
|
|
14
|
+
metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
|
|
15
|
+
contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
|
|
16
|
+
meta: {},
|
|
17
|
+
createdAt: new Date('2025-01-01'),
|
|
18
|
+
updatedAt: new Date('2025-01-01'),
|
|
19
|
+
});
|
|
6
20
|
beforeEach(async () => {
|
|
7
21
|
await fastifyBefore();
|
|
8
|
-
await fastify.register(filesRoute, {
|
|
22
|
+
await fastify.register(filesRoute, {
|
|
23
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
24
|
+
prisma,
|
|
25
|
+
access: AllPublicAccess,
|
|
26
|
+
});
|
|
9
27
|
});
|
|
10
28
|
afterEach(async () => {
|
|
11
29
|
await fastifyAfter();
|
|
@@ -18,6 +36,7 @@ describe('Files Route', () => {
|
|
|
18
36
|
meta: {},
|
|
19
37
|
createdAt: new Date('2025-01-01'),
|
|
20
38
|
updatedAt: new Date('2025-01-01'),
|
|
39
|
+
entity: mockEntity('http://example.com/file1.wav', 'file1.wav'),
|
|
21
40
|
};
|
|
22
41
|
const mockFile2 = {
|
|
23
42
|
id: 'http://example.com/file2.txt',
|
|
@@ -27,6 +46,7 @@ describe('Files Route', () => {
|
|
|
27
46
|
meta: {},
|
|
28
47
|
createdAt: new Date('2025-01-02'),
|
|
29
48
|
updatedAt: new Date('2025-01-02'),
|
|
49
|
+
entity: mockEntity('http://example.com/file2.txt', 'file2.txt'),
|
|
30
50
|
};
|
|
31
51
|
describe('GET /files', () => {
|
|
32
52
|
it('should list all files successfully', async () => {
|
|
@@ -49,6 +69,7 @@ describe('Files Route', () => {
|
|
|
49
69
|
content: true,
|
|
50
70
|
},
|
|
51
71
|
});
|
|
72
|
+
expect(prisma.file.findMany).toHaveBeenCalledWith(expect.objectContaining({ include: { entity: { omit: { meta: true } } } }));
|
|
52
73
|
});
|
|
53
74
|
it('should filter files by memberOf', async () => {
|
|
54
75
|
prisma.file.findMany.mockResolvedValue([mockFile1]);
|
|
@@ -66,7 +87,7 @@ describe('Files Route', () => {
|
|
|
66
87
|
filename: 'file1.wav',
|
|
67
88
|
});
|
|
68
89
|
expect(prisma.file.findMany).toHaveBeenCalledWith(expect.objectContaining({
|
|
69
|
-
where: { entity: { memberOf: 'http://example.com/collection/1' } },
|
|
90
|
+
where: { entity: { AND: [{ memberOf: 'http://example.com/collection/1' }, {}] } },
|
|
70
91
|
}));
|
|
71
92
|
});
|
|
72
93
|
it('should support pagination with limit and offset', async () => {
|
|
@@ -138,7 +159,7 @@ describe('Files Route', () => {
|
|
|
138
159
|
});
|
|
139
160
|
const body = JSON.parse(response.body);
|
|
140
161
|
expect(response.statusCode).toBe(400);
|
|
141
|
-
expect(body.error).toBe('
|
|
162
|
+
expect(body.error.code).toBe('VALIDATION_ERROR');
|
|
142
163
|
});
|
|
143
164
|
it('should validate memberOf parameter format', async () => {
|
|
144
165
|
const response = await fastify.inject({
|
|
@@ -147,7 +168,7 @@ describe('Files Route', () => {
|
|
|
147
168
|
});
|
|
148
169
|
const body = JSON.parse(response.body);
|
|
149
170
|
expect(response.statusCode).toBe(400);
|
|
150
|
-
expect(body.error).toBe('
|
|
171
|
+
expect(body.error.code).toBe('VALIDATION_ERROR');
|
|
151
172
|
});
|
|
152
173
|
it('should validate sort parameter', async () => {
|
|
153
174
|
const response = await fastify.inject({
|
|
@@ -156,7 +177,7 @@ describe('Files Route', () => {
|
|
|
156
177
|
});
|
|
157
178
|
const body = JSON.parse(response.body);
|
|
158
179
|
expect(response.statusCode).toBe(400);
|
|
159
|
-
expect(body.error).toBe('
|
|
180
|
+
expect(body.error.code).toBe('VALIDATION_ERROR');
|
|
160
181
|
});
|
|
161
182
|
});
|
|
162
183
|
describe('Custom File Transformers', () => {
|
|
@@ -168,8 +189,9 @@ describe('Files Route', () => {
|
|
|
168
189
|
uppercaseFilename: file.filename.toUpperCase(),
|
|
169
190
|
});
|
|
170
191
|
await fastify.register(filesRoute, {
|
|
192
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
171
193
|
prisma,
|
|
172
|
-
|
|
194
|
+
access: AllPublicAccess,
|
|
173
195
|
fileTransformers: [customTransformer],
|
|
174
196
|
});
|
|
175
197
|
prisma.file.findMany.mockResolvedValue([mockFile1]);
|
|
@@ -188,33 +210,34 @@ describe('Files Route', () => {
|
|
|
188
210
|
});
|
|
189
211
|
await fastifyAfter();
|
|
190
212
|
});
|
|
191
|
-
it('should
|
|
213
|
+
it('should attach the content access of each file entity', async () => {
|
|
192
214
|
await fastifyBefore();
|
|
193
|
-
const
|
|
194
|
-
|
|
195
|
-
|
|
215
|
+
const access = (entity) => entity.id === 'http://example.com/file1.wav'
|
|
216
|
+
? {
|
|
217
|
+
metadata: false,
|
|
196
218
|
content: false,
|
|
219
|
+
metadataAuthorizationUrl: 'https://example.com/request-metadata',
|
|
197
220
|
contentAuthorizationUrl: 'https://example.com/request-access',
|
|
198
|
-
}
|
|
199
|
-
|
|
221
|
+
}
|
|
222
|
+
: { metadata: true, content: true };
|
|
200
223
|
await fastify.register(filesRoute, {
|
|
224
|
+
entityVisibilityFilter: AllVisibleEntityFilter,
|
|
201
225
|
prisma,
|
|
202
|
-
|
|
226
|
+
access,
|
|
203
227
|
});
|
|
204
|
-
prisma.file.findMany.mockResolvedValue([mockFile1]);
|
|
205
|
-
prisma.file.count.mockResolvedValue(
|
|
228
|
+
prisma.file.findMany.mockResolvedValue([mockFile1, mockFile2]);
|
|
229
|
+
prisma.file.count.mockResolvedValue(2);
|
|
206
230
|
const response = await fastify.inject({
|
|
207
231
|
method: 'GET',
|
|
208
232
|
url: '/files',
|
|
209
233
|
});
|
|
210
234
|
expect(response.statusCode).toBe(200);
|
|
211
235
|
const body = JSON.parse(response.body);
|
|
212
|
-
expect(body.files[0]).
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
contentAuthorizationUrl: 'https://example.com/request-access',
|
|
216
|
-
},
|
|
236
|
+
expect(body.files[0].access).toEqual({
|
|
237
|
+
content: false,
|
|
238
|
+
contentAuthorizationUrl: 'https://example.com/request-access',
|
|
217
239
|
});
|
|
240
|
+
expect(body.files[1].access).toEqual({ content: true });
|
|
218
241
|
await fastifyAfter();
|
|
219
242
|
});
|
|
220
243
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.test.js","sourceRoot":"","sources":["../../src/routes/files.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAErE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC1F,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"files.test.js","sourceRoot":"","sources":["../../src/routes/files.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAErE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,UAAU,MAAM,YAAY,CAAC;AAEpC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,MAAM,UAAU,GAAG,CAAC,EAAU,EAAE,IAAY,EAAE,EAAE,CAAC,CAAC;QAChD,EAAE;QACF,IAAI;QACJ,WAAW,EAAE,EAAE;QACf,UAAU,EAAE,+BAA+B;QAC3C,QAAQ,EAAE,IAAI;QACd,cAAc,EAAE,IAAI;QACpB,iBAAiB,EAAE,8CAA8C;QACjE,gBAAgB,EAAE,8CAA8C;QAChE,IAAI,EAAE,EAAE;QACR,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;KAClC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,aAAa,EAAE,CAAC;QACtB,MAAM,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE;YACjC,sBAAsB,EAAE,sBAAsB;YAC9C,MAAM;YACN,MAAM,EAAE,eAAe;SACxB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,YAAY,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG;QAChB,EAAE,EAAE,8BAA8B;QAClC,QAAQ,EAAE,WAAW;QACrB,SAAS,EAAE,WAAW;QACtB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAClB,IAAI,EAAE,EAAE;QACR,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;QACjC,MAAM,EAAE,UAAU,CAAC,8BAA8B,EAAE,WAAW,CAAC;KAChE,CAAC;IAEF,MAAM,SAAS,GAAG;QAChB,EAAE,EAAE,8BAA8B;QAClC,QAAQ,EAAE,WAAW;QACrB,SAAS,EAAE,YAAY;QACvB,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC;QACjB,IAAI,EAAE,EAAE;QACR,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;QACjC,MAAM,EAAE,UAAU,CAAC,8BAA8B,EAAE,WAAW,CAAC;KAChE,CAAC;IAEF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,QAAQ;aACd,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAwC,CAAC;YAC9E,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;gBAClC,EAAE,EAAE,8BAA8B;gBAClC,QAAQ,EAAE,WAAW;gBACrB,SAAS,EAAE,WAAW;gBACtB,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE;oBACN,OAAO,EAAE,IAAI;iBACd;aACF,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAC/C,MAAM,CAAC,gBAAgB,CAAC,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,CAC3E,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;YAC/C,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,iDAAiD;aACvD,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAwC,CAAC;YAC9E,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;gBAClC,EAAE,EAAE,8BAA8B;gBAClC,QAAQ,EAAE,WAAW;aACtB,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAC/C,MAAM,CAAC,gBAAgB,CAAC;gBACtB,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,iCAAiC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;aAClF,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;YAC/D,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,yBAAyB;aAC/B,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAwC,CAAC;YAC9E,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAC/C,MAAM,CAAC,gBAAgB,CAAC;gBACtB,IAAI,EAAE,CAAC;gBACP,IAAI,EAAE,CAAC;aACR,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,gCAAgC;aACtC,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAC/C,MAAM,CAAC,gBAAgB,CAAC;gBACtB,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE;aAC7B,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,2BAA2B;aACjC,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAC/C,MAAM,CAAC,gBAAgB,CAAC;gBACtB,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;aACxB,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,QAAQ;aACd,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAwC,CAAC;YAC9E,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC,CAAC;YAEhF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,QAAQ;aACd,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAgC,CAAC;YAEtE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;YAC/C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,mBAAmB;aACzB,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAA0B,CAAC;YAEhE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,6BAA6B;aACnC,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAA0B,CAAC;YAEhE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,qBAAqB;aAC3B,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAA0B,CAAC;YAEhE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACxC,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,aAAa,EAAE,CAAC;YAGtB,MAAM,iBAAiB,GAAoB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACpD,GAAG,IAAI;gBACP,WAAW,EAAE,YAAY;gBACzB,iBAAiB,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE;aAC/C,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE;gBACjC,sBAAsB,EAAE,sBAAsB;gBAC9C,MAAM;gBACN,MAAM,EAAE,eAAe;gBACvB,gBAAgB,EAAE,CAAC,iBAAiB,CAAC;aACtC,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,QAAQ;aACd,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAyB,CAAC;YAC/D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;gBAClC,EAAE,EAAE,8BAA8B;gBAClC,QAAQ,EAAE,WAAW;gBACrB,WAAW,EAAE,YAAY;gBACzB,iBAAiB,EAAE,WAAW;aAC/B,CAAC,CAAC;YAEH,MAAM,YAAY,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,aAAa,EAAE,CAAC;YAEtB,MAAM,MAAM,GAAmB,CAAC,MAAM,EAAE,EAAE,CACxC,MAAM,CAAC,EAAE,KAAK,8BAA8B;gBAC1C,CAAC,CAAC;oBACE,QAAQ,EAAE,KAAK;oBACf,OAAO,EAAE,KAAK;oBACd,wBAAwB,EAAE,sCAAsC;oBAChE,uBAAuB,EAAE,oCAAoC;iBAC9D;gBACH,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAExC,MAAM,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE;gBACjC,sBAAsB,EAAE,sBAAsB;gBAC9C,MAAM;gBACN,MAAM;aACP,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,QAAQ;aACd,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAA0C,CAAC;YAChF,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACnC,OAAO,EAAE,KAAK;gBACd,uBAAuB,EAAE,oCAAoC;aAC9D,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAExD,MAAM,YAAY,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,9 +1,15 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
2
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
3
|
+
import type { AccessFunction } from '../types/access.js';
|
|
3
4
|
import type { RoCrateHandler } from '../types/fileHandlers.js';
|
|
5
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
6
|
+
import { type RefusalOptions } from '../utils/visibility.js';
|
|
4
7
|
type CrateRouteOptions = {
|
|
5
8
|
prisma: PrismaClient;
|
|
6
9
|
roCrateHandler: RoCrateHandler;
|
|
10
|
+
access: AccessFunction;
|
|
11
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
12
|
+
refusal: RefusalOptions;
|
|
7
13
|
};
|
|
8
14
|
declare const crate: FastifyPluginAsync<CrateRouteOptions>;
|
|
9
15
|
export default crate;
|
package/dist/routes/metadata.js
CHANGED
|
@@ -1,37 +1,37 @@
|
|
|
1
1
|
import { createReadStream } from 'node:fs';
|
|
2
2
|
import { z } from 'zod';
|
|
3
|
-
import {
|
|
3
|
+
import { createAccessGuard } from '../utils/access.js';
|
|
4
|
+
import { createNotFoundError } from '../utils/errors.js';
|
|
4
5
|
import { setFileHeaders } from '../utils/headers.js';
|
|
6
|
+
import { createEntityNotVisibleResponder } from '../utils/visibility.js';
|
|
5
7
|
const paramsSchema = z.object({
|
|
6
8
|
id: z.url(),
|
|
7
9
|
});
|
|
8
10
|
const crate = async (fastify, opts) => {
|
|
9
|
-
const { prisma, roCrateHandler } = opts;
|
|
11
|
+
const { prisma, roCrateHandler, access, entityVisibilityFilter, refusal } = opts;
|
|
12
|
+
const findVisibleEntity = async (id, context) => prisma.entity.findFirst({ where: { AND: [{ id }, await entityVisibilityFilter(context)] } });
|
|
13
|
+
const sendEntityNotVisible = createEntityNotVisibleResponder(prisma, refusal);
|
|
14
|
+
const denyMetadata = createAccessGuard({ access, isAuthenticated: refusal.isAuthenticated, level: 'metadata' });
|
|
10
15
|
fastify.withTypeProvider().head('/entity/:id/metadata', {
|
|
11
16
|
schema: {
|
|
12
17
|
params: paramsSchema,
|
|
13
18
|
},
|
|
14
19
|
}, async (request, reply) => {
|
|
15
20
|
const { id } = request.params;
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
if (!entity) {
|
|
21
|
-
return reply.code(404).send(createNotFoundError('The requested entity was not found', id));
|
|
22
|
-
}
|
|
23
|
-
const metadata = await roCrateHandler.head(entity, { request, fastify });
|
|
24
|
-
if (!metadata) {
|
|
25
|
-
return reply.code(404).send(createNotFoundError('The requested RO-Crate metadata was not found', id));
|
|
26
|
-
}
|
|
27
|
-
setFileHeaders(reply, metadata);
|
|
28
|
-
return reply.code(200).send();
|
|
21
|
+
const context = { request, fastify };
|
|
22
|
+
const entity = await findVisibleEntity(id, context);
|
|
23
|
+
if (!entity) {
|
|
24
|
+
return sendEntityNotVisible(reply, id, context);
|
|
29
25
|
}
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
fastify.log.error(`RO-Crate metadata retrieval error: ${err}`);
|
|
33
|
-
return reply.code(500).send(createInternalError());
|
|
26
|
+
if (await denyMetadata(reply, entity, context)) {
|
|
27
|
+
return reply;
|
|
34
28
|
}
|
|
29
|
+
const metadata = await roCrateHandler.head(entity, context);
|
|
30
|
+
if (!metadata) {
|
|
31
|
+
return reply.code(404).send(createNotFoundError('The requested RO-Crate metadata was not found', id));
|
|
32
|
+
}
|
|
33
|
+
setFileHeaders(reply, metadata);
|
|
34
|
+
return reply.code(200).send();
|
|
35
35
|
});
|
|
36
36
|
fastify.withTypeProvider().get('/entity/:id/metadata', {
|
|
37
37
|
schema: {
|
|
@@ -39,43 +39,38 @@ const crate = async (fastify, opts) => {
|
|
|
39
39
|
},
|
|
40
40
|
}, async (request, reply) => {
|
|
41
41
|
const { id } = request.params;
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
if (result.type === 'redirect') {
|
|
54
|
-
return reply.code(302).redirect(result.url);
|
|
55
|
-
}
|
|
56
|
-
const metadata = {
|
|
57
|
-
...result.metadata,
|
|
58
|
-
contentType: 'application/ld+json',
|
|
59
|
-
};
|
|
60
|
-
setFileHeaders(reply, metadata);
|
|
61
|
-
if (result.type === 'stream') {
|
|
62
|
-
return reply.code(200).send(result.stream);
|
|
63
|
-
}
|
|
64
|
-
if (result.type === 'file') {
|
|
65
|
-
if (result.accelPath) {
|
|
66
|
-
reply.header('X-Accel-Redirect', result.accelPath);
|
|
67
|
-
return reply.code(200).send();
|
|
68
|
-
}
|
|
69
|
-
const stream = createReadStream(result.path);
|
|
70
|
-
return reply.code(200).send(stream);
|
|
71
|
-
}
|
|
72
|
-
throw new Error(`Unexpected RO-Crate result type: ${result.type}`);
|
|
42
|
+
const context = { request, fastify };
|
|
43
|
+
const entity = await findVisibleEntity(id, context);
|
|
44
|
+
if (!entity) {
|
|
45
|
+
return sendEntityNotVisible(reply, id, context);
|
|
46
|
+
}
|
|
47
|
+
if (await denyMetadata(reply, entity, context)) {
|
|
48
|
+
return reply;
|
|
49
|
+
}
|
|
50
|
+
const result = await roCrateHandler.get(entity, context);
|
|
51
|
+
if (!result) {
|
|
52
|
+
return reply.code(404).send(createNotFoundError('The requested RO-Crate could not be retrieved', id));
|
|
73
53
|
}
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
54
|
+
if (result.type === 'redirect') {
|
|
55
|
+
return reply.code(302).redirect(result.url);
|
|
56
|
+
}
|
|
57
|
+
const metadata = {
|
|
58
|
+
...result.metadata,
|
|
59
|
+
contentType: 'application/ld+json',
|
|
60
|
+
};
|
|
61
|
+
setFileHeaders(reply, metadata);
|
|
62
|
+
if (result.type === 'stream') {
|
|
63
|
+
return reply.code(200).send(result.stream);
|
|
64
|
+
}
|
|
65
|
+
if (result.type === 'file') {
|
|
66
|
+
if (result.accelPath) {
|
|
67
|
+
reply.header('X-Accel-Redirect', result.accelPath);
|
|
68
|
+
return reply.code(200).send();
|
|
69
|
+
}
|
|
70
|
+
const stream = createReadStream(result.path);
|
|
71
|
+
return reply.code(200).send(stream);
|
|
78
72
|
}
|
|
73
|
+
throw new Error(`Unexpected RO-Crate result type: ${result.type}`);
|
|
79
74
|
});
|
|
80
75
|
};
|
|
81
76
|
export default crate;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/routes/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAG3C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/routes/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAG3C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,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,KAAK,GAA0C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IAC3E,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEjF,MAAM,iBAAiB,GAAG,KAAK,EAAE,EAAU,EAAE,OAAuB,EAAE,EAAE,CACtE,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;IAE/F,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,IAAI,CAC9C,sBAAsB,EACtB;QACE,MAAM,EAAE;YACN,MAAM,EAAE,YAAY;SACrB;KACF,EACD,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACvB,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;QAE9B,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAEpD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,oBAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;YAC/C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,QAAQ,GAAyB,MAAM,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAElF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,+CAA+C,EAAE,EAAE,CAAC,CAAC,CAAC;QACxG,CAAC;QAED,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAEhC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAChC,CAAC,CACF,CAAC;IAEF,OAAO,CAAC,gBAAgB,EAAmB,CAAC,GAAG,CAC7C,sBAAsB,EACtB;QACE,MAAM,EAAE;YACN,MAAM,EAAE,YAAY;SACrB;KACF,EACD,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACvB,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;QAE9B,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAEpD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,oBAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;YAC/C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,+CAA+C,EAAE,EAAE,CAAC,CAAC,CAAC;QACxG,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;QAGD,MAAM,QAAQ,GAAG;YACf,GAAG,MAAM,CAAC,QAAQ;YAClB,WAAW,EAAE,qBAAqB;SACnC,CAAC;QAEF,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAGhC,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC3B,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;gBACrB,KAAK,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;gBACnD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YAChC,CAAC;YAED,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC7C,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,CAAC;QAGD,MAAM,IAAI,KAAK,CAAC,oCAAqC,MAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3F,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,KAAK,CAAC"}
|
package/dist/routes/search.d.ts
CHANGED
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
import type { Client } from '@opensearch-project/opensearch';
|
|
2
2
|
import type { FastifyPluginAsync } from 'fastify';
|
|
3
3
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
4
|
-
import type {
|
|
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';
|
|
5
7
|
import type { OpensearchQueryBuilder } from '../utils/queryBuilder.js';
|
|
6
8
|
type SearchRouteOptions = {
|
|
7
9
|
prisma: PrismaClient;
|
|
8
10
|
opensearch: Client;
|
|
9
|
-
|
|
11
|
+
access: AccessFunction;
|
|
10
12
|
entityTransformers?: EntityTransformer[];
|
|
11
13
|
queryBuilder: OpensearchQueryBuilder;
|
|
14
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
15
|
+
searchVisibilityFilter: SearchVisibilityFilter;
|
|
12
16
|
};
|
|
13
17
|
declare const search: FastifyPluginAsync<SearchRouteOptions>;
|
|
14
18
|
export default search;
|
package/dist/routes/search.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
2
|
+
import { applyTransformers, authoriseEntities } from '../transformers/default.js';
|
|
3
|
+
import { createError, ERROR_CODES } from '../utils/errors.js';
|
|
4
4
|
const boundingBoxSchema = z.object({
|
|
5
5
|
topRight: z.object({
|
|
6
6
|
lat: z.number(),
|
|
@@ -23,119 +23,115 @@ const searchParamsSchema = z.object({
|
|
|
23
23
|
order: z.enum(['asc', 'desc']).default('asc'),
|
|
24
24
|
});
|
|
25
25
|
const search = async (fastify, opts) => {
|
|
26
|
-
const { prisma, opensearch,
|
|
26
|
+
const { prisma, opensearch, access, entityTransformers = [], queryBuilder, entityVisibilityFilter, searchVisibilityFilter, } = opts;
|
|
27
27
|
fastify.withTypeProvider().post('/search', {
|
|
28
28
|
schema: {
|
|
29
29
|
body: searchParamsSchema,
|
|
30
30
|
},
|
|
31
31
|
}, async (request, reply) => {
|
|
32
32
|
const { searchType, query, filters, boundingBox, geohashPrecision, limit, offset, sort, order } = request.body;
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
33
|
+
const context = { request, fastify };
|
|
34
|
+
const [visibilityWhere, visibilityQuery] = await Promise.all([
|
|
35
|
+
entityVisibilityFilter(context),
|
|
36
|
+
searchVisibilityFilter(context),
|
|
37
|
+
]);
|
|
38
|
+
const opensearchQuery = {
|
|
39
|
+
index: 'entities',
|
|
40
|
+
body: {
|
|
41
|
+
query: {
|
|
42
|
+
bool: {
|
|
43
|
+
must: [queryBuilder.buildQuery(searchType, query, filters, boundingBox)],
|
|
44
|
+
filter: [visibilityQuery],
|
|
44
45
|
},
|
|
45
|
-
sort: queryBuilder.buildSort(sort, order),
|
|
46
|
-
from: offset,
|
|
47
|
-
size: limit,
|
|
48
46
|
},
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
}
|
|
55
|
-
const entityIds = response.body.hits.hits.map((hit) => hit._source?.id).filter(Boolean);
|
|
56
|
-
const dbEntities = await prisma.entity.findMany({
|
|
57
|
-
where: {
|
|
58
|
-
id: {
|
|
59
|
-
in: entityIds,
|
|
47
|
+
aggs: queryBuilder.buildAggregations(geohashPrecision, boundingBox),
|
|
48
|
+
highlight: {
|
|
49
|
+
fields: {
|
|
50
|
+
name: {},
|
|
51
|
+
description: {},
|
|
60
52
|
},
|
|
61
53
|
},
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
const standardEntity = {
|
|
77
|
-
...base,
|
|
78
|
-
memberOf: base.memberOf ? (refMap.get(base.memberOf) ?? null) : null,
|
|
79
|
-
rootCollection: base.rootCollection ? (refMap.get(base.rootCollection) ?? null) : null,
|
|
80
|
-
};
|
|
81
|
-
const authorisedEntity = await accessTransformer(standardEntity, { request, fastify });
|
|
82
|
-
let result = authorisedEntity;
|
|
83
|
-
for (const transformer of entityTransformers) {
|
|
84
|
-
result = await transformer(result, { request, fastify });
|
|
85
|
-
}
|
|
86
|
-
return {
|
|
87
|
-
...result,
|
|
88
|
-
searchExtra: {
|
|
89
|
-
score: hit._score,
|
|
90
|
-
highlight: hit.highlight,
|
|
91
|
-
},
|
|
92
|
-
};
|
|
93
|
-
})).then((results) => results.filter(Boolean));
|
|
94
|
-
const facets = {};
|
|
95
|
-
if (response.body.aggregations) {
|
|
96
|
-
Object.keys(response.body.aggregations).forEach((key) => {
|
|
97
|
-
if (key !== 'geohash_grid') {
|
|
98
|
-
const agg = response.body.aggregations?.[key];
|
|
99
|
-
if (agg?.buckets && Array.isArray(agg.buckets)) {
|
|
100
|
-
facets[key] = agg.buckets.map((bucket) => ({
|
|
101
|
-
name: bucket.key,
|
|
102
|
-
count: bucket.doc_count,
|
|
103
|
-
}));
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
-
});
|
|
54
|
+
sort: queryBuilder.buildSort(sort, order),
|
|
55
|
+
from: offset,
|
|
56
|
+
size: limit,
|
|
57
|
+
},
|
|
58
|
+
};
|
|
59
|
+
fastify.log.debug(opensearchQuery);
|
|
60
|
+
let response;
|
|
61
|
+
try {
|
|
62
|
+
response = await opensearch.search(opensearchQuery);
|
|
63
|
+
}
|
|
64
|
+
catch (error) {
|
|
65
|
+
const { statusCode, message } = error;
|
|
66
|
+
if (statusCode !== 400) {
|
|
67
|
+
throw error;
|
|
107
68
|
}
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
69
|
+
fastify.log.warn(`Invalid search query: ${message}`);
|
|
70
|
+
return reply.code(422).send(createError(ERROR_CODES.VALIDATION_ERROR, message));
|
|
71
|
+
}
|
|
72
|
+
if (!response.body?.hits?.hits) {
|
|
73
|
+
throw new Error('Invalid search response: missing hits data');
|
|
74
|
+
}
|
|
75
|
+
const entityIds = response.body.hits.hits.map((hit) => hit._source?.id).filter(Boolean);
|
|
76
|
+
const dbEntities = await prisma.entity.findMany({
|
|
77
|
+
where: {
|
|
78
|
+
AND: [{ id: { in: entityIds } }, visibilityWhere],
|
|
79
|
+
},
|
|
80
|
+
include: { file: { select: { id: true } } },
|
|
81
|
+
});
|
|
82
|
+
const authorisedEntities = await authoriseEntities(dbEntities, prisma, access, context);
|
|
83
|
+
const entityMap = new Map(authorisedEntities.map((entity) => [entity.id, entity]));
|
|
84
|
+
const entities = await Promise.all(response.body.hits.hits.map(async (hit) => {
|
|
85
|
+
if (!hit._source?.id) {
|
|
86
|
+
throw new Error('Missing id in search hit');
|
|
87
|
+
}
|
|
88
|
+
const authorisedEntity = entityMap.get(hit._source.id);
|
|
89
|
+
if (!authorisedEntity) {
|
|
90
|
+
fastify.log.warn(`Entity ${hit._source.id} found in OpenSearch but missing or not visible in database`);
|
|
91
|
+
return null;
|
|
117
92
|
}
|
|
118
|
-
const
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
facets: Object.keys(facets).length > 0 ? facets : undefined,
|
|
126
|
-
geohashGrid,
|
|
93
|
+
const result = await applyTransformers(authorisedEntity, entityTransformers, context);
|
|
94
|
+
return {
|
|
95
|
+
...result,
|
|
96
|
+
searchExtra: {
|
|
97
|
+
score: hit._score,
|
|
98
|
+
highlight: hit.highlight,
|
|
99
|
+
},
|
|
127
100
|
};
|
|
128
|
-
|
|
101
|
+
})).then((results) => results.filter(Boolean));
|
|
102
|
+
const facets = {};
|
|
103
|
+
if (response.body.aggregations) {
|
|
104
|
+
Object.keys(response.body.aggregations).forEach((key) => {
|
|
105
|
+
if (key !== 'geohash_grid') {
|
|
106
|
+
const agg = response.body.aggregations?.[key];
|
|
107
|
+
if (agg?.buckets && Array.isArray(agg.buckets)) {
|
|
108
|
+
facets[key] = agg.buckets.map((bucket) => ({
|
|
109
|
+
name: bucket.key,
|
|
110
|
+
count: bucket.doc_count,
|
|
111
|
+
}));
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
});
|
|
129
115
|
}
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
116
|
+
let geohashGrid;
|
|
117
|
+
if (response.body.aggregations?.geohash_grid) {
|
|
118
|
+
const geohashAgg = response.body.aggregations.geohash_grid;
|
|
119
|
+
if (geohashAgg?.buckets && Array.isArray(geohashAgg.buckets)) {
|
|
120
|
+
geohashAgg.buckets.forEach((bucket) => {
|
|
121
|
+
geohashGrid ||= {};
|
|
122
|
+
geohashGrid[bucket.key] = bucket.doc_count;
|
|
123
|
+
});
|
|
135
124
|
}
|
|
136
|
-
fastify.log.error(`Search error: ${err.message}`);
|
|
137
|
-
return reply.code(500).send(createInternalError('Search failed'));
|
|
138
125
|
}
|
|
126
|
+
const total = typeof response.body.hits.total === 'number' ? response.body.hits.total : response.body.hits.total?.value || 0;
|
|
127
|
+
const result = {
|
|
128
|
+
total,
|
|
129
|
+
searchTime: response.body.took,
|
|
130
|
+
entities,
|
|
131
|
+
facets: Object.keys(facets).length > 0 ? facets : undefined,
|
|
132
|
+
geohashGrid,
|
|
133
|
+
};
|
|
134
|
+
return result;
|
|
139
135
|
});
|
|
140
136
|
};
|
|
141
137
|
export default search;
|