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