arocapi 1.1.0 → 1.2.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.
Files changed (127) hide show
  1. package/README.md +334 -8
  2. package/dist/app.d.ts +19 -1
  3. package/dist/app.js +35 -28
  4. package/dist/app.js.map +1 -1
  5. package/dist/app.test.js +124 -0
  6. package/dist/app.test.js.map +1 -0
  7. package/dist/index.dev.js +146 -0
  8. package/dist/index.dev.js.map +1 -0
  9. package/dist/routes/crate.d.ts +7 -0
  10. package/dist/routes/crate.js +99 -0
  11. package/dist/routes/crate.js.map +1 -0
  12. package/dist/routes/crate.test.d.ts +1 -0
  13. package/dist/routes/crate.test.js +360 -0
  14. package/dist/routes/crate.test.js.map +1 -0
  15. package/dist/routes/entities.d.ts +6 -1
  16. package/dist/routes/entities.js +51 -39
  17. package/dist/routes/entities.js.map +1 -1
  18. package/dist/routes/entities.test.d.ts +1 -0
  19. package/dist/routes/entities.test.js +245 -0
  20. package/dist/routes/entities.test.js.map +1 -0
  21. package/dist/routes/entity.d.ts +6 -1
  22. package/dist/routes/entity.js +28 -7
  23. package/dist/routes/entity.js.map +1 -1
  24. package/dist/routes/entity.test.d.ts +1 -0
  25. package/dist/routes/entity.test.js +109 -0
  26. package/dist/routes/entity.test.js.map +1 -0
  27. package/dist/routes/file.d.ts +7 -0
  28. package/dist/routes/file.js +111 -0
  29. package/dist/routes/file.js.map +1 -0
  30. package/dist/routes/file.test.d.ts +1 -0
  31. package/dist/routes/file.test.js +319 -0
  32. package/dist/routes/file.test.js.map +1 -0
  33. package/dist/routes/files.d.ts +8 -0
  34. package/dist/routes/files.js +61 -0
  35. package/dist/routes/files.js.map +1 -0
  36. package/dist/routes/files.test.d.ts +1 -0
  37. package/dist/routes/files.test.js +244 -0
  38. package/dist/routes/files.test.js.map +1 -0
  39. package/dist/routes/search.d.ts +6 -1
  40. package/dist/routes/search.js +43 -17
  41. package/dist/routes/search.js.map +1 -1
  42. package/dist/routes/search.test.d.ts +1 -0
  43. package/dist/routes/search.test.js +698 -0
  44. package/dist/routes/search.test.js.map +1 -0
  45. package/dist/test/helpers/fastify.d.ts +9 -0
  46. package/dist/test/helpers/fastify.js +24 -0
  47. package/dist/test/helpers/fastify.js.map +1 -0
  48. package/dist/test/integration.setup.d.ts +58 -0
  49. package/dist/test/integration.setup.js +181 -0
  50. package/dist/test/integration.setup.js.map +1 -0
  51. package/dist/test/integration.test.d.ts +1 -0
  52. package/dist/test/integration.test.js +337 -0
  53. package/dist/test/integration.test.js.map +1 -0
  54. package/dist/transformers/default.d.ts +45 -0
  55. package/dist/transformers/default.js +46 -0
  56. package/dist/transformers/default.js.map +1 -0
  57. package/dist/transformers/default.test.d.ts +1 -0
  58. package/dist/transformers/default.test.js +177 -0
  59. package/dist/transformers/default.test.js.map +1 -0
  60. package/dist/transformers/transformer.test.d.ts +1 -0
  61. package/dist/transformers/transformer.test.js +176 -0
  62. package/dist/transformers/transformer.test.js.map +1 -0
  63. package/dist/types/fileHandlers.d.ts +41 -0
  64. package/dist/types/fileHandlers.js +2 -0
  65. package/dist/types/fileHandlers.js.map +1 -0
  66. package/dist/types/transformers.d.ts +10 -0
  67. package/dist/types/transformers.js +2 -0
  68. package/dist/types/transformers.js.map +1 -0
  69. package/dist/utils/errors.d.ts +23 -0
  70. package/dist/utils/errors.js +21 -0
  71. package/dist/utils/errors.js.map +1 -0
  72. package/dist/utils/errors.test.d.ts +1 -0
  73. package/dist/utils/errors.test.js +66 -0
  74. package/dist/utils/errors.test.js.map +1 -0
  75. package/package.json +34 -25
  76. package/prisma/migrations/20250827033956_record_type_scalar/migration.sql +10 -0
  77. package/prisma/migrations/20250923032753_api_refactor/migration.sql +39 -0
  78. package/prisma/migrations/20250923223119_entity_type_to_string/migration.sql +8 -0
  79. package/prisma/migrations/20251020140329_add_meta_column/migration.sql +2 -0
  80. package/prisma/migrations/20251027010713_add_file_table/migration.sql +17 -0
  81. package/prisma/migrations/20251027221138_add_file_id_to_entity/migration.sql +2 -0
  82. package/prisma/models/entity.prisma +16 -12
  83. package/prisma/models/file.prisma +20 -0
  84. package/prisma.config.ts +6 -1
  85. package/src/__snapshots__/app.test.ts.snap +8 -0
  86. package/src/app.test.ts +158 -0
  87. package/src/app.ts +97 -35
  88. package/src/index.dev.ts +196 -0
  89. package/src/reset.d.ts +1 -0
  90. package/src/routes/__snapshots__/entities.test.ts.snap +68 -0
  91. package/src/routes/__snapshots__/entity.test.ts.snap +66 -0
  92. package/src/routes/__snapshots__/search.test.ts.snap +139 -0
  93. package/src/routes/crate.test.ts +441 -0
  94. package/src/routes/crate.ts +141 -0
  95. package/src/routes/entities.test.ts +284 -0
  96. package/src/routes/entities.ts +64 -45
  97. package/src/routes/entity.test.ts +132 -0
  98. package/src/routes/entity.ts +57 -22
  99. package/src/routes/file.test.ts +399 -0
  100. package/src/routes/file.ts +153 -0
  101. package/src/routes/files.test.ts +303 -0
  102. package/src/routes/files.ts +87 -0
  103. package/src/routes/search.test.ts +807 -0
  104. package/src/routes/search.ts +66 -23
  105. package/src/test/__snapshots__/integration.test.ts.snap +18 -0
  106. package/src/test/helpers/fastify.ts +39 -0
  107. package/src/test/integration.setup.ts +200 -0
  108. package/src/test/integration.test.ts +411 -0
  109. package/src/transformers/default.test.ts +199 -0
  110. package/src/transformers/default.ts +165 -0
  111. package/src/transformers/transformer.test.ts +233 -0
  112. package/src/types/fileHandlers.ts +65 -0
  113. package/src/types/transformers.ts +52 -0
  114. package/src/utils/errors.test.ts +75 -0
  115. package/src/utils/errors.ts +45 -0
  116. package/dist/index.js +0 -25
  117. package/dist/index.js.map +0 -1
  118. package/dist/scripts/loadEntities.js +0 -170
  119. package/dist/scripts/loadEntities.js.map +0 -1
  120. package/dist/type.d.ts +0 -6
  121. package/dist/type.js +0 -2
  122. package/dist/type.js.map +0 -1
  123. package/src/index.ts +0 -35
  124. package/src/scripts/loadEntities.ts +0 -223
  125. package/src/type.ts +0 -7
  126. /package/dist/{scripts/loadEntities.d.ts → app.test.d.ts} +0 -0
  127. /package/dist/{index.d.ts → index.dev.d.ts} +0 -0
@@ -0,0 +1,441 @@
1
+ import { createReadStream } from 'node:fs';
2
+ import { Readable } from 'node:stream';
3
+ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
4
+ import { fastify, fastifyAfter, fastifyBefore, prisma } from '../test/helpers/fastify.js';
5
+ import type { FileResult, RoCrateHandler } from '../types/fileHandlers.js';
6
+ import type { StandardErrorResponse } from '../utils/errors.js';
7
+ import crateRoute from './crate.js';
8
+
9
+ vi.mock('node:fs', () => ({
10
+ createReadStream: vi.fn(),
11
+ }));
12
+
13
+ describe('Crate Route', () => {
14
+ const mockRoCrateHandler: RoCrateHandler = {
15
+ get: vi.fn(),
16
+ head: vi.fn(),
17
+ };
18
+
19
+ beforeEach(async () => {
20
+ await fastifyBefore();
21
+ await fastify.register(crateRoute, { roCrateHandler: mockRoCrateHandler });
22
+ vi.clearAllMocks();
23
+ });
24
+
25
+ afterEach(async () => {
26
+ await fastifyAfter();
27
+ });
28
+
29
+ const mockFileEntity = {
30
+ id: 1,
31
+ rocrateId: 'http://example.com/entity/file.wav',
32
+ name: 'test.wav',
33
+ description: 'A test file',
34
+ entityType: 'http://schema.org/MediaObject',
35
+ fileId: null,
36
+ memberOf: 'http://example.com/collection',
37
+ rootCollection: 'http://example.com/collection',
38
+ metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
39
+ contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
40
+ createdAt: new Date(),
41
+ updatedAt: new Date(),
42
+ rocrate: {
43
+ '@context': 'https://w3id.org/ro/crate/1.1/context',
44
+ '@graph': [
45
+ {
46
+ '@id': 'ro-crate-metadata.json',
47
+ '@type': 'CreativeWork',
48
+ conformsTo: { '@id': 'https://w3id.org/ro/crate/1.1' },
49
+ about: { '@id': './' },
50
+ },
51
+ {
52
+ '@id': './',
53
+ '@type': 'Dataset',
54
+ name: 'Test RO-Crate',
55
+ },
56
+ ],
57
+ },
58
+ meta: {},
59
+ };
60
+
61
+ const mockCollectionEntity = {
62
+ ...mockFileEntity,
63
+ rocrateId: 'http://example.com/collection',
64
+ name: 'Test Collection',
65
+ entityType: 'http://pcdm.org/models#Collection',
66
+ memberOf: null,
67
+ rootCollection: null,
68
+ };
69
+
70
+ const mockObjectEntity = {
71
+ ...mockFileEntity,
72
+ rocrateId: 'http://example.com/object',
73
+ name: 'Test Object',
74
+ entityType: 'http://pcdm.org/models#Object',
75
+ memberOf: 'http://example.com/collection',
76
+ rootCollection: 'http://example.com/collection',
77
+ };
78
+
79
+ describe('GET /entity/:id/rocrate', () => {
80
+ it('should stream RO-Crate metadata for File entity', async () => {
81
+ prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
82
+
83
+ const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
84
+ const mockResult: FileResult = {
85
+ type: 'stream',
86
+ stream: mockStream,
87
+ metadata: {
88
+ contentType: 'text/plain',
89
+ contentLength: 52,
90
+ etag: '"rocrate123"',
91
+ lastModified: new Date('2025-01-01'),
92
+ },
93
+ };
94
+ vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
95
+
96
+ const response = await fastify.inject({
97
+ method: 'GET',
98
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
99
+ });
100
+
101
+ expect(response.statusCode).toBe(200);
102
+ expect(response.headers['content-type']).toBe('application/ld+json');
103
+ expect(response.headers['content-length']).toBe('52');
104
+ expect(response.headers.etag).toBe('"rocrate123"');
105
+ expect(response.body).toBe('{"@context": "https://w3id.org/ro/crate/1.1/context"}');
106
+
107
+ expect(mockRoCrateHandler.get).toHaveBeenCalledWith(
108
+ mockFileEntity,
109
+ expect.objectContaining({
110
+ request: expect.any(Object),
111
+ fastify: expect.any(Object),
112
+ }),
113
+ );
114
+ });
115
+
116
+ it('should stream RO-Crate metadata for Collection entity', async () => {
117
+ prisma.entity.findFirst.mockResolvedValue(mockCollectionEntity);
118
+
119
+ const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
120
+ const mockResult: FileResult = {
121
+ type: 'stream',
122
+ stream: mockStream,
123
+ metadata: {
124
+ contentType: 'application/json',
125
+ contentLength: 52,
126
+ },
127
+ };
128
+ vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
129
+
130
+ const response = await fastify.inject({
131
+ method: 'GET',
132
+ url: `/entity/${encodeURIComponent('http://example.com/collection')}/rocrate`,
133
+ });
134
+
135
+ expect(response.statusCode).toBe(200);
136
+ expect(response.headers['content-type']).toBe('application/ld+json');
137
+ expect(mockRoCrateHandler.get).toHaveBeenCalledWith(mockCollectionEntity, expect.any(Object));
138
+ });
139
+
140
+ it('should stream RO-Crate metadata for Object entity', async () => {
141
+ prisma.entity.findFirst.mockResolvedValue(mockObjectEntity);
142
+
143
+ const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
144
+ const mockResult: FileResult = {
145
+ type: 'stream',
146
+ stream: mockStream,
147
+ metadata: {
148
+ contentType: 'application/ld+json',
149
+ contentLength: 52,
150
+ },
151
+ };
152
+ vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
153
+
154
+ const response = await fastify.inject({
155
+ method: 'GET',
156
+ url: `/entity/${encodeURIComponent('http://example.com/object')}/rocrate`,
157
+ });
158
+
159
+ expect(response.statusCode).toBe(200);
160
+ expect(response.headers['content-type']).toBe('application/ld+json');
161
+ expect(mockRoCrateHandler.get).toHaveBeenCalledWith(mockObjectEntity, expect.any(Object));
162
+ });
163
+
164
+ it('should handle redirect response', async () => {
165
+ prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
166
+
167
+ const mockResult: FileResult = {
168
+ type: 'redirect',
169
+ url: 'https://storage.example.com/ro-crate-metadata.json',
170
+ };
171
+ vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
172
+
173
+ const response = await fastify.inject({
174
+ method: 'GET',
175
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
176
+ });
177
+
178
+ expect(response.statusCode).toBe(302);
179
+ expect(response.headers.location).toBe('https://storage.example.com/ro-crate-metadata.json');
180
+ });
181
+
182
+ it('should handle file path response without nginx X-Accel-Redirect', async () => {
183
+ prisma.entity.findFirst.mockResolvedValue(mockCollectionEntity);
184
+
185
+ const mockStream = Readable.from(['rocrate content']);
186
+ vi.mocked(createReadStream).mockReturnValue(mockStream as never);
187
+
188
+ const mockResult: FileResult = {
189
+ type: 'file',
190
+ path: '/data/rocrate/ro-crate-metadata.json',
191
+ metadata: {
192
+ contentType: 'application/ld+json',
193
+ contentLength: 1024,
194
+ },
195
+ };
196
+ vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
197
+
198
+ const response = await fastify.inject({
199
+ method: 'GET',
200
+ url: `/entity/${encodeURIComponent('http://example.com/collection')}/rocrate`,
201
+ });
202
+
203
+ expect(response.statusCode).toBe(200);
204
+ expect(response.headers['content-type']).toBe('application/ld+json');
205
+ expect(response.headers['content-length']).toBe('1024');
206
+ expect(response.headers['x-accel-redirect']).toBeUndefined();
207
+ expect(createReadStream).toHaveBeenCalledWith('/data/rocrate/ro-crate-metadata.json');
208
+ });
209
+
210
+ it('should handle file path response with nginx X-Accel-Redirect', async () => {
211
+ prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
212
+
213
+ const mockResult: FileResult = {
214
+ type: 'file',
215
+ path: '/data/rocrate/ro-crate-metadata.json',
216
+ accelPath: '/internal/rocrate/ro-crate-metadata.json',
217
+ metadata: {
218
+ contentType: 'application/ld+json',
219
+ contentLength: 2048,
220
+ },
221
+ };
222
+ vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
223
+
224
+ const response = await fastify.inject({
225
+ method: 'GET',
226
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
227
+ });
228
+
229
+ expect(response.statusCode).toBe(200);
230
+ expect(response.headers['content-type']).toBe('application/ld+json');
231
+ expect(response.headers['x-accel-redirect']).toBe('/internal/rocrate/ro-crate-metadata.json');
232
+ expect(response.body).toBe('');
233
+ });
234
+
235
+ it('should return 404 when entity not found', async () => {
236
+ prisma.entity.findFirst.mockResolvedValue(null);
237
+
238
+ const response = await fastify.inject({
239
+ method: 'GET',
240
+ url: `/entity/${encodeURIComponent('http://example.com/nonexistent')}/rocrate`,
241
+ });
242
+ const body = JSON.parse(response.body) as { error: { code: string; message: string } };
243
+
244
+ expect(response.statusCode).toBe(404);
245
+ expect(body.error.code).toBe('NOT_FOUND');
246
+ expect(body.error.message).toBe('The requested entity was not found');
247
+ expect(mockRoCrateHandler.get).not.toHaveBeenCalled();
248
+ });
249
+
250
+ it('should return 404 when handler returns false', async () => {
251
+ prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
252
+ vi.mocked(mockRoCrateHandler.get).mockResolvedValue(false);
253
+
254
+ const response = await fastify.inject({
255
+ method: 'GET',
256
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
257
+ });
258
+ const body = JSON.parse(response.body) as { error: { code: string; message: string } };
259
+
260
+ expect(response.statusCode).toBe(404);
261
+ expect(body.error.code).toBe('NOT_FOUND');
262
+ expect(body.error.message).toBe('The requested RO-Crate could not be retrieved');
263
+ });
264
+
265
+ it('should return 500 when database error occurs', async () => {
266
+ prisma.entity.findFirst.mockRejectedValue(new Error('Database connection failed'));
267
+
268
+ const response = await fastify.inject({
269
+ method: 'GET',
270
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
271
+ });
272
+ const body = JSON.parse(response.body) as { error: { code: string } };
273
+
274
+ expect(response.statusCode).toBe(500);
275
+ expect(body.error.code).toBe('INTERNAL_ERROR');
276
+ });
277
+
278
+ it('should return 500 when roCrateHandler throws error', async () => {
279
+ prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
280
+ vi.mocked(mockRoCrateHandler.get).mockRejectedValue(new Error('RO-Crate error'));
281
+
282
+ const response = await fastify.inject({
283
+ method: 'GET',
284
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
285
+ });
286
+ const body = JSON.parse(response.body) as { error: { code: string } };
287
+
288
+ expect(response.statusCode).toBe(500);
289
+ expect(body.error.code).toBe('INTERNAL_ERROR');
290
+ });
291
+
292
+ it('should validate ID parameter format', async () => {
293
+ const response = await fastify.inject({
294
+ method: 'GET',
295
+ url: '/entity/invalid-id/rocrate',
296
+ });
297
+ const body = JSON.parse(response.body) as StandardErrorResponse;
298
+
299
+ expect(response.statusCode).toBe(400);
300
+ expect(body.error).toBe('Bad Request');
301
+ });
302
+ });
303
+
304
+ describe('HEAD /entity/:id/rocrate', () => {
305
+ it('should return RO-Crate metadata headers for File entity', async () => {
306
+ prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
307
+
308
+ const mockMetadata = {
309
+ contentType: 'application/ld+json',
310
+ contentLength: 1024,
311
+ etag: '"rocrate-etag"',
312
+ lastModified: new Date('2025-01-15'),
313
+ };
314
+ vi.mocked(mockRoCrateHandler.head).mockResolvedValue(mockMetadata);
315
+
316
+ const response = await fastify.inject({
317
+ method: 'HEAD',
318
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
319
+ });
320
+
321
+ expect(response.statusCode).toBe(200);
322
+ expect(response.headers['content-type']).toBe('application/ld+json');
323
+ expect(response.headers['content-length']).toBe('1024');
324
+ expect(response.headers.etag).toBe('"rocrate-etag"');
325
+ expect(response.body).toBe('');
326
+
327
+ expect(mockRoCrateHandler.head).toHaveBeenCalledWith(
328
+ mockFileEntity,
329
+ expect.objectContaining({
330
+ request: expect.any(Object),
331
+ fastify: expect.any(Object),
332
+ }),
333
+ );
334
+ });
335
+
336
+ it('should return RO-Crate metadata headers for Collection entity', async () => {
337
+ prisma.entity.findFirst.mockResolvedValue(mockCollectionEntity);
338
+
339
+ const mockMetadata = {
340
+ contentType: 'text/plain',
341
+ contentLength: 512,
342
+ };
343
+ vi.mocked(mockRoCrateHandler.head).mockResolvedValue(mockMetadata);
344
+
345
+ const response = await fastify.inject({
346
+ method: 'HEAD',
347
+ url: `/entity/${encodeURIComponent('http://example.com/collection')}/rocrate`,
348
+ });
349
+
350
+ expect(response.statusCode).toBe(200);
351
+ expect(response.headers['content-type']).toBe('text/plain');
352
+ expect(response.headers['content-length']).toBe('512');
353
+ expect(response.body).toBe('');
354
+ });
355
+
356
+ it('should return RO-Crate metadata headers for Object entity', async () => {
357
+ prisma.entity.findFirst.mockResolvedValue(mockObjectEntity);
358
+
359
+ const mockMetadata = {
360
+ contentType: 'application/json',
361
+ contentLength: 2048,
362
+ };
363
+ vi.mocked(mockRoCrateHandler.head).mockResolvedValue(mockMetadata);
364
+
365
+ const response = await fastify.inject({
366
+ method: 'HEAD',
367
+ url: `/entity/${encodeURIComponent('http://example.com/object')}/rocrate`,
368
+ });
369
+
370
+ expect(response.statusCode).toBe(200);
371
+ expect(response.headers['content-type']).toBe('application/json');
372
+ expect(response.headers['content-length']).toBe('2048');
373
+ expect(response.body).toBe('');
374
+ });
375
+
376
+ it('should return 404 when entity not found', async () => {
377
+ prisma.entity.findFirst.mockResolvedValue(null);
378
+
379
+ const response = await fastify.inject({
380
+ method: 'HEAD',
381
+ url: `/entity/${encodeURIComponent('http://example.com/nonexistent')}/rocrate`,
382
+ });
383
+ const body = JSON.parse(response.body) as { error: { code: string } };
384
+
385
+ expect(response.statusCode).toBe(404);
386
+ expect(body.error.code).toBe('NOT_FOUND');
387
+ expect(mockRoCrateHandler.head).not.toHaveBeenCalled();
388
+ });
389
+
390
+ it('should return 404 when head handler returns false', async () => {
391
+ prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
392
+ vi.mocked(mockRoCrateHandler.head).mockResolvedValue(false);
393
+
394
+ const response = await fastify.inject({
395
+ method: 'HEAD',
396
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
397
+ });
398
+ const body = JSON.parse(response.body) as { error: { code: string; message: string } };
399
+
400
+ expect(response.statusCode).toBe(404);
401
+ expect(body.error.code).toBe('NOT_FOUND');
402
+ expect(body.error.message).toBe('The requested RO-Crate metadata was not found');
403
+ });
404
+
405
+ it('should return 500 when head handler throws error', async () => {
406
+ prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
407
+ vi.mocked(mockRoCrateHandler.head).mockRejectedValue(new Error('Metadata error'));
408
+
409
+ const response = await fastify.inject({
410
+ method: 'HEAD',
411
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
412
+ });
413
+ const body = JSON.parse(response.body) as { error: { code: string } };
414
+
415
+ expect(response.statusCode).toBe(500);
416
+ expect(body.error.code).toBe('INTERNAL_ERROR');
417
+ });
418
+ });
419
+
420
+ describe('GET /entity/:id/rocrate - exhaustiveness check', () => {
421
+ it('should handle unexpected RO-Crate result type', async () => {
422
+ prisma.entity.findFirst.mockResolvedValue(mockFileEntity);
423
+
424
+ // Mock an invalid result type to test exhaustiveness check
425
+ const invalidResult = {
426
+ type: 'invalid',
427
+ metadata: { contentType: 'application/ld+json', contentLength: 1024 },
428
+ };
429
+ vi.mocked(mockRoCrateHandler.get).mockResolvedValue(invalidResult as never);
430
+
431
+ const response = await fastify.inject({
432
+ method: 'GET',
433
+ url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/rocrate`,
434
+ });
435
+ const body = JSON.parse(response.body) as { error: { code: string } };
436
+
437
+ expect(response.statusCode).toBe(500);
438
+ expect(body.error.code).toBe('INTERNAL_ERROR');
439
+ });
440
+ });
441
+ });
@@ -0,0 +1,141 @@
1
+ import { createReadStream } from 'node:fs';
2
+ import type { FastifyPluginAsync, FastifyReply } from 'fastify';
3
+ import type { ZodTypeProvider } from 'fastify-type-provider-zod';
4
+ import { z } from 'zod/v4';
5
+ import type { FileMetadata, RoCrateHandler } from '../types/fileHandlers.js';
6
+ import { createInternalError, createNotFoundError } from '../utils/errors.js';
7
+
8
+ const paramsSchema = z.object({
9
+ id: z.string().regex(/^https?:\/\/.+/, 'Invalid URI format'),
10
+ });
11
+
12
+ type CrateRouteOptions = {
13
+ roCrateHandler: RoCrateHandler;
14
+ };
15
+
16
+ const setFileHeaders = (
17
+ reply: FastifyReply,
18
+ metadata: { contentType: string; contentLength: number; etag?: string; lastModified?: Date },
19
+ ) => {
20
+ reply.header('Content-Type', metadata.contentType);
21
+ reply.header('Content-Length', metadata.contentLength.toString());
22
+
23
+ if (metadata.etag) {
24
+ reply.header('ETag', metadata.etag);
25
+ }
26
+ if (metadata.lastModified) {
27
+ reply.header('Last-Modified', metadata.lastModified.toUTCString());
28
+ }
29
+ };
30
+
31
+ const crate: FastifyPluginAsync<CrateRouteOptions> = async (fastify, opts) => {
32
+ const { roCrateHandler } = opts;
33
+
34
+ fastify.withTypeProvider<ZodTypeProvider>().head(
35
+ '/entity/:id/rocrate',
36
+ {
37
+ schema: {
38
+ params: paramsSchema,
39
+ },
40
+ },
41
+ async (request, reply) => {
42
+ const { id } = request.params;
43
+
44
+ try {
45
+ const entity = await fastify.prisma.entity.findFirst({
46
+ where: {
47
+ rocrateId: id,
48
+ },
49
+ });
50
+
51
+ if (!entity) {
52
+ return reply.code(404).send(createNotFoundError('The requested entity was not found', id));
53
+ }
54
+
55
+ const metadata: FileMetadata | false = await roCrateHandler.head(entity, {
56
+ request,
57
+ fastify,
58
+ });
59
+
60
+ if (!metadata) {
61
+ return reply.code(404).send(createNotFoundError('The requested RO-Crate metadata was not found', id));
62
+ }
63
+
64
+ setFileHeaders(reply, metadata);
65
+
66
+ return reply.code(200).send();
67
+ } catch (error) {
68
+ fastify.log.error('RO-Crate metadata retrieval error:', error);
69
+ return reply.code(500).send(createInternalError());
70
+ }
71
+ },
72
+ );
73
+
74
+ fastify.withTypeProvider<ZodTypeProvider>().get(
75
+ '/entity/:id/rocrate',
76
+ {
77
+ schema: {
78
+ params: paramsSchema,
79
+ },
80
+ },
81
+ async (request, reply) => {
82
+ const { id } = request.params;
83
+
84
+ try {
85
+ const entity = await fastify.prisma.entity.findFirst({
86
+ where: {
87
+ rocrateId: id,
88
+ },
89
+ });
90
+
91
+ if (!entity) {
92
+ return reply.code(404).send(createNotFoundError('The requested entity was not found', id));
93
+ }
94
+
95
+ const result = await roCrateHandler.get(entity, {
96
+ request,
97
+ fastify,
98
+ });
99
+
100
+ if (!result) {
101
+ return reply.code(404).send(createNotFoundError('The requested RO-Crate could not be retrieved', id));
102
+ }
103
+
104
+ if (result.type === 'redirect') {
105
+ return reply.code(302).redirect(result.url);
106
+ }
107
+
108
+ // Set content type to application/ld+json for RO-Crate
109
+ const metadata = {
110
+ ...result.metadata,
111
+ contentType: 'application/ld+json',
112
+ };
113
+
114
+ setFileHeaders(reply, metadata);
115
+
116
+ // Handle stream response
117
+ if (result.type === 'stream') {
118
+ return reply.code(200).send(result.stream);
119
+ }
120
+
121
+ if (result.type === 'file') {
122
+ if (result.accelPath) {
123
+ reply.header('X-Accel-Redirect', result.accelPath);
124
+ return reply.code(200).send();
125
+ }
126
+
127
+ const stream = createReadStream(result.path);
128
+ return reply.code(200).send(stream);
129
+ }
130
+
131
+ // Exhaustiveness check - should never reach here with proper types
132
+ throw new Error(`Unexpected RO-Crate result type: ${(result as { type: string }).type}`);
133
+ } catch (error) {
134
+ fastify.log.error('RO-Crate retrieval error:', error);
135
+ return reply.code(500).send(createInternalError());
136
+ }
137
+ },
138
+ );
139
+ };
140
+
141
+ export default crate;