arocapi 1.0.5 → 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 (165) hide show
  1. package/README.md +597 -29
  2. package/dist/app.d.ts +27 -6
  3. package/dist/app.js +76 -17
  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/express.d.ts +3 -2
  8. package/dist/express.js +11 -11
  9. package/dist/express.js.map +1 -1
  10. package/dist/index.dev.d.ts +8 -0
  11. package/dist/index.dev.js +146 -0
  12. package/dist/index.dev.js.map +1 -0
  13. package/dist/routes/crate.d.ts +7 -0
  14. package/dist/routes/crate.js +99 -0
  15. package/dist/routes/crate.js.map +1 -0
  16. package/dist/routes/crate.test.d.ts +1 -0
  17. package/dist/routes/crate.test.js +360 -0
  18. package/dist/routes/crate.test.js.map +1 -0
  19. package/dist/routes/entities.d.ts +8 -0
  20. package/dist/routes/entities.js +75 -0
  21. package/dist/routes/entities.js.map +1 -0
  22. package/dist/routes/entities.test.d.ts +1 -0
  23. package/dist/routes/entities.test.js +245 -0
  24. package/dist/routes/entities.test.js.map +1 -0
  25. package/dist/routes/entity.d.ts +8 -0
  26. package/dist/routes/entity.js +45 -0
  27. package/dist/routes/entity.js.map +1 -0
  28. package/dist/routes/entity.test.d.ts +1 -0
  29. package/dist/routes/entity.test.js +109 -0
  30. package/dist/routes/entity.test.js.map +1 -0
  31. package/dist/routes/file.d.ts +7 -0
  32. package/dist/routes/file.js +111 -0
  33. package/dist/routes/file.js.map +1 -0
  34. package/dist/routes/file.test.d.ts +1 -0
  35. package/dist/routes/file.test.js +319 -0
  36. package/dist/routes/file.test.js.map +1 -0
  37. package/dist/routes/files.d.ts +8 -0
  38. package/dist/routes/files.js +61 -0
  39. package/dist/routes/files.js.map +1 -0
  40. package/dist/routes/files.test.d.ts +1 -0
  41. package/dist/routes/files.test.js +244 -0
  42. package/dist/routes/files.test.js.map +1 -0
  43. package/dist/routes/search.d.ts +8 -0
  44. package/dist/routes/{search/index.js → search.js} +45 -19
  45. package/dist/routes/search.js.map +1 -0
  46. package/dist/routes/search.test.d.ts +1 -0
  47. package/dist/routes/search.test.js +698 -0
  48. package/dist/routes/search.test.js.map +1 -0
  49. package/dist/test/helpers/fastify.d.ts +9 -0
  50. package/dist/test/helpers/fastify.js +24 -0
  51. package/dist/test/helpers/fastify.js.map +1 -0
  52. package/dist/test/integration.setup.d.ts +58 -0
  53. package/dist/test/integration.setup.js +181 -0
  54. package/dist/test/integration.setup.js.map +1 -0
  55. package/dist/test/integration.test.d.ts +1 -0
  56. package/dist/test/integration.test.js +337 -0
  57. package/dist/test/integration.test.js.map +1 -0
  58. package/dist/transformers/default.d.ts +45 -0
  59. package/dist/transformers/default.js +46 -0
  60. package/dist/transformers/default.js.map +1 -0
  61. package/dist/transformers/default.test.d.ts +1 -0
  62. package/dist/transformers/default.test.js +177 -0
  63. package/dist/transformers/default.test.js.map +1 -0
  64. package/dist/transformers/transformer.test.d.ts +1 -0
  65. package/dist/transformers/transformer.test.js +176 -0
  66. package/dist/transformers/transformer.test.js.map +1 -0
  67. package/dist/types/fileHandlers.d.ts +41 -0
  68. package/dist/types/fileHandlers.js +2 -0
  69. package/dist/types/fileHandlers.js.map +1 -0
  70. package/dist/types/transformers.d.ts +10 -0
  71. package/dist/types/transformers.js +2 -0
  72. package/dist/types/transformers.js.map +1 -0
  73. package/dist/utils/errors.d.ts +23 -0
  74. package/dist/utils/errors.js +21 -0
  75. package/dist/utils/errors.js.map +1 -0
  76. package/dist/utils/errors.test.d.ts +1 -0
  77. package/dist/utils/errors.test.js +66 -0
  78. package/dist/utils/errors.test.js.map +1 -0
  79. package/package.json +34 -25
  80. package/prisma/migrations/20250827033956_record_type_scalar/migration.sql +10 -0
  81. package/prisma/migrations/20250923032753_api_refactor/migration.sql +39 -0
  82. package/prisma/migrations/20250923223119_entity_type_to_string/migration.sql +8 -0
  83. package/prisma/migrations/20251020140329_add_meta_column/migration.sql +2 -0
  84. package/prisma/migrations/20251027010713_add_file_table/migration.sql +17 -0
  85. package/prisma/migrations/20251027221138_add_file_id_to_entity/migration.sql +2 -0
  86. package/prisma/models/entity.prisma +16 -12
  87. package/prisma/models/file.prisma +20 -0
  88. package/prisma/schema.prisma +1 -20
  89. package/prisma.config.ts +6 -7
  90. package/src/__snapshots__/app.test.ts.snap +8 -0
  91. package/src/app.test.ts +158 -0
  92. package/src/app.ts +150 -30
  93. package/src/express.ts +12 -11
  94. package/src/index.dev.ts +196 -0
  95. package/src/reset.d.ts +1 -0
  96. package/src/routes/__snapshots__/entities.test.ts.snap +68 -0
  97. package/src/routes/__snapshots__/entity.test.ts.snap +66 -0
  98. package/src/routes/__snapshots__/search.test.ts.snap +139 -0
  99. package/src/routes/crate.test.ts +441 -0
  100. package/src/routes/crate.ts +141 -0
  101. package/src/routes/entities.test.ts +284 -0
  102. package/src/routes/entities.ts +101 -0
  103. package/src/routes/entity.test.ts +132 -0
  104. package/src/routes/entity.ts +63 -0
  105. package/src/routes/file.test.ts +399 -0
  106. package/src/routes/file.ts +153 -0
  107. package/src/routes/files.test.ts +303 -0
  108. package/src/routes/files.ts +87 -0
  109. package/src/routes/search.test.ts +807 -0
  110. package/src/routes/{search/index.ts → search.ts} +67 -24
  111. package/src/test/__snapshots__/integration.test.ts.snap +18 -0
  112. package/src/test/helpers/fastify.ts +39 -0
  113. package/src/test/integration.setup.ts +200 -0
  114. package/src/test/integration.test.ts +411 -0
  115. package/src/transformers/default.test.ts +199 -0
  116. package/src/transformers/default.ts +165 -0
  117. package/src/transformers/transformer.test.ts +233 -0
  118. package/src/types/fileHandlers.ts +65 -0
  119. package/src/types/transformers.ts +52 -0
  120. package/src/utils/errors.test.ts +75 -0
  121. package/src/utils/errors.ts +45 -0
  122. package/dist/plugins/cors.d.ts +0 -3
  123. package/dist/plugins/cors.js +0 -6
  124. package/dist/plugins/cors.js.map +0 -1
  125. package/dist/plugins/opensearch.d.ts +0 -9
  126. package/dist/plugins/opensearch.js +0 -22
  127. package/dist/plugins/opensearch.js.map +0 -1
  128. package/dist/plugins/prisma.d.ts +0 -8
  129. package/dist/plugins/prisma.js +0 -11
  130. package/dist/plugins/prisma.js.map +0 -1
  131. package/dist/plugins/sensible.d.ts +0 -3
  132. package/dist/plugins/sensible.js +0 -6
  133. package/dist/plugins/sensible.js.map +0 -1
  134. package/dist/plugins/support.d.ts +0 -9
  135. package/dist/plugins/support.js +0 -5
  136. package/dist/plugins/support.js.map +0 -1
  137. package/dist/plugins/validation.d.ts +0 -3
  138. package/dist/plugins/validation.js +0 -32
  139. package/dist/plugins/validation.js.map +0 -1
  140. package/dist/routes/entities/index.d.ts +0 -3
  141. package/dist/routes/entities/index.js +0 -63
  142. package/dist/routes/entities/index.js.map +0 -1
  143. package/dist/routes/entity/index.d.ts +0 -3
  144. package/dist/routes/entity/index.js +0 -24
  145. package/dist/routes/entity/index.js.map +0 -1
  146. package/dist/routes/search/index.d.ts +0 -3
  147. package/dist/routes/search/index.js.map +0 -1
  148. package/dist/scripts/loadEntities.js +0 -170
  149. package/dist/scripts/loadEntities.js.map +0 -1
  150. package/dist/type.d.ts +0 -6
  151. package/dist/type.js +0 -2
  152. package/dist/type.js.map +0 -1
  153. package/src/plugins/README.md +0 -16
  154. package/src/plugins/cors.ts +0 -11
  155. package/src/plugins/opensearch.ts +0 -32
  156. package/src/plugins/prisma.ts +0 -23
  157. package/src/plugins/sensible.ts +0 -11
  158. package/src/plugins/support.ts +0 -20
  159. package/src/plugins/validation.ts +0 -48
  160. package/src/routes/README.md +0 -29
  161. package/src/routes/entities/index.ts +0 -83
  162. package/src/routes/entity/index.ts +0 -28
  163. package/src/scripts/loadEntities.ts +0 -223
  164. package/src/type.ts +0 -7
  165. /package/dist/{scripts/loadEntities.d.ts → app.test.d.ts} +0 -0
@@ -0,0 +1,284 @@
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, { 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: 1,
22
+ rocrateId: 'http://example.com/entity/1',
23
+ name: 'Test Entity 1',
24
+ description: 'First test entity',
25
+ entityType: 'http://pcdm.org/models#Collection',
26
+ fileId: null,
27
+ memberOf: null,
28
+ rootCollection: null,
29
+ metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
30
+ contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
31
+ createdAt: new Date(),
32
+ updatedAt: new Date(),
33
+ rocrate: {},
34
+ meta: {},
35
+ },
36
+ {
37
+ id: 2,
38
+ rocrateId: 'http://example.com/entity/2',
39
+ name: 'Test Entity 2',
40
+ description: 'Second test entity',
41
+ entityType: 'http://pcdm.org/models#Object',
42
+ fileId: null,
43
+ memberOf: 'http://example.com/entity/1',
44
+ rootCollection: 'http://example.com/entity/1',
45
+ metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
46
+ contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
47
+ createdAt: new Date(),
48
+ updatedAt: new Date(),
49
+ rocrate: {},
50
+ meta: {},
51
+ },
52
+ ];
53
+
54
+ prisma.entity.findMany.mockResolvedValue(mockEntities);
55
+ prisma.entity.count.mockResolvedValue(2);
56
+
57
+ const response = await fastify.inject({
58
+ method: 'GET',
59
+ url: '/entities',
60
+ });
61
+ const body = JSON.parse(response.body);
62
+
63
+ expect(response.statusCode).toBe(200);
64
+ expect(body).toMatchSnapshot();
65
+ expect(prisma.entity.findMany).toHaveBeenCalledWith({
66
+ where: {},
67
+ orderBy: { rocrateId: 'asc' },
68
+ skip: 0,
69
+ take: 100,
70
+ });
71
+ });
72
+
73
+ it('should filter by memberOf', async () => {
74
+ prisma.entity.findMany.mockResolvedValue([]);
75
+ prisma.entity.count.mockResolvedValue(0);
76
+
77
+ const response = await fastify.inject({
78
+ method: 'GET',
79
+ url: '/entities',
80
+ query: {
81
+ memberOf: 'http://example.com/collection/1',
82
+ },
83
+ });
84
+
85
+ expect(response.statusCode).toBe(200);
86
+ expect(prisma.entity.findMany).toHaveBeenCalledWith({
87
+ where: { memberOf: 'http://example.com/collection/1' },
88
+ orderBy: { rocrateId: 'asc' },
89
+ skip: 0,
90
+ take: 100,
91
+ });
92
+ });
93
+
94
+ it('should filter by single entity type', async () => {
95
+ prisma.entity.findMany.mockResolvedValue([]);
96
+ prisma.entity.count.mockResolvedValue(0);
97
+
98
+ const response = await fastify.inject({
99
+ method: 'GET',
100
+ url: '/entities',
101
+ query: {
102
+ entityType: 'http://pcdm.org/models#Collection',
103
+ },
104
+ });
105
+
106
+ expect(response.statusCode).toBe(200);
107
+ expect(prisma.entity.findMany).toHaveBeenCalledWith({
108
+ where: { entityType: { in: ['http://pcdm.org/models#Collection'] } },
109
+ orderBy: { rocrateId: 'asc' },
110
+ skip: 0,
111
+ take: 100,
112
+ });
113
+ });
114
+
115
+ it('should filter by multiple entity types', async () => {
116
+ prisma.entity.findMany.mockResolvedValue([]);
117
+ prisma.entity.count.mockResolvedValue(0);
118
+
119
+ const response = await fastify.inject({
120
+ method: 'GET',
121
+ url: '/entities',
122
+ query: {
123
+ entityType: 'http://pcdm.org/models#Collection,http://pcdm.org/models#Object',
124
+ },
125
+ });
126
+
127
+ expect(response.statusCode).toBe(200);
128
+ expect(prisma.entity.findMany).toHaveBeenCalledWith({
129
+ where: {
130
+ entityType: {
131
+ in: ['http://pcdm.org/models#Collection', 'http://pcdm.org/models#Object'],
132
+ },
133
+ },
134
+ orderBy: { rocrateId: '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
+ orderBy: { rocrateId: 'asc' },
157
+ skip: 10,
158
+ take: 50,
159
+ });
160
+ });
161
+
162
+ it('should handle sorting by name descending', async () => {
163
+ prisma.entity.findMany.mockResolvedValue([]);
164
+ prisma.entity.count.mockResolvedValue(0);
165
+
166
+ const response = await fastify.inject({
167
+ method: 'GET',
168
+ url: '/entities',
169
+ query: {
170
+ sort: 'name',
171
+ order: 'desc',
172
+ },
173
+ });
174
+
175
+ expect(response.statusCode).toBe(200);
176
+ expect(prisma.entity.findMany).toHaveBeenCalledWith({
177
+ where: {},
178
+ orderBy: { name: 'desc' },
179
+ skip: 0,
180
+ take: 100,
181
+ });
182
+ });
183
+
184
+ it('should map id sort to rocrateId field', async () => {
185
+ prisma.entity.findMany.mockResolvedValue([]);
186
+ prisma.entity.count.mockResolvedValue(0);
187
+
188
+ const response = await fastify.inject({
189
+ method: 'GET',
190
+ url: '/entities',
191
+ query: {
192
+ sort: 'id',
193
+ },
194
+ });
195
+
196
+ expect(response.statusCode).toBe(200);
197
+ expect(prisma.entity.findMany).toHaveBeenCalledWith({
198
+ where: {},
199
+ orderBy: { rocrateId: 'asc' },
200
+ skip: 0,
201
+ take: 100,
202
+ });
203
+ });
204
+
205
+ it('should return 500 when database error occurs', async () => {
206
+ prisma.entity.findMany.mockRejectedValue(new Error('Database connection failed'));
207
+
208
+ const response = await fastify.inject({
209
+ method: 'GET',
210
+ url: '/entities',
211
+ });
212
+
213
+ expect(response.statusCode).toBe(500);
214
+ const body = JSON.parse(response.body);
215
+ expect(body).toMatchSnapshot();
216
+ });
217
+
218
+ it('should validate limit parameter bounds', async () => {
219
+ const response = await fastify.inject({
220
+ method: 'GET',
221
+ url: '/entities',
222
+ query: {
223
+ limit: '0',
224
+ },
225
+ });
226
+
227
+ expect(response.statusCode).toBe(400);
228
+ });
229
+
230
+ it('should validate negative offset', async () => {
231
+ const response = await fastify.inject({
232
+ method: 'GET',
233
+ url: '/entities',
234
+ query: {
235
+ offset: '-1',
236
+ },
237
+ });
238
+
239
+ expect(response.statusCode).toBe(400);
240
+ });
241
+
242
+ it('should apply custom entity transformers', async () => {
243
+ // biome-ignore lint/suspicious/noExplicitAny: fine in tests
244
+ const customTransformer = async (entity: any) => ({
245
+ ...entity,
246
+ tested: true,
247
+ });
248
+
249
+ await fastifyBefore();
250
+ await fastify.register(entitiesRoute, {
251
+ accessTransformer: AllPublicAccessTransformer,
252
+ entityTransformers: [customTransformer],
253
+ });
254
+
255
+ const mockEntities = [
256
+ {
257
+ id: 1,
258
+ rocrateId: 'http://example.com/entity/1',
259
+ name: 'Test Entity 1',
260
+ description: 'First test entity',
261
+ entityType: 'http://pcdm.org/models#Collection',
262
+ memberOf: null,
263
+ rootCollection: null,
264
+ metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
265
+ contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
266
+ createdAt: new Date(),
267
+ updatedAt: new Date(),
268
+ },
269
+ ];
270
+
271
+ // @ts-expect-error TS is looking at the wronf function signature
272
+ prisma.entity.findMany.mockResolvedValue(mockEntities);
273
+
274
+ const response = await fastify.inject({
275
+ method: 'GET',
276
+ url: '/entities',
277
+ });
278
+ const body = JSON.parse(response.body);
279
+
280
+ expect(response.statusCode).toBe(200);
281
+ expect(body).toMatchSnapshot();
282
+ });
283
+ });
284
+ });
@@ -0,0 +1,101 @@
1
+ import type { FastifyPluginAsync } from 'fastify';
2
+ import type { ZodTypeProvider } from 'fastify-type-provider-zod';
3
+ import { z } from 'zod/v4';
4
+ import { baseEntityTransformer } from '../transformers/default.js';
5
+ import type { AccessTransformer, EntityTransformer } from '../types/transformers.js';
6
+ import { createInternalError } from '../utils/errors.js';
7
+
8
+ const querySchema = z.object({
9
+ memberOf: z.url().optional(),
10
+ entityType: z
11
+ .string()
12
+ .optional()
13
+ .transform((val) => {
14
+ if (!val) return undefined;
15
+
16
+ return val.split(',').map((item) => item.trim());
17
+ })
18
+ .pipe(z.array(z.string()).optional()),
19
+ limit: z.coerce.number().int().min(1).max(1000).default(100),
20
+ offset: z.coerce.number().int().min(0).default(0),
21
+ sort: z.enum(['id', 'name', 'createdAt', 'updatedAt']).default('id'),
22
+ order: z.enum(['asc', 'desc']).default('asc'),
23
+ });
24
+
25
+ type EntitiesRouteOptions = {
26
+ accessTransformer: AccessTransformer;
27
+ entityTransformers?: EntityTransformer[];
28
+ };
29
+
30
+ const entities: FastifyPluginAsync<EntitiesRouteOptions> = async (fastify, opts) => {
31
+ const { accessTransformer, entityTransformers = [] } = opts;
32
+ fastify.withTypeProvider<ZodTypeProvider>().get(
33
+ '/entities',
34
+ {
35
+ schema: {
36
+ querystring: querySchema,
37
+ },
38
+ },
39
+ async (request, reply) => {
40
+ const { memberOf, entityType, limit, offset, sort, order } = request.query;
41
+
42
+ try {
43
+ const where: NonNullable<Parameters<typeof fastify.prisma.entity.findMany>[0]>['where'] = {};
44
+
45
+ if (memberOf) {
46
+ where.memberOf = memberOf;
47
+ }
48
+
49
+ if (entityType && entityType.length > 0) {
50
+ where.entityType = {
51
+ in: entityType,
52
+ };
53
+ }
54
+
55
+ const sortField = sort === 'id' ? 'rocrateId' : sort;
56
+
57
+ const dbEntities = await fastify.prisma.entity.findMany({
58
+ where,
59
+ orderBy: {
60
+ [sortField]: order,
61
+ },
62
+ skip: offset,
63
+ take: limit,
64
+ });
65
+
66
+ const total = await fastify.prisma.entity.count({ where });
67
+
68
+ // Apply transformers to each entity: base -> access -> additional
69
+ const entities = await Promise.all(
70
+ dbEntities.map(async (dbEntity) => {
71
+ const standardEntity = baseEntityTransformer(dbEntity);
72
+ const authorisedEntity = await accessTransformer(standardEntity, {
73
+ request,
74
+ fastify,
75
+ });
76
+
77
+ let result = authorisedEntity;
78
+ for (const transformer of entityTransformers) {
79
+ result = await transformer(result, {
80
+ request,
81
+ fastify,
82
+ });
83
+ }
84
+
85
+ return result;
86
+ }),
87
+ );
88
+
89
+ return {
90
+ total,
91
+ entities,
92
+ };
93
+ } catch (error) {
94
+ fastify.log.error('Database error:', error);
95
+ return reply.code(500).send(createInternalError());
96
+ }
97
+ },
98
+ );
99
+ };
100
+
101
+ export default entities;
@@ -0,0 +1,132 @@
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, { 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: 1,
22
+ rocrateId: 'http://example.com/entity/123',
23
+ name: 'Test Entity',
24
+ description: 'A test entity',
25
+ entityType: 'http://schema.org/Person',
26
+ fileId: null,
27
+ memberOf: null,
28
+ rootCollection: null,
29
+ metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
30
+ contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
31
+ createdAt: new Date(),
32
+ updatedAt: new Date(),
33
+ rocrate: {},
34
+ meta: {},
35
+ };
36
+
37
+ prisma.entity.findFirst.mockResolvedValue(mockEntity);
38
+
39
+ const response = await fastify.inject({
40
+ method: 'GET',
41
+ url: `/entity/${encodeURIComponent('http://example.com/entity/123')}`,
42
+ });
43
+ const body = JSON.parse(response.body);
44
+
45
+ expect(response.statusCode).toBe(200);
46
+ expect(body).toMatchSnapshot();
47
+ expect(prisma.entity.findFirst).toHaveBeenCalledWith({
48
+ where: {
49
+ rocrateId: 'http://example.com/entity/123',
50
+ },
51
+ });
52
+ });
53
+
54
+ it('should return 404 when entity not found', async () => {
55
+ console.log('🪚 ♊');
56
+ prisma.entity.findFirst.mockResolvedValue(null);
57
+
58
+ const response = await fastify.inject({
59
+ method: 'GET',
60
+ url: `/entity/${encodeURIComponent('http://example.com/entity/nonexistent')}`,
61
+ });
62
+ const body = JSON.parse(response.body);
63
+
64
+ expect(response.statusCode).toBe(404);
65
+ expect(body).toMatchSnapshot();
66
+ });
67
+
68
+ it('should return 500 when database error occurs', async () => {
69
+ prisma.entity.findFirst.mockRejectedValue(new Error('Database connection failed'));
70
+
71
+ const response = await fastify.inject({
72
+ method: 'GET',
73
+ url: `/entity/${encodeURIComponent('http://example.com/entity/123')}`,
74
+ });
75
+ const body = JSON.parse(response.body);
76
+
77
+ expect(response.statusCode).toBe(500);
78
+ expect(body).toMatchSnapshot();
79
+ });
80
+
81
+ it('should validate ID parameter format', async () => {
82
+ const response = await fastify.inject({
83
+ method: 'GET',
84
+ url: '/entity/invalid-id',
85
+ });
86
+ const body = JSON.parse(response.body) as StandardErrorResponse;
87
+
88
+ expect(response.statusCode).toBe(400);
89
+ expect(body.error).toBe('Bad Request');
90
+ });
91
+
92
+ it('should apply custom entity transformers', async () => {
93
+ // biome-ignore lint/suspicious/noExplicitAny: fine in tests
94
+ const customTransformer = async (entity: any) => ({
95
+ ...entity,
96
+ tested: true,
97
+ });
98
+
99
+ await fastifyBefore();
100
+ await fastify.register(entityRoute, {
101
+ accessTransformer: AllPublicAccessTransformer,
102
+ entityTransformers: [customTransformer],
103
+ });
104
+
105
+ const mockEntity = {
106
+ id: 1,
107
+ rocrateId: 'http://example.com/entity/123',
108
+ name: 'Test Entity',
109
+ description: 'A test entity',
110
+ entityType: 'http://pcdm.org/models#Collection',
111
+ memberOf: null,
112
+ rootCollection: null,
113
+ metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
114
+ contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
115
+ createdAt: new Date(),
116
+ updatedAt: new Date(),
117
+ };
118
+
119
+ // @ts-expect-error TS is looking at the wronf function signature
120
+ prisma.entity.findFirst.mockResolvedValue(mockEntity);
121
+
122
+ const response = await fastify.inject({
123
+ method: 'GET',
124
+ url: `/entity/${encodeURIComponent('http://example.com/entity/123')}`,
125
+ });
126
+ const body = JSON.parse(response.body);
127
+
128
+ expect(response.statusCode).toBe(200);
129
+ expect(body).toMatchSnapshot();
130
+ });
131
+ });
132
+ });
@@ -0,0 +1,63 @@
1
+ import type { FastifyPluginAsync } from 'fastify';
2
+ import type { ZodTypeProvider } from 'fastify-type-provider-zod';
3
+ import { z } from 'zod/v4';
4
+ import { baseEntityTransformer } from '../transformers/default.js';
5
+ import type { AccessTransformer, EntityTransformer } from '../types/transformers.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 EntityRouteOptions = {
13
+ accessTransformer: AccessTransformer;
14
+ entityTransformers?: EntityTransformer[];
15
+ };
16
+
17
+ const entity: FastifyPluginAsync<EntityRouteOptions> = async (fastify, opts) => {
18
+ const { accessTransformer, entityTransformers = [] } = opts;
19
+ fastify.withTypeProvider<ZodTypeProvider>().get(
20
+ '/entity/:id',
21
+ {
22
+ schema: {
23
+ params: paramsSchema,
24
+ },
25
+ },
26
+ async (request, reply) => {
27
+ const { id } = request.params;
28
+
29
+ try {
30
+ const entity = await fastify.prisma.entity.findFirst({
31
+ where: {
32
+ rocrateId: id,
33
+ },
34
+ });
35
+
36
+ if (!entity) {
37
+ return reply.code(404).send(createNotFoundError('The requested entity was not found', id));
38
+ }
39
+
40
+ const standardEntity = baseEntityTransformer(entity);
41
+ const authorisedEntity = await accessTransformer(standardEntity, {
42
+ request,
43
+ fastify,
44
+ });
45
+
46
+ let result = authorisedEntity;
47
+ for (const transformer of entityTransformers) {
48
+ result = await transformer(result, {
49
+ request,
50
+ fastify,
51
+ });
52
+ }
53
+
54
+ return result;
55
+ } catch (error) {
56
+ fastify.log.error('Database error:', error);
57
+ return reply.code(500).send(createInternalError());
58
+ }
59
+ },
60
+ );
61
+ };
62
+
63
+ export default entity;