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,320 +0,0 @@
1
- import { afterEach, beforeEach, describe, expect, it } from 'vitest';
2
-
3
- import { fastify, fastifyAfter, fastifyBefore, prisma } from '../test/helpers/fastify.js';
4
- import { AllPublicAccessTransformer } from '../transformers/default.js';
5
- import entitiesRoute from './entities.js';
6
-
7
- describe('Entities Route', () => {
8
- beforeEach(async () => {
9
- await fastifyBefore();
10
- await fastify.register(entitiesRoute, { prisma, accessTransformer: AllPublicAccessTransformer });
11
- });
12
-
13
- afterEach(async () => {
14
- await fastifyAfter();
15
- });
16
-
17
- describe('GET /entities', () => {
18
- it('should return entities with default pagination', async () => {
19
- const mockEntities = [
20
- {
21
- id: 'http://example.com/entity/1',
22
- name: 'Test Entity 1',
23
- description: 'First test entity',
24
- entityType: 'http://pcdm.org/models#Collection',
25
-
26
- memberOf: null,
27
- rootCollection: null,
28
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
29
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
30
- createdAt: new Date(),
31
- updatedAt: new Date(),
32
- meta: {},
33
- },
34
- {
35
- id: 'http://example.com/entity/2',
36
- name: 'Test Entity 2',
37
- description: 'Second test entity',
38
- entityType: 'http://pcdm.org/models#Object',
39
-
40
- memberOf: 'http://example.com/entity/1',
41
- rootCollection: 'http://example.com/entity/1',
42
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
43
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
44
- createdAt: new Date(),
45
- updatedAt: new Date(),
46
- meta: {},
47
- },
48
- ];
49
-
50
- prisma.entity.findMany.mockResolvedValue(mockEntities);
51
- prisma.entity.count.mockResolvedValue(2);
52
-
53
- const response = await fastify.inject({
54
- method: 'GET',
55
- url: '/entities',
56
- });
57
- const body = JSON.parse(response.body);
58
-
59
- expect(response.statusCode).toBe(200);
60
- expect(body).toMatchSnapshot();
61
- expect(prisma.entity.findMany).toHaveBeenCalledWith({
62
- where: {},
63
- include: { file: { select: { id: true } } },
64
- orderBy: { id: 'asc' },
65
- skip: 0,
66
- take: 100,
67
- });
68
- });
69
-
70
- it('should filter by memberOf', async () => {
71
- prisma.entity.findMany.mockResolvedValue([]);
72
- prisma.entity.count.mockResolvedValue(0);
73
-
74
- const response = await fastify.inject({
75
- method: 'GET',
76
- url: '/entities',
77
- query: {
78
- memberOf: 'http://example.com/collection/1',
79
- },
80
- });
81
-
82
- expect(response.statusCode).toBe(200);
83
- expect(prisma.entity.findMany).toHaveBeenCalledWith({
84
- where: { memberOf: 'http://example.com/collection/1' },
85
- include: { file: { select: { id: true } } },
86
- orderBy: { id: 'asc' },
87
- skip: 0,
88
- take: 100,
89
- });
90
- });
91
-
92
- it('should filter by single entity type', async () => {
93
- prisma.entity.findMany.mockResolvedValue([]);
94
- prisma.entity.count.mockResolvedValue(0);
95
-
96
- const response = await fastify.inject({
97
- method: 'GET',
98
- url: '/entities',
99
- query: {
100
- entityType: 'http://pcdm.org/models#Collection',
101
- },
102
- });
103
-
104
- expect(response.statusCode).toBe(200);
105
- expect(prisma.entity.findMany).toHaveBeenCalledWith({
106
- where: { entityType: { in: ['http://pcdm.org/models#Collection'] } },
107
- include: { file: { select: { id: true } } },
108
- orderBy: { id: 'asc' },
109
- skip: 0,
110
- take: 100,
111
- });
112
- });
113
-
114
- it('should filter by multiple entity types', async () => {
115
- prisma.entity.findMany.mockResolvedValue([]);
116
- prisma.entity.count.mockResolvedValue(0);
117
-
118
- const response = await fastify.inject({
119
- method: 'GET',
120
- url: '/entities',
121
- query: {
122
- entityType: 'http://pcdm.org/models#Collection,http://pcdm.org/models#Object',
123
- },
124
- });
125
-
126
- expect(response.statusCode).toBe(200);
127
- expect(prisma.entity.findMany).toHaveBeenCalledWith({
128
- where: {
129
- entityType: {
130
- in: ['http://pcdm.org/models#Collection', 'http://pcdm.org/models#Object'],
131
- },
132
- },
133
- include: { file: { select: { id: true } } },
134
- orderBy: { id: 'asc' },
135
- skip: 0,
136
- take: 100,
137
- });
138
- });
139
-
140
- it('should handle pagination parameters', async () => {
141
- prisma.entity.findMany.mockResolvedValue([]);
142
- prisma.entity.count.mockResolvedValue(0);
143
-
144
- const response = await fastify.inject({
145
- method: 'GET',
146
- url: '/entities',
147
- query: {
148
- limit: '50',
149
- offset: '10',
150
- },
151
- });
152
-
153
- expect(response.statusCode).toBe(200);
154
- expect(prisma.entity.findMany).toHaveBeenCalledWith({
155
- where: {},
156
- include: { file: { select: { id: true } } },
157
- orderBy: { id: 'asc' },
158
- skip: 10,
159
- take: 50,
160
- });
161
- });
162
-
163
- it('should handle sorting by name descending', async () => {
164
- prisma.entity.findMany.mockResolvedValue([]);
165
- prisma.entity.count.mockResolvedValue(0);
166
-
167
- const response = await fastify.inject({
168
- method: 'GET',
169
- url: '/entities',
170
- query: {
171
- sort: 'name',
172
- order: 'desc',
173
- },
174
- });
175
-
176
- expect(response.statusCode).toBe(200);
177
- expect(prisma.entity.findMany).toHaveBeenCalledWith({
178
- where: {},
179
- include: { file: { select: { id: true } } },
180
- orderBy: { name: 'desc' },
181
- skip: 0,
182
- take: 100,
183
- });
184
- });
185
-
186
- it('should sort by id field directly', async () => {
187
- prisma.entity.findMany.mockResolvedValue([]);
188
- prisma.entity.count.mockResolvedValue(0);
189
-
190
- const response = await fastify.inject({
191
- method: 'GET',
192
- url: '/entities',
193
- query: {
194
- sort: 'id',
195
- },
196
- });
197
-
198
- expect(response.statusCode).toBe(200);
199
- expect(prisma.entity.findMany).toHaveBeenCalledWith({
200
- where: {},
201
- include: { file: { select: { id: true } } },
202
- orderBy: { id: 'asc' },
203
- skip: 0,
204
- take: 100,
205
- });
206
- });
207
-
208
- it('should return 500 when database error occurs', async () => {
209
- prisma.entity.findMany.mockRejectedValue(new Error('Database connection failed'));
210
-
211
- const response = await fastify.inject({
212
- method: 'GET',
213
- url: '/entities',
214
- });
215
-
216
- expect(response.statusCode).toBe(500);
217
- const body = JSON.parse(response.body);
218
- expect(body).toMatchSnapshot();
219
- });
220
-
221
- it('should validate limit parameter bounds', async () => {
222
- const response = await fastify.inject({
223
- method: 'GET',
224
- url: '/entities',
225
- query: {
226
- limit: '0',
227
- },
228
- });
229
-
230
- expect(response.statusCode).toBe(400);
231
- });
232
-
233
- it('should validate negative offset', async () => {
234
- const response = await fastify.inject({
235
- method: 'GET',
236
- url: '/entities',
237
- query: {
238
- offset: '-1',
239
- },
240
- });
241
-
242
- expect(response.statusCode).toBe(400);
243
- });
244
-
245
- it('should apply custom entity transformers', async () => {
246
- // biome-ignore lint/suspicious/noExplicitAny: fine in tests
247
- const customTransformer = async (entity: any) => ({
248
- ...entity,
249
- tested: true,
250
- });
251
-
252
- await fastifyBefore();
253
- await fastify.register(entitiesRoute, {
254
- prisma,
255
- accessTransformer: AllPublicAccessTransformer,
256
- entityTransformers: [customTransformer],
257
- });
258
-
259
- const mockEntities = [
260
- {
261
- id: 'http://example.com/entity/1',
262
- name: 'Test Entity 1',
263
- description: 'First test entity',
264
- entityType: 'http://pcdm.org/models#Collection',
265
- memberOf: null,
266
- rootCollection: null,
267
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
268
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
269
- createdAt: new Date(),
270
- updatedAt: new Date(),
271
- },
272
- ];
273
-
274
- // @ts-expect-error TS is looking at the wronf function signature
275
- prisma.entity.findMany.mockResolvedValue(mockEntities);
276
-
277
- const response = await fastify.inject({
278
- method: 'GET',
279
- url: '/entities',
280
- });
281
- const body = JSON.parse(response.body);
282
-
283
- expect(response.statusCode).toBe(200);
284
- expect(body).toMatchSnapshot();
285
- });
286
-
287
- it('should return null for memberOf/rootCollection when parent entity not found', async () => {
288
- const mockEntities = [
289
- {
290
- id: 'http://example.com/entity/1',
291
- name: 'Test Entity 1',
292
- description: 'Entity with missing parent',
293
- entityType: 'http://pcdm.org/models#Object',
294
-
295
- memberOf: 'http://example.com/entity/deleted',
296
- rootCollection: 'http://example.com/entity/deleted',
297
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
298
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
299
- createdAt: new Date(),
300
- updatedAt: new Date(),
301
- meta: {},
302
- },
303
- ];
304
-
305
- // First call returns entities, second call (for reference resolution) returns empty
306
- prisma.entity.findMany.mockResolvedValueOnce(mockEntities);
307
- prisma.entity.findMany.mockResolvedValueOnce([]);
308
- prisma.entity.count.mockResolvedValue(1);
309
-
310
- const response = await fastify.inject({
311
- method: 'GET',
312
- url: '/entities',
313
- });
314
- const body = JSON.parse(response.body);
315
-
316
- expect(response.statusCode).toBe(200);
317
- expect(body).toMatchSnapshot();
318
- });
319
- });
320
- });
@@ -1,160 +0,0 @@
1
- import { afterEach, beforeEach, describe, expect, it } from 'vitest';
2
-
3
- import { fastify, fastifyAfter, fastifyBefore, prisma } from '../test/helpers/fastify.js';
4
- import { AllPublicAccessTransformer } from '../transformers/default.js';
5
- import type { StandardErrorResponse } from '../utils/errors.js';
6
- import entityRoute from './entity.js';
7
-
8
- describe('Entity Route', () => {
9
- beforeEach(async () => {
10
- await fastifyBefore();
11
- await fastify.register(entityRoute, { prisma, accessTransformer: AllPublicAccessTransformer });
12
- });
13
-
14
- afterEach(async () => {
15
- await fastifyAfter();
16
- });
17
-
18
- describe('GET /entity/:id', () => {
19
- it('should return entity when found', async () => {
20
- const mockEntity = {
21
- id: 'http://example.com/entity/123',
22
- name: 'Test Entity',
23
- description: 'A test entity',
24
- entityType: 'http://schema.org/Person',
25
-
26
- memberOf: null,
27
- rootCollection: null,
28
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
29
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
30
- createdAt: new Date(),
31
- updatedAt: new Date(),
32
- meta: {},
33
- };
34
-
35
- prisma.entity.findUnique.mockResolvedValue(mockEntity);
36
-
37
- const response = await fastify.inject({
38
- method: 'GET',
39
- url: `/entity/${encodeURIComponent('http://example.com/entity/123')}`,
40
- });
41
- const body = JSON.parse(response.body);
42
-
43
- expect(response.statusCode).toBe(200);
44
- expect(body).toMatchSnapshot();
45
- expect(prisma.entity.findUnique).toHaveBeenCalledWith({
46
- where: {
47
- id: 'http://example.com/entity/123',
48
- },
49
- include: { file: { select: { id: true } } },
50
- });
51
- });
52
-
53
- it('should return 404 when entity not found', async () => {
54
- prisma.entity.findUnique.mockResolvedValue(null);
55
-
56
- const response = await fastify.inject({
57
- method: 'GET',
58
- url: `/entity/${encodeURIComponent('http://example.com/entity/nonexistent')}`,
59
- });
60
- const body = JSON.parse(response.body);
61
-
62
- expect(response.statusCode).toBe(404);
63
- expect(body).toMatchSnapshot();
64
- });
65
-
66
- it('should return 500 when database error occurs', async () => {
67
- prisma.entity.findUnique.mockRejectedValue(new Error('Database connection failed'));
68
-
69
- const response = await fastify.inject({
70
- method: 'GET',
71
- url: `/entity/${encodeURIComponent('http://example.com/entity/123')}`,
72
- });
73
- const body = JSON.parse(response.body);
74
-
75
- expect(response.statusCode).toBe(500);
76
- expect(body).toMatchSnapshot();
77
- });
78
-
79
- it('should validate ID parameter format', async () => {
80
- const response = await fastify.inject({
81
- method: 'GET',
82
- url: '/entity/invalid-id',
83
- });
84
- const body = JSON.parse(response.body) as StandardErrorResponse;
85
-
86
- expect(response.statusCode).toBe(400);
87
- expect(body.error).toBe('Bad Request');
88
- });
89
-
90
- it('should apply custom entity transformers', async () => {
91
- // biome-ignore lint/suspicious/noExplicitAny: fine in tests
92
- const customTransformer = async (entity: any) => ({
93
- ...entity,
94
- tested: true,
95
- });
96
-
97
- await fastifyBefore();
98
- await fastify.register(entityRoute, {
99
- prisma,
100
- accessTransformer: AllPublicAccessTransformer,
101
- entityTransformers: [customTransformer],
102
- });
103
-
104
- const mockEntity = {
105
- id: 'http://example.com/entity/123',
106
- name: 'Test Entity',
107
- description: 'A test entity',
108
- entityType: 'http://pcdm.org/models#Collection',
109
- memberOf: null,
110
- rootCollection: null,
111
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
112
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
113
- createdAt: new Date(),
114
- updatedAt: new Date(),
115
- };
116
-
117
- // @ts-expect-error TS is looking at the wronf function signature
118
- prisma.entity.findUnique.mockResolvedValue(mockEntity);
119
-
120
- const response = await fastify.inject({
121
- method: 'GET',
122
- url: `/entity/${encodeURIComponent('http://example.com/entity/123')}`,
123
- });
124
- const body = JSON.parse(response.body);
125
-
126
- expect(response.statusCode).toBe(200);
127
- expect(body).toMatchSnapshot();
128
- });
129
-
130
- it('should return null for memberOf/rootCollection when parent entity not found', async () => {
131
- const mockEntity = {
132
- id: 'http://example.com/entity/123',
133
- name: 'Test Entity',
134
- description: 'A test entity',
135
- entityType: 'http://pcdm.org/models#Object',
136
-
137
- memberOf: 'http://example.com/entity/deleted',
138
- rootCollection: 'http://example.com/entity/deleted',
139
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
140
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
141
- createdAt: new Date(),
142
- updatedAt: new Date(),
143
- meta: {},
144
- };
145
-
146
- // First call returns the entity, second call (for reference resolution) returns empty
147
- prisma.entity.findUnique.mockResolvedValue(mockEntity);
148
- prisma.entity.findMany.mockResolvedValue([]);
149
-
150
- const response = await fastify.inject({
151
- method: 'GET',
152
- url: `/entity/${encodeURIComponent('http://example.com/entity/123')}`,
153
- });
154
- const body = JSON.parse(response.body);
155
-
156
- expect(response.statusCode).toBe(200);
157
- expect(body).toMatchSnapshot();
158
- });
159
- });
160
- });