arocapi 5.0.0-beta.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 (234) hide show
  1. package/LICENSE.md +1 -1
  2. package/README.md +37 -802
  3. package/dist/app.d.ts +38 -20
  4. package/dist/app.js +62 -40
  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 +37 -57
  11. package/dist/routes/entities.js.map +1 -1
  12. package/dist/routes/entity.d.ts +7 -2
  13. package/dist/routes/entity.js +13 -29
  14. package/dist/routes/entity.js.map +1 -1
  15. package/dist/routes/file.d.ts +8 -2
  16. package/dist/routes/file.js +37 -72
  17. package/dist/routes/file.js.map +1 -1
  18. package/dist/routes/files.d.ts +5 -2
  19. package/dist/routes/files.js +24 -39
  20. package/dist/routes/files.js.map +1 -1
  21. package/dist/routes/metadata.d.ts +11 -5
  22. package/dist/routes/metadata.js +24 -68
  23. package/dist/routes/metadata.js.map +1 -1
  24. package/dist/routes/search.d.ts +8 -7
  25. package/dist/routes/search.js +90 -119
  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 +82 -40
  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 +168 -95
  126. package/src/routes/capabilities.ts +22 -0
  127. package/src/routes/entities.ts +48 -67
  128. package/src/routes/entity.ts +21 -35
  129. package/src/routes/file.ts +53 -103
  130. package/src/routes/files.ts +31 -47
  131. package/src/routes/metadata.ts +42 -98
  132. package/src/routes/search.ts +131 -151
  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 -82
  167. package/dist/app.test.js.map +0 -1
  168. package/dist/index.dev.d.ts +0 -1
  169. package/dist/index.dev.js +0 -156
  170. package/dist/index.dev.js.map +0 -1
  171. package/dist/routes/crate.test.d.ts +0 -1
  172. package/dist/routes/crate.test.js +0 -342
  173. package/dist/routes/crate.test.js.map +0 -1
  174. package/dist/routes/entities.test.d.ts +0 -1
  175. package/dist/routes/entities.test.js +0 -273
  176. package/dist/routes/entities.test.js.map +0 -1
  177. package/dist/routes/entity.test.d.ts +0 -1
  178. package/dist/routes/entity.test.js +0 -130
  179. package/dist/routes/entity.test.js.map +0 -1
  180. package/dist/routes/file.test.d.ts +0 -1
  181. package/dist/routes/file.test.js +0 -315
  182. package/dist/routes/file.test.js.map +0 -1
  183. package/dist/routes/files.test.d.ts +0 -1
  184. package/dist/routes/files.test.js +0 -222
  185. package/dist/routes/files.test.js.map +0 -1
  186. package/dist/routes/search.test.d.ts +0 -1
  187. package/dist/routes/search.test.js +0 -780
  188. package/dist/routes/search.test.js.map +0 -1
  189. package/dist/test/helpers/fastify.d.ts +0 -9
  190. package/dist/test/helpers/fastify.js +0 -18
  191. package/dist/test/helpers/fastify.js.map +0 -1
  192. package/dist/test/integration.setup.d.ts +0 -29
  193. package/dist/test/integration.setup.js +0 -187
  194. package/dist/test/integration.setup.js.map +0 -1
  195. package/dist/test/integration.test.d.ts +0 -1
  196. package/dist/test/integration.test.js +0 -396
  197. package/dist/test/integration.test.js.map +0 -1
  198. package/dist/transformers/default.test.d.ts +0 -1
  199. package/dist/transformers/default.test.js +0 -163
  200. package/dist/transformers/default.test.js.map +0 -1
  201. package/dist/transformers/transformer.test.d.ts +0 -1
  202. package/dist/transformers/transformer.test.js +0 -187
  203. package/dist/transformers/transformer.test.js.map +0 -1
  204. package/dist/types/fileHandlers.d.ts +0 -41
  205. package/dist/types/fileHandlers.js +0 -2
  206. package/dist/types/fileHandlers.js.map +0 -1
  207. package/dist/utils/errors.test.d.ts +0 -1
  208. package/dist/utils/errors.test.js +0 -66
  209. package/dist/utils/errors.test.js.map +0 -1
  210. package/dist/utils/queryBuilder.d.ts +0 -35
  211. package/dist/utils/queryBuilder.js +0 -98
  212. package/dist/utils/queryBuilder.js.map +0 -1
  213. package/prisma.config.ts +0 -9
  214. package/src/app.test.ts +0 -112
  215. package/src/index.dev.ts +0 -200
  216. package/src/reset.d.ts +0 -1
  217. package/src/routes/__snapshots__/entities.test.ts.snap +0 -96
  218. package/src/routes/__snapshots__/entity.test.ts.snap +0 -74
  219. package/src/routes/__snapshots__/search.test.ts.snap +0 -165
  220. package/src/routes/crate.test.ts +0 -423
  221. package/src/routes/entities.test.ts +0 -320
  222. package/src/routes/entity.test.ts +0 -160
  223. package/src/routes/file.test.ts +0 -395
  224. package/src/routes/files.test.ts +0 -278
  225. package/src/routes/search.test.ts +0 -903
  226. package/src/test/__snapshots__/integration.test.ts.snap +0 -18
  227. package/src/test/helpers/fastify.ts +0 -27
  228. package/src/test/integration.setup.ts +0 -209
  229. package/src/test/integration.test.ts +0 -482
  230. package/src/transformers/default.test.ts +0 -184
  231. package/src/transformers/transformer.test.ts +0 -252
  232. package/src/types/fileHandlers.ts +0 -65
  233. package/src/utils/errors.test.ts +0 -75
  234. package/src/utils/queryBuilder.ts +0 -132
@@ -0,0 +1,56 @@
1
+ import type { FastifyReply } from 'fastify';
2
+ import type { PrismaClient } from '../generated/prisma/client.js';
3
+ import type { IsAuthenticated, RequestContext } from '../types/context.js';
4
+ import type { EntityVisibilityFilter, SearchVisibilityFilter } from '../types/visibility.js';
5
+ import { createNotFoundError, sendRefusal } from './errors.js';
6
+
7
+ /**
8
+ * All Visible Entity Filter - every entity is visible to every request
9
+ *
10
+ * Use together with AllVisibleSearchFilter for repositories with no hidden entities.
11
+ */
12
+ export const AllVisibleEntityFilter: EntityVisibilityFilter = () => ({});
13
+
14
+ /**
15
+ * All Visible Search Filter - every indexed entity is visible to every request
16
+ *
17
+ * Use together with AllVisibleEntityFilter for repositories with no hidden entities.
18
+ */
19
+ export const AllVisibleSearchFilter: SearchVisibilityFilter = () => ({});
20
+
21
+ /**
22
+ * Whether a request has no credentials; without isAuthenticated the repository has no logins, so no request is
23
+ */
24
+ export const isAnonymous = async (isAuthenticated: IsAuthenticated | undefined, context: RequestContext) =>
25
+ isAuthenticated ? !(await isAuthenticated(context)) : false;
26
+
27
+ export type RefusalOptions = {
28
+ promptLoginForHidden: boolean;
29
+ isAuthenticated?: IsAuthenticated;
30
+ };
31
+
32
+ type NotVisibleResponderOptions = RefusalOptions & {
33
+ notFoundMessage: string;
34
+ exists: (id: string) => Promise<boolean>;
35
+ };
36
+
37
+ /**
38
+ * Build a reply for a resource that is missing or hidden from this request: 404, except that with the login
39
+ * prompt an anonymous request for a hidden resource gets 401
40
+ */
41
+ export const createNotVisibleResponder =
42
+ ({ promptLoginForHidden, isAuthenticated, notFoundMessage, exists }: NotVisibleResponderOptions) =>
43
+ async (reply: FastifyReply, id: string, context: RequestContext) => {
44
+ if (promptLoginForHidden && (await isAnonymous(isAuthenticated, context)) && (await exists(id))) {
45
+ return sendRefusal(reply, true, id);
46
+ }
47
+
48
+ return reply.code(404).send(createNotFoundError(notFoundMessage, id));
49
+ };
50
+
51
+ export const createEntityNotVisibleResponder = (prisma: PrismaClient, refusal: RefusalOptions) =>
52
+ createNotVisibleResponder({
53
+ ...refusal,
54
+ notFoundMessage: 'The requested entity was not found',
55
+ exists: async (id) => (await prisma.entity.count({ where: { id } })) > 0,
56
+ });
@@ -1 +0,0 @@
1
- export {};
package/dist/app.test.js DELETED
@@ -1,82 +0,0 @@
1
- import Fastify from 'fastify';
2
- import { beforeEach, describe, expect, it, vi } from 'vitest';
3
- import { mockReset } from 'vitest-mock-extended';
4
- import app, { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from './app.js';
5
- import { opensearch, prisma } from './test/helpers/fastify.js';
6
- describe('Entity Route', () => {
7
- beforeEach(() => {
8
- mockReset(prisma);
9
- mockReset(opensearch);
10
- });
11
- describe('App Registration', () => {
12
- it('should handle missing prisma', async () => {
13
- const fastify = Fastify({ logger: false });
14
- fastify.register(app, {
15
- opensearch,
16
- });
17
- await expect(() => fastify.ready()).rejects.toThrowError('Prisma client is required');
18
- });
19
- it('should handle missing opensearch', async () => {
20
- const fastify = Fastify({ logger: false });
21
- fastify.register(app, {
22
- prisma,
23
- });
24
- await expect(() => fastify.ready()).rejects.toThrowError('OpenSearch client is required');
25
- });
26
- it('should handle missing accessTransformer', async () => {
27
- const fastify = Fastify({ logger: false });
28
- fastify.register(app, {
29
- prisma,
30
- opensearch,
31
- });
32
- await expect(() => fastify.ready()).rejects.toThrowError('accessTransformer is required');
33
- });
34
- it('should handle missing fileAccessTransformer', async () => {
35
- const fastify = Fastify({ logger: false });
36
- fastify.register(app, {
37
- prisma,
38
- opensearch,
39
- accessTransformer: AllPublicAccessTransformer,
40
- });
41
- await expect(() => fastify.ready()).rejects.toThrowError('fileAccessTransformer is required');
42
- });
43
- it('should handle missing fileHandler', async () => {
44
- const fastify = Fastify({ logger: false });
45
- fastify.register(app, {
46
- prisma,
47
- opensearch,
48
- accessTransformer: AllPublicAccessTransformer,
49
- fileAccessTransformer: AllPublicFileAccessTransformer,
50
- });
51
- await expect(() => fastify.ready()).rejects.toThrowError('fileHandler is required');
52
- });
53
- it('should handle missing roCrateHandler', async () => {
54
- const fastify = Fastify({ logger: false });
55
- fastify.register(app, {
56
- prisma,
57
- opensearch,
58
- accessTransformer: AllPublicAccessTransformer,
59
- fileAccessTransformer: AllPublicFileAccessTransformer,
60
- fileHandler: {
61
- get: vi.fn(),
62
- head: vi.fn(),
63
- },
64
- });
65
- await expect(() => fastify.ready()).rejects.toThrowError('roCrateHandler is required');
66
- });
67
- it('should register successfully with all required options', async () => {
68
- const fastify = Fastify({ logger: false });
69
- await fastify.register(app, {
70
- prisma,
71
- opensearch,
72
- accessTransformer: AllPublicAccessTransformer,
73
- fileAccessTransformer: AllPublicFileAccessTransformer,
74
- fileHandler: { get: vi.fn(), head: vi.fn() },
75
- roCrateHandler: { get: vi.fn(), head: vi.fn() },
76
- });
77
- await expect(fastify.ready()).resolves.toBeDefined();
78
- await fastify.close();
79
- });
80
- });
81
- });
82
- //# sourceMappingURL=app.test.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"app.test.js","sourceRoot":"","sources":["../src/app.test.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,GAAG,EAAE,EAAE,0BAA0B,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAE3F,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAE/D,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,UAAU,CAAC,GAAG,EAAE;QACd,SAAS,CAAC,MAAM,CAAC,CAAC;QAClB,SAAS,CAAC,UAAU,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,UAAU;aACX,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;YAChD,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;aACP,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,+BAA+B,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;gBACN,UAAU;aACX,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,+BAA+B,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;gBACN,UAAU;gBACV,iBAAiB,EAAE,0BAA0B;aAC9C,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,mCAAmC,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;gBACN,UAAU;gBACV,iBAAiB,EAAE,0BAA0B;gBAC7C,qBAAqB,EAAE,8BAA8B;aACtD,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,yBAAyB,CAAC,CAAC;QACtF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YACpD,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;gBACN,UAAU;gBACV,iBAAiB,EAAE,0BAA0B;gBAC7C,qBAAqB,EAAE,8BAA8B;gBACrD,WAAW,EAAE;oBACX,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;oBACZ,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE;iBACd;aACF,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;YACtE,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAE3C,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBAC1B,MAAM;gBACN,UAAU;gBACV,iBAAiB,EAAE,0BAA0B;gBAC7C,qBAAqB,EAAE,8BAA8B;gBACrD,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;gBAC5C,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;aAChD,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;YAErD,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1 +0,0 @@
1
- export {};
package/dist/index.dev.js DELETED
@@ -1,156 +0,0 @@
1
- import { createReadStream, existsSync, readFileSync, statSync } from 'node:fs';
2
- import { Readable } from 'node:stream';
3
- import { Client } from '@opensearch-project/opensearch';
4
- import { PrismaMariaDb } from '@prisma/adapter-mariadb';
5
- import Fastify from 'fastify';
6
- import arocapi, { AllPublicAccessTransformer, AllPublicFileAccessTransformer, } from './app.js';
7
- import { PrismaClient } from './generated/prisma/client.js';
8
- const adapter = new PrismaMariaDb({
9
- host: 'localhost',
10
- user: 'root',
11
- password: 'password',
12
- database: 'catalog',
13
- port: 3306,
14
- connectionLimit: 5,
15
- allowPublicKeyRetrieval: true,
16
- });
17
- const prisma = new PrismaClient({ adapter });
18
- if (!process.env.OPENSEARCH_URL) {
19
- throw new Error('OPENSEARCH_URL environment variable is not set');
20
- }
21
- const opensearchUrl = process.env.OPENSEARCH_URL;
22
- const opensearch = new Client({ node: opensearchUrl });
23
- const fileHandler = {
24
- head: async (file) => {
25
- const filePath = file.meta.storagePath;
26
- if (!existsSync(filePath)) {
27
- return false;
28
- }
29
- const stats = statSync(filePath);
30
- return {
31
- contentType: file.mediaType,
32
- contentLength: Number(file.size),
33
- lastModified: stats.mtime,
34
- };
35
- },
36
- get: async (file) => {
37
- const filePath = file.meta.storagePath;
38
- if (!existsSync(filePath)) {
39
- return false;
40
- }
41
- const stats = statSync(filePath);
42
- return {
43
- type: 'stream',
44
- stream: createReadStream(filePath),
45
- metadata: {
46
- contentType: file.mediaType,
47
- contentLength: Number(file.size),
48
- lastModified: stats.mtime,
49
- },
50
- };
51
- },
52
- };
53
- const transformRoCrate = (filePath, remapRootTo) => {
54
- const fileContents = readFileSync(filePath, 'utf-8');
55
- const rocrate = JSON.parse(fileContents);
56
- const graph = rocrate['@graph'] || [];
57
- const rootNode = graph.find((node) => node['@id'] === 'ro-crate-metadata.json');
58
- if (!rootNode) {
59
- return false;
60
- }
61
- rootNode.about['@id'] = remapRootTo;
62
- const jsonString = JSON.stringify(rocrate);
63
- return { rocrate, jsonString };
64
- };
65
- const roCrateHandler = {
66
- head: async (entity) => {
67
- const meta = entity.meta;
68
- const filePath = meta.storagePath;
69
- if (!existsSync(filePath)) {
70
- return false;
71
- }
72
- if (meta.remapRootTo) {
73
- const result = transformRoCrate(filePath, meta.remapRootTo);
74
- if (!result) {
75
- return false;
76
- }
77
- return {
78
- contentType: 'application/ld+json',
79
- contentLength: Buffer.byteLength(result.jsonString),
80
- lastModified: statSync(filePath).mtime,
81
- };
82
- }
83
- const stats = statSync(filePath);
84
- return {
85
- contentType: 'application/ld+json',
86
- contentLength: stats.size,
87
- lastModified: stats.mtime,
88
- };
89
- },
90
- get: async (entity) => {
91
- const meta = entity.meta;
92
- const filePath = meta.storagePath;
93
- if (!existsSync(filePath)) {
94
- return false;
95
- }
96
- if (meta.remapRootTo) {
97
- const result = transformRoCrate(filePath, meta.remapRootTo);
98
- if (!result) {
99
- return false;
100
- }
101
- return {
102
- type: 'stream',
103
- stream: Readable.from(result.jsonString),
104
- metadata: {
105
- contentType: 'application/ld+json',
106
- contentLength: Buffer.byteLength(result.jsonString),
107
- lastModified: statSync(filePath).mtime,
108
- },
109
- };
110
- }
111
- const stats = statSync(filePath);
112
- return {
113
- type: 'stream',
114
- stream: createReadStream(filePath),
115
- metadata: {
116
- contentType: 'application/ld+json',
117
- contentLength: stats.size,
118
- lastModified: stats.mtime,
119
- },
120
- };
121
- },
122
- };
123
- const oniTransformer = (entity) => {
124
- return {
125
- ...entity,
126
- accessControl: 'Public',
127
- counts: {
128
- collections: 0,
129
- objects: 0,
130
- files: 0,
131
- },
132
- };
133
- };
134
- const fastify = Fastify({
135
- logger: true,
136
- });
137
- fastify.register(arocapi, {
138
- prisma,
139
- opensearch,
140
- fileHandler,
141
- roCrateHandler,
142
- accessTransformer: AllPublicAccessTransformer,
143
- entityTransformers: [oniTransformer],
144
- fileAccessTransformer: AllPublicFileAccessTransformer,
145
- });
146
- const start = async () => {
147
- try {
148
- await fastify.listen({ port: 9000 });
149
- }
150
- catch (err) {
151
- fastify.log.error(err);
152
- process.exit(1);
153
- }
154
- };
155
- start();
156
- //# sourceMappingURL=index.dev.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.dev.js","sourceRoot":"","sources":["../src/index.dev.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,OAAO,EAAE,EACd,0BAA0B,EAC1B,8BAA8B,GAI/B,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC;IAChC,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,SAAS;IACnB,IAAI,EAAE,IAAI;IACV,eAAe,EAAE,CAAC;IAElB,uBAAuB,EAAE,IAAI;CAC9B,CAAC,CAAC;AACH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;AAE7C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;IAChC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;AACpE,CAAC;AACD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;AACjD,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;AAEvD,MAAM,WAAW,GAAgB;IAC/B,IAAI,EAAE,KAAK,EAAE,IAAU,EAAE,EAAE;QACzB,MAAM,QAAQ,GAAI,IAAI,CAAC,IAAgC,CAAC,WAAW,CAAC;QAEpE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,SAAS;YAC3B,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YAChC,YAAY,EAAE,KAAK,CAAC,KAAK;SAC1B,CAAC;IACJ,CAAC;IACD,GAAG,EAAE,KAAK,EAAE,IAAU,EAAE,EAAE;QACxB,MAAM,QAAQ,GAAI,IAAI,CAAC,IAAgC,CAAC,WAAW,CAAC;QAEpE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC;YAClC,QAAQ,EAAE;gBACR,WAAW,EAAE,IAAI,CAAC,SAAS;gBAC3B,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;gBAChC,YAAY,EAAE,KAAK,CAAC,KAAK;aAC1B;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,WAAmB,EAAoD,EAAE;IACnH,MAAM,YAAY,GAAG,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAItC,CAAC;IAEF,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,wBAAwB,CAEjE,CAAC;IAEd,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC;IAEpC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE3C,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,cAAc,GAAmB;IACrC,IAAI,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAoD,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;QAElC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YAE5D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO;gBACL,WAAW,EAAE,qBAAqB;gBAClC,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;gBACnD,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,KAAK;aACvC,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO;YACL,WAAW,EAAE,qBAAqB;YAClC,aAAa,EAAE,KAAK,CAAC,IAAI;YACzB,YAAY,EAAE,KAAK,CAAC,KAAK;SAC1B,CAAC;IACJ,CAAC;IACD,GAAG,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAoD,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;QAElC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YAE5D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;gBACxC,QAAQ,EAAE;oBACR,WAAW,EAAE,qBAAqB;oBAClC,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;oBACnD,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,KAAK;iBACvC;aACF,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC;YAClC,QAAQ,EAAE;gBACR,WAAW,EAAE,qBAAqB;gBAClC,aAAa,EAAE,KAAK,CAAC,IAAI;gBACzB,YAAY,EAAE,KAAK,CAAC,KAAK;aAC1B;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,MAAM,cAAc,GAAsB,CAAC,MAAM,EAAE,EAAE;IACnD,OAAO;QACL,GAAG,MAAM;QACT,aAAa,EAAE,QAAQ;QACvB,MAAM,EAAE;YACN,WAAW,EAAE,CAAC;YACd,OAAO,EAAE,CAAC;YACV,KAAK,EAAE,CAAC;SACT;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,OAAO,CAAC;IACtB,MAAM,EAAE,IAAI;CACb,CAAC,CAAC;AACH,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE;IACxB,MAAM;IACN,UAAU;IACV,WAAW;IACX,cAAc;IACd,iBAAiB,EAAE,0BAA0B;IAC7C,kBAAkB,EAAE,CAAC,cAAc,CAAC;IACpC,qBAAqB,EAAE,8BAA8B;CACtD,CAAC,CAAC;AAEH,MAAM,KAAK,GAAG,KAAK,IAAI,EAAE;IACvB,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC;AACF,KAAK,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export {};
@@ -1,342 +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 metadataRoute from './metadata.js';
6
- vi.mock('node:fs', () => ({
7
- createReadStream: vi.fn(),
8
- }));
9
- describe('Crate Route', () => {
10
- const mockRoCrateHandler = {
11
- get: vi.fn(),
12
- head: vi.fn(),
13
- };
14
- beforeEach(async () => {
15
- await fastifyBefore();
16
- await fastify.register(metadataRoute, { prisma, roCrateHandler: mockRoCrateHandler });
17
- vi.clearAllMocks();
18
- });
19
- afterEach(async () => {
20
- await fastifyAfter();
21
- });
22
- const mockFileEntity = {
23
- id: 'http://example.com/entity/file.wav',
24
- name: 'test.wav',
25
- description: 'A test file',
26
- entityType: 'http://schema.org/MediaObject',
27
- memberOf: 'http://example.com/collection',
28
- rootCollection: 'http://example.com/collection',
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
- meta: {},
34
- };
35
- const mockCollectionEntity = {
36
- ...mockFileEntity,
37
- id: 'http://example.com/collection',
38
- name: 'Test Collection',
39
- entityType: 'http://pcdm.org/models#Collection',
40
- memberOf: null,
41
- rootCollection: null,
42
- };
43
- const mockObjectEntity = {
44
- ...mockFileEntity,
45
- id: 'http://example.com/object',
46
- name: 'Test Object',
47
- entityType: 'http://pcdm.org/models#Object',
48
- memberOf: 'http://example.com/collection',
49
- rootCollection: 'http://example.com/collection',
50
- };
51
- describe('GET /entity/:id/metadata', () => {
52
- it('should stream RO-Crate metadata for File entity', async () => {
53
- prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
54
- const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
55
- const mockResult = {
56
- type: 'stream',
57
- stream: mockStream,
58
- metadata: {
59
- contentType: 'text/plain',
60
- contentLength: 52,
61
- etag: '"rocrate123"',
62
- lastModified: new Date('2025-01-01'),
63
- },
64
- };
65
- vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
66
- const response = await fastify.inject({
67
- method: 'GET',
68
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
69
- });
70
- expect(response.statusCode).toBe(200);
71
- expect(response.headers['content-type']).toBe('application/ld+json');
72
- expect(response.headers['content-length']).toBe('52');
73
- expect(response.headers.etag).toBe('"rocrate123"');
74
- expect(response.body).toBe('{"@context": "https://w3id.org/ro/crate/1.1/context"}');
75
- expect(mockRoCrateHandler.get).toHaveBeenCalledWith(mockFileEntity, expect.objectContaining({
76
- request: expect.any(Object),
77
- fastify: expect.any(Object),
78
- }));
79
- });
80
- it('should stream RO-Crate metadata for Collection entity', async () => {
81
- prisma.entity.findUnique.mockResolvedValue(mockCollectionEntity);
82
- const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
83
- const mockResult = {
84
- type: 'stream',
85
- stream: mockStream,
86
- metadata: {
87
- contentType: 'application/json',
88
- contentLength: 52,
89
- },
90
- };
91
- vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
92
- const response = await fastify.inject({
93
- method: 'GET',
94
- url: `/entity/${encodeURIComponent('http://example.com/collection')}/metadata`,
95
- });
96
- expect(response.statusCode).toBe(200);
97
- expect(response.headers['content-type']).toBe('application/ld+json');
98
- expect(mockRoCrateHandler.get).toHaveBeenCalledWith(mockCollectionEntity, expect.any(Object));
99
- });
100
- it('should stream RO-Crate metadata for Object entity', async () => {
101
- prisma.entity.findUnique.mockResolvedValue(mockObjectEntity);
102
- const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
103
- const mockResult = {
104
- type: 'stream',
105
- stream: mockStream,
106
- metadata: {
107
- contentType: 'application/ld+json',
108
- contentLength: 52,
109
- },
110
- };
111
- vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
112
- const response = await fastify.inject({
113
- method: 'GET',
114
- url: `/entity/${encodeURIComponent('http://example.com/object')}/metadata`,
115
- });
116
- expect(response.statusCode).toBe(200);
117
- expect(response.headers['content-type']).toBe('application/ld+json');
118
- expect(mockRoCrateHandler.get).toHaveBeenCalledWith(mockObjectEntity, expect.any(Object));
119
- });
120
- it('should handle redirect response', async () => {
121
- prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
122
- const mockResult = {
123
- type: 'redirect',
124
- url: 'https://storage.example.com/ro-crate-metadata.json',
125
- };
126
- vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
127
- const response = await fastify.inject({
128
- method: 'GET',
129
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
130
- });
131
- expect(response.statusCode).toBe(302);
132
- expect(response.headers.location).toBe('https://storage.example.com/ro-crate-metadata.json');
133
- });
134
- it('should handle file path response without nginx X-Accel-Redirect', async () => {
135
- prisma.entity.findUnique.mockResolvedValue(mockCollectionEntity);
136
- const mockStream = Readable.from(['rocrate content']);
137
- vi.mocked(createReadStream).mockReturnValue(mockStream);
138
- const mockResult = {
139
- type: 'file',
140
- path: '/data/rocrate/ro-crate-metadata.json',
141
- metadata: {
142
- contentType: 'application/ld+json',
143
- contentLength: 1024,
144
- },
145
- };
146
- vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
147
- const response = await fastify.inject({
148
- method: 'GET',
149
- url: `/entity/${encodeURIComponent('http://example.com/collection')}/metadata`,
150
- });
151
- expect(response.statusCode).toBe(200);
152
- expect(response.headers['content-type']).toBe('application/ld+json');
153
- expect(response.headers['content-length']).toBe('1024');
154
- expect(response.headers['x-accel-redirect']).toBeUndefined();
155
- expect(createReadStream).toHaveBeenCalledWith('/data/rocrate/ro-crate-metadata.json');
156
- });
157
- it('should handle file path response with nginx X-Accel-Redirect', async () => {
158
- prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
159
- const mockResult = {
160
- type: 'file',
161
- path: '/data/rocrate/ro-crate-metadata.json',
162
- accelPath: '/internal/rocrate/ro-crate-metadata.json',
163
- metadata: {
164
- contentType: 'application/ld+json',
165
- contentLength: 2048,
166
- },
167
- };
168
- vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
169
- const response = await fastify.inject({
170
- method: 'GET',
171
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
172
- });
173
- expect(response.statusCode).toBe(200);
174
- expect(response.headers['content-type']).toBe('application/ld+json');
175
- expect(response.headers['x-accel-redirect']).toBe('/internal/rocrate/ro-crate-metadata.json');
176
- expect(response.body).toBe('');
177
- });
178
- it('should return 404 when entity not found', async () => {
179
- prisma.entity.findUnique.mockResolvedValue(null);
180
- const response = await fastify.inject({
181
- method: 'GET',
182
- url: `/entity/${encodeURIComponent('http://example.com/nonexistent')}/metadata`,
183
- });
184
- const body = JSON.parse(response.body);
185
- expect(response.statusCode).toBe(404);
186
- expect(body.error.code).toBe('NOT_FOUND');
187
- expect(body.error.message).toBe('The requested entity was not found');
188
- expect(mockRoCrateHandler.get).not.toHaveBeenCalled();
189
- });
190
- it('should return 404 when handler returns false', async () => {
191
- prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
192
- vi.mocked(mockRoCrateHandler.get).mockResolvedValue(false);
193
- const response = await fastify.inject({
194
- method: 'GET',
195
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
196
- });
197
- const body = JSON.parse(response.body);
198
- expect(response.statusCode).toBe(404);
199
- expect(body.error.code).toBe('NOT_FOUND');
200
- expect(body.error.message).toBe('The requested RO-Crate could not be retrieved');
201
- });
202
- it('should return 500 when database error occurs', async () => {
203
- prisma.entity.findUnique.mockRejectedValue(new Error('Database connection failed'));
204
- const response = await fastify.inject({
205
- method: 'GET',
206
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
207
- });
208
- const body = JSON.parse(response.body);
209
- expect(response.statusCode).toBe(500);
210
- expect(body.error.code).toBe('INTERNAL_ERROR');
211
- });
212
- it('should return 500 when roCrateHandler throws error', async () => {
213
- prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
214
- vi.mocked(mockRoCrateHandler.get).mockRejectedValue(new Error('RO-Crate error'));
215
- const response = await fastify.inject({
216
- method: 'GET',
217
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
218
- });
219
- const body = JSON.parse(response.body);
220
- expect(response.statusCode).toBe(500);
221
- expect(body.error.code).toBe('INTERNAL_ERROR');
222
- });
223
- it('should validate ID parameter format', async () => {
224
- const response = await fastify.inject({
225
- method: 'GET',
226
- url: '/entity/invalid-id/metadata',
227
- });
228
- const body = JSON.parse(response.body);
229
- expect(response.statusCode).toBe(400);
230
- expect(body.error).toBe('Bad Request');
231
- });
232
- });
233
- describe('HEAD /entity/:id/metadata', () => {
234
- it('should return RO-Crate metadata headers for File entity', async () => {
235
- prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
236
- const mockMetadata = {
237
- contentType: 'application/ld+json',
238
- contentLength: 1024,
239
- etag: '"rocrate-etag"',
240
- lastModified: new Date('2025-01-15'),
241
- };
242
- vi.mocked(mockRoCrateHandler.head).mockResolvedValue(mockMetadata);
243
- const response = await fastify.inject({
244
- method: 'HEAD',
245
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
246
- });
247
- expect(response.statusCode).toBe(200);
248
- expect(response.headers['content-type']).toBe('application/ld+json');
249
- expect(response.headers['content-length']).toBe('1024');
250
- expect(response.headers.etag).toBe('"rocrate-etag"');
251
- expect(response.body).toBe('');
252
- expect(mockRoCrateHandler.head).toHaveBeenCalledWith(mockFileEntity, expect.objectContaining({
253
- request: expect.any(Object),
254
- fastify: expect.any(Object),
255
- }));
256
- });
257
- it('should return RO-Crate metadata headers for Collection entity', async () => {
258
- prisma.entity.findUnique.mockResolvedValue(mockCollectionEntity);
259
- const mockMetadata = {
260
- contentType: 'text/plain',
261
- contentLength: 512,
262
- };
263
- vi.mocked(mockRoCrateHandler.head).mockResolvedValue(mockMetadata);
264
- const response = await fastify.inject({
265
- method: 'HEAD',
266
- url: `/entity/${encodeURIComponent('http://example.com/collection')}/metadata`,
267
- });
268
- expect(response.statusCode).toBe(200);
269
- expect(response.headers['content-type']).toBe('text/plain');
270
- expect(response.headers['content-length']).toBe('512');
271
- expect(response.body).toBe('');
272
- });
273
- it('should return RO-Crate metadata headers for Object entity', async () => {
274
- prisma.entity.findUnique.mockResolvedValue(mockObjectEntity);
275
- const mockMetadata = {
276
- contentType: 'application/json',
277
- contentLength: 2048,
278
- };
279
- vi.mocked(mockRoCrateHandler.head).mockResolvedValue(mockMetadata);
280
- const response = await fastify.inject({
281
- method: 'HEAD',
282
- url: `/entity/${encodeURIComponent('http://example.com/object')}/metadata`,
283
- });
284
- expect(response.statusCode).toBe(200);
285
- expect(response.headers['content-type']).toBe('application/json');
286
- expect(response.headers['content-length']).toBe('2048');
287
- expect(response.body).toBe('');
288
- });
289
- it('should return 404 when entity not found', async () => {
290
- prisma.entity.findUnique.mockResolvedValue(null);
291
- const response = await fastify.inject({
292
- method: 'HEAD',
293
- url: `/entity/${encodeURIComponent('http://example.com/nonexistent')}/metadata`,
294
- });
295
- const body = JSON.parse(response.body);
296
- expect(response.statusCode).toBe(404);
297
- expect(body.error.code).toBe('NOT_FOUND');
298
- expect(mockRoCrateHandler.head).not.toHaveBeenCalled();
299
- });
300
- it('should return 404 when head handler returns false', async () => {
301
- prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
302
- vi.mocked(mockRoCrateHandler.head).mockResolvedValue(false);
303
- const response = await fastify.inject({
304
- method: 'HEAD',
305
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
306
- });
307
- const body = JSON.parse(response.body);
308
- expect(response.statusCode).toBe(404);
309
- expect(body.error.code).toBe('NOT_FOUND');
310
- expect(body.error.message).toBe('The requested RO-Crate metadata was not found');
311
- });
312
- it('should return 500 when head handler throws error', async () => {
313
- prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
314
- vi.mocked(mockRoCrateHandler.head).mockRejectedValue(new Error('Metadata error'));
315
- const response = await fastify.inject({
316
- method: 'HEAD',
317
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
318
- });
319
- const body = JSON.parse(response.body);
320
- expect(response.statusCode).toBe(500);
321
- expect(body.error.code).toBe('INTERNAL_ERROR');
322
- });
323
- });
324
- describe('GET /entity/:id/metadata - exhaustiveness check', () => {
325
- it('should handle unexpected RO-Crate result type', async () => {
326
- prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
327
- const invalidResult = {
328
- type: 'invalid',
329
- metadata: { contentType: 'application/ld+json', contentLength: 1024 },
330
- };
331
- vi.mocked(mockRoCrateHandler.get).mockResolvedValue(invalidResult);
332
- const response = await fastify.inject({
333
- method: 'GET',
334
- url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
335
- });
336
- const body = JSON.parse(response.body);
337
- expect(response.statusCode).toBe(500);
338
- expect(body.error.code).toBe('INTERNAL_ERROR');
339
- });
340
- });
341
- });
342
- //# sourceMappingURL=crate.test.js.map