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
@@ -0,0 +1,17 @@
1
+ import type { FastifyReply } from 'fastify';
2
+ import { type EntityRow } from '../transformers/default.js';
3
+ import type { AccessFunction } from '../types/access.js';
4
+ import type { IsAuthenticated, RequestContext } from '../types/context.js';
5
+ export declare const AllPublicAccess: AccessFunction;
6
+ export type LicenceAccessOptions = {
7
+ hasLicence: (licenceId: string, context: RequestContext) => Promise<boolean> | boolean;
8
+ authorisationUrl?: (licenceId: string) => string;
9
+ };
10
+ export declare const LicenceAccess: ({ hasLicence, authorisationUrl }: LicenceAccessOptions) => AccessFunction;
11
+ type AccessGuardOptions = {
12
+ access: AccessFunction;
13
+ isAuthenticated?: IsAuthenticated;
14
+ level: 'metadata' | 'content';
15
+ };
16
+ export declare const createAccessGuard: ({ access, isAuthenticated, level }: AccessGuardOptions) => (reply: FastifyReply, entity: EntityRow, context: RequestContext) => Promise<boolean>;
17
+ export {};
@@ -0,0 +1,41 @@
1
+ import { decideAccess } from '../transformers/default.js';
2
+ import { sendRefusal } from './errors.js';
3
+ import { isAnonymous } from './visibility.js';
4
+ export const AllPublicAccess = () => ({ metadata: true, content: true });
5
+ export const LicenceAccess = ({ hasLicence, authorisationUrl }) => {
6
+ const checksByRequest = new WeakMap();
7
+ const check = (licenceId, context) => {
8
+ let checks = checksByRequest.get(context.request);
9
+ if (!checks) {
10
+ checks = new Map();
11
+ checksByRequest.set(context.request, checks);
12
+ }
13
+ let held = checks.get(licenceId);
14
+ if (!held) {
15
+ held = Promise.resolve(hasLicence(licenceId, context));
16
+ checks.set(licenceId, held);
17
+ }
18
+ return held;
19
+ };
20
+ return async ({ metadataLicenseId, contentLicenseId }, context) => {
21
+ const [metadata, content] = await Promise.all([
22
+ check(metadataLicenseId, context),
23
+ check(contentLicenseId, context),
24
+ ]);
25
+ return {
26
+ metadata,
27
+ content,
28
+ ...(!metadata && authorisationUrl && { metadataAuthorizationUrl: authorisationUrl(metadataLicenseId) }),
29
+ ...(!content && authorisationUrl && { contentAuthorizationUrl: authorisationUrl(contentLicenseId) }),
30
+ };
31
+ };
32
+ };
33
+ export const createAccessGuard = ({ access, isAuthenticated, level }) => async (reply, entity, context) => {
34
+ const [entityAccess] = await decideAccess([entity], access, context);
35
+ if (entityAccess[level]) {
36
+ return false;
37
+ }
38
+ sendRefusal(reply, await isAnonymous(isAuthenticated, context), entity.id);
39
+ return true;
40
+ };
41
+ //# sourceMappingURL=access.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"access.js","sourceRoot":"","sources":["../../src/utils/access.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAkB,MAAM,4BAA4B,CAAC;AAG1E,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAO9C,MAAM,CAAC,MAAM,eAAe,GAAmB,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AAYzF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAAE,UAAU,EAAE,gBAAgB,EAAwB,EAAkB,EAAE;IACtG,MAAM,eAAe,GAAG,IAAI,OAAO,EAAiD,CAAC;IAErF,MAAM,KAAK,GAAG,CAAC,SAAiB,EAAE,OAAuB,EAAE,EAAE;QAC3D,IAAI,MAAM,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;YACnB,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;YACvD,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,EAAE,OAAO,EAAE,EAAE;QAChE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC5C,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC;YACjC,KAAK,CAAC,gBAAgB,EAAE,OAAO,CAAC;SACjC,CAAC,CAAC;QAEH,OAAO;YACL,QAAQ;YACR,OAAO;YACP,GAAG,CAAC,CAAC,QAAQ,IAAI,gBAAgB,IAAI,EAAE,wBAAwB,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACvG,GAAG,CAAC,CAAC,OAAO,IAAI,gBAAgB,IAAI,EAAE,uBAAuB,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,CAAC;SACrG,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAYF,MAAM,CAAC,MAAM,iBAAiB,GAC5B,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,KAAK,EAAsB,EAAE,EAAE,CAC3D,KAAK,EAAE,KAAmB,EAAE,MAAiB,EAAE,OAAuB,EAAE,EAAE;IACxE,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,YAAY,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACrE,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,WAAW,CAAC,KAAK,EAAE,MAAM,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAE3E,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}
@@ -1,12 +1,16 @@
1
- declare const ERROR_CODES: {
2
- readonly VALIDATION_ERROR: "VALIDATION_ERROR";
3
- readonly NOT_FOUND: "NOT_FOUND";
4
- readonly RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED";
5
- readonly INTERNAL_ERROR: "INTERNAL_ERROR";
6
- readonly INVALID_REQUEST: "INVALID_REQUEST";
7
- readonly INVALID_ENTITY_TYPE: "INVALID_ENTITY_TYPE";
1
+ import type { FastifyReply, FastifyRequest } from 'fastify';
2
+ export declare const ERROR_CODES: {
3
+ readonly VALIDATION_ERROR: 'VALIDATION_ERROR';
4
+ readonly NOT_FOUND: 'NOT_FOUND';
5
+ readonly UNAUTHORIZED: 'UNAUTHORIZED';
6
+ readonly FORBIDDEN: 'FORBIDDEN';
7
+ readonly CONFLICT: 'CONFLICT';
8
+ readonly RANGE_NOT_SATISFIABLE: 'RANGE_NOT_SATISFIABLE';
9
+ readonly RATE_LIMIT_EXCEEDED: 'RATE_LIMIT_EXCEEDED';
10
+ readonly INTERNAL_ERROR: 'INTERNAL_ERROR';
11
+ readonly INVALID_ENTITY_TYPE: 'INVALID_ENTITY_TYPE';
8
12
  };
9
- type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
13
+ export type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
10
14
  type ErrorDetails = {
11
15
  [key: string]: unknown;
12
16
  };
@@ -17,13 +21,18 @@ export type StandardErrorResponse = {
17
21
  details?: ErrorDetails;
18
22
  };
19
23
  };
24
+ export declare const createError: (code: ErrorCode, message: string, details?: ErrorDetails) => StandardErrorResponse;
20
25
  type ValidationViolation = {
21
26
  field: string;
22
- message: string;
27
+ message?: string;
23
28
  value?: unknown;
24
29
  };
25
30
  export declare const createValidationError: (message: string, violations: ValidationViolation[]) => StandardErrorResponse;
26
31
  export declare const createNotFoundError: (message: string, entityId?: string) => StandardErrorResponse;
27
- export declare const createInvalidRequestError: (message: string) => StandardErrorResponse;
32
+ export declare const createAuthenticationRequiredError: (message: string, entityId: string) => StandardErrorResponse;
33
+ export declare const createForbiddenError: (message: string, entityId: string) => StandardErrorResponse;
28
34
  export declare const createInternalError: (message?: string) => StandardErrorResponse;
35
+ export declare const sendRefusal: (reply: FastifyReply, anonymous: boolean, id: string) => FastifyReply<import("fastify").RouteGenericInterface, import("fastify").RawServerDefault, import("node:http").IncomingMessage, import("node:http").ServerResponse<import("node:http").IncomingMessage>, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
36
+ export declare const errorHandler: (error: unknown, request: FastifyRequest, reply: FastifyReply) => FastifyReply<import("fastify").RouteGenericInterface, import("fastify").RawServerDefault, import("node:http").IncomingMessage, import("node:http").ServerResponse<import("node:http").IncomingMessage>, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
37
+ export declare const notFoundHandler: (_request: FastifyRequest, reply: FastifyReply) => FastifyReply<import("fastify").RouteGenericInterface, import("fastify").RawServerDefault, import("node:http").IncomingMessage, import("node:http").ServerResponse<import("node:http").IncomingMessage>, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
29
38
  export {};
@@ -1,22 +1,58 @@
1
- const ERROR_CODES = {
1
+ import { hasZodFastifySchemaValidationErrors } from 'fastify-type-provider-zod';
2
+ export const ERROR_CODES = {
2
3
  VALIDATION_ERROR: 'VALIDATION_ERROR',
3
4
  NOT_FOUND: 'NOT_FOUND',
5
+ UNAUTHORIZED: 'UNAUTHORIZED',
6
+ FORBIDDEN: 'FORBIDDEN',
7
+ CONFLICT: 'CONFLICT',
8
+ RANGE_NOT_SATISFIABLE: 'RANGE_NOT_SATISFIABLE',
4
9
  RATE_LIMIT_EXCEEDED: 'RATE_LIMIT_EXCEEDED',
5
10
  INTERNAL_ERROR: 'INTERNAL_ERROR',
6
- INVALID_REQUEST: 'INVALID_REQUEST',
7
11
  INVALID_ENTITY_TYPE: 'INVALID_ENTITY_TYPE',
8
12
  };
9
- const createErrorResponse = (code, message, details) => ({
13
+ export const createError = (code, message, details) => ({
10
14
  error: {
11
15
  code,
12
16
  message,
13
17
  details,
14
18
  },
15
19
  });
16
- export const createValidationError = (message, violations) => createErrorResponse(ERROR_CODES.VALIDATION_ERROR, message, { violations });
17
- export const createNotFoundError = (message, entityId) => createErrorResponse(ERROR_CODES.NOT_FOUND, message, entityId ? { entityId } : undefined);
18
- export const createInvalidRequestError = (message) => createErrorResponse(ERROR_CODES.INVALID_REQUEST, message);
19
- export const createInternalError = (message = 'Internal server error') => {
20
- return createErrorResponse(ERROR_CODES.INTERNAL_ERROR, message);
20
+ export const createValidationError = (message, violations) => createError(ERROR_CODES.VALIDATION_ERROR, message, { violations });
21
+ export const createNotFoundError = (message, entityId) => createError(ERROR_CODES.NOT_FOUND, message, entityId ? { entityId } : undefined);
22
+ export const createAuthenticationRequiredError = (message, entityId) => createError(ERROR_CODES.UNAUTHORIZED, message, { entityId });
23
+ export const createForbiddenError = (message, entityId) => createError(ERROR_CODES.FORBIDDEN, message, { entityId });
24
+ export const createInternalError = (message = 'Internal server error') => createError(ERROR_CODES.INTERNAL_ERROR, message);
25
+ export const sendRefusal = (reply, anonymous, id) => anonymous
26
+ ? reply.code(401).send(createAuthenticationRequiredError('Authentication is required to access this resource', id))
27
+ : reply.code(403).send(createForbiddenError('You do not have permission to access this resource', id));
28
+ const ERROR_CODE_BY_STATUS = {
29
+ 401: ERROR_CODES.UNAUTHORIZED,
30
+ 403: ERROR_CODES.FORBIDDEN,
31
+ 404: ERROR_CODES.NOT_FOUND,
32
+ 409: ERROR_CODES.CONFLICT,
33
+ 416: ERROR_CODES.RANGE_NOT_SATISFIABLE,
34
+ 429: ERROR_CODES.RATE_LIMIT_EXCEEDED,
21
35
  };
36
+ export const errorHandler = (error, request, reply) => {
37
+ if (hasZodFastifySchemaValidationErrors(error)) {
38
+ const violations = error.validation.map((v) => ({
39
+ field: v.instancePath,
40
+ message: v.message,
41
+ }));
42
+ return reply.code(400).send(createValidationError('The request parameters are invalid', violations));
43
+ }
44
+ const { statusCode, status, message, headers, expose, code } = (error ?? {});
45
+ const httpStatus = statusCode ?? status;
46
+ const trusted = expose === true || (typeof code === 'string' && code.startsWith('FST_'));
47
+ if (trusted && httpStatus && httpStatus >= 400 && httpStatus < 500) {
48
+ const errorCode = ERROR_CODE_BY_STATUS[httpStatus] ?? ERROR_CODES.VALIDATION_ERROR;
49
+ return reply
50
+ .code(httpStatus)
51
+ .headers(headers ?? {})
52
+ .send(createError(errorCode, message ?? ''));
53
+ }
54
+ request.log.error({ err: error });
55
+ return reply.code(500).send(createInternalError());
56
+ };
57
+ export const notFoundHandler = (_request, reply) => reply.code(404).send(createNotFoundError('The requested resource was not found'));
22
58
  //# sourceMappingURL=errors.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,GAAG;IAClB,gBAAgB,EAAE,kBAAkB;IACpC,SAAS,EAAE,WAAW;IACtB,mBAAmB,EAAE,qBAAqB;IAC1C,cAAc,EAAE,gBAAgB;IAChC,eAAe,EAAE,iBAAiB;IAClC,mBAAmB,EAAE,qBAAqB;CAClC,CAAC;AAgBX,MAAM,mBAAmB,GAAG,CAAC,IAAe,EAAE,OAAe,EAAE,OAAsB,EAAyB,EAAE,CAAC,CAAC;IAChH,KAAK,EAAE;QACL,IAAI;QACJ,OAAO;QACP,OAAO;KACR;CACF,CAAC,CAAC;AAQH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,UAAiC,EAAyB,EAAE,CACjH,mBAAmB,CAAC,WAAW,CAAC,gBAAgB,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAe,EAAE,QAAiB,EAAyB,EAAE,CAC/F,mBAAmB,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAE3F,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,OAAe,EAAyB,EAAE,CAClF,mBAAmB,CAAC,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;AAE5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAO,GAAG,uBAAuB,EAAyB,EAAE;IAC9F,OAAO,mBAAmB,CAAC,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC,CAAC"}
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mCAAmC,EAAE,MAAM,2BAA2B,CAAC;AAEhF,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,gBAAgB,EAAE,kBAAkB;IACpC,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,qBAAqB,EAAE,uBAAuB;IAC9C,mBAAmB,EAAE,qBAAqB;IAC1C,cAAc,EAAE,gBAAgB;IAChC,mBAAmB,EAAE,qBAAqB;CAClC,CAAC;AAgBX,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAe,EAAE,OAAe,EAAE,OAAsB,EAAyB,EAAE,CAAC,CAAC;IAC/G,KAAK,EAAE;QACL,IAAI;QACJ,OAAO;QACP,OAAO;KACR;CACF,CAAC,CAAC;AAQH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,UAAiC,EAAyB,EAAE,CACjH,WAAW,CAAC,WAAW,CAAC,gBAAgB,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;AAErE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAe,EAAE,QAAiB,EAAyB,EAAE,CAC/F,WAAW,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAEnF,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,OAAe,EAAE,QAAgB,EAAyB,EAAE,CAC5G,WAAW,CAAC,WAAW,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAE/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,OAAe,EAAE,QAAgB,EAAyB,EAAE,CAC/F,WAAW,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAE5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAO,GAAG,uBAAuB,EAAyB,EAAE,CAC9F,WAAW,CAAC,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AAKnD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAmB,EAAE,SAAkB,EAAE,EAAU,EAAE,EAAE,CACjF,SAAS;IACP,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,oDAAoD,EAAE,EAAE,CAAC,CAAC;IACnH,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,oDAAoD,EAAE,EAAE,CAAC,CAAC,CAAC;AAE3G,MAAM,oBAAoB,GAA8B;IACtD,GAAG,EAAE,WAAW,CAAC,YAAY;IAC7B,GAAG,EAAE,WAAW,CAAC,SAAS;IAC1B,GAAG,EAAE,WAAW,CAAC,SAAS;IAC1B,GAAG,EAAE,WAAW,CAAC,QAAQ;IACzB,GAAG,EAAE,WAAW,CAAC,qBAAqB;IACtC,GAAG,EAAE,WAAW,CAAC,mBAAmB;CACrC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAc,EAAE,OAAuB,EAAE,KAAmB,EAAE,EAAE;IAC3F,IAAI,mCAAmC,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,KAAK,EAAE,CAAC,CAAC,YAAY;YACrB,OAAO,EAAE,CAAC,CAAC,OAAO;SACnB,CAAC,CAAC,CAAC;QAEJ,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,oCAAoC,EAAE,UAAU,CAAC,CAAC,CAAC;IACvG,CAAC;IAED,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE,CAE1E,CAAC;IACF,MAAM,UAAU,GAAG,UAAU,IAAI,MAAM,CAAC;IACxC,MAAM,OAAO,GAAG,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACzF,IAAI,OAAO,IAAI,UAAU,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;QACnE,MAAM,SAAS,GAAG,oBAAoB,CAAC,UAAU,CAAC,IAAI,WAAW,CAAC,gBAAgB,CAAC;QAEnF,OAAO,KAAK;aACT,IAAI,CAAC,UAAU,CAAC;aAChB,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;aACtB,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAElC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAAwB,EAAE,KAAmB,EAAE,EAAE,CAC/E,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,sCAAsC,CAAC,CAAC,CAAC"}
@@ -1,5 +1,5 @@
1
1
  import type { FastifyReply } from 'fastify';
2
- export declare const setFileHeaders: (reply: FastifyReply, metadata: {
2
+ export declare const setDeliveryHeaders: (reply: FastifyReply, metadata: {
3
3
  contentType: string;
4
4
  contentLength: number;
5
5
  etag?: string;
@@ -1,4 +1,9 @@
1
- export const setFileHeaders = (reply, metadata) => {
1
+ const contentSecurityPolicy = "default-src 'none'; style-src 'unsafe-inline'; sandbox";
2
+ const token = "[!#$%&'*+\\-.^_`|~0-9a-z]+";
3
+ const quotedString = '"(?:[^"\\\\]|\\\\.)*"';
4
+ const mediaType = new RegExp(`^(?:audio|video)/${token}(?:[ \\t]*;[ \\t]*${token}=(?:${token}|${quotedString}))*[ \\t]*$`, 'i');
5
+ const isMedia = (contentType) => mediaType.test(contentType);
6
+ export const setDeliveryHeaders = (reply, metadata) => {
2
7
  reply.header('Content-Type', metadata.contentType);
3
8
  reply.header('Content-Length', metadata.contentLength.toString());
4
9
  if (metadata.etag) {
@@ -7,5 +12,9 @@ export const setFileHeaders = (reply, metadata) => {
7
12
  if (metadata.lastModified) {
8
13
  reply.header('Last-Modified', metadata.lastModified.toUTCString());
9
14
  }
15
+ reply.header('X-Content-Type-Options', 'nosniff');
16
+ if (!isMedia(metadata.contentType)) {
17
+ reply.header('Content-Security-Policy', contentSecurityPolicy);
18
+ }
10
19
  };
11
20
  //# sourceMappingURL=headers.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"headers.js","sourceRoot":"","sources":["../../src/utils/headers.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,KAAmB,EACnB,QAA4F,EAC5F,EAAE;IACF,KAAK,CAAC,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,KAAK,CAAC,MAAM,CAAC,gBAAgB,EAAE,QAAQ,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;IAElE,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAC1B,KAAK,CAAC,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC;IACrE,CAAC;AACH,CAAC,CAAC"}
1
+ {"version":3,"file":"headers.js","sourceRoot":"","sources":["../../src/utils/headers.ts"],"names":[],"mappings":"AAGA,MAAM,qBAAqB,GAAG,wDAAwD,CAAC;AAEvF,MAAM,KAAK,GAAG,4BAA4B,CAAC;AAC3C,MAAM,YAAY,GAAG,uBAAuB,CAAC;AAC7C,MAAM,SAAS,GAAG,IAAI,MAAM,CAC1B,oBAAoB,KAAK,qBAAqB,KAAK,OAAO,KAAK,IAAI,YAAY,aAAa,EAC5F,GAAG,CACJ,CAAC;AAKF,MAAM,OAAO,GAAG,CAAC,WAAmB,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAErE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAmB,EACnB,QAA4F,EAC5F,EAAE;IACF,KAAK,CAAC,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,KAAK,CAAC,MAAM,CAAC,gBAAgB,EAAE,QAAQ,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;IAClE,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAC1B,KAAK,CAAC,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC;IACrE,CAAC;IAGD,KAAK,CAAC,MAAM,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IAClD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QACnC,KAAK,CAAC,MAAM,CAAC,yBAAyB,EAAE,qBAAqB,CAAC,CAAC;IACjE,CAAC;AACH,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ import type { FastifyInstance } from 'fastify';
2
+ export declare const setupValidation: (fastify: FastifyInstance) => void;
@@ -0,0 +1,8 @@
1
+ import { serializerCompiler, validatorCompiler } from 'fastify-type-provider-zod';
2
+ import { errorHandler } from './errors.js';
3
+ export const setupValidation = (fastify) => {
4
+ fastify.setValidatorCompiler(validatorCompiler);
5
+ fastify.setSerializerCompiler(serializerCompiler);
6
+ fastify.setErrorHandler(errorHandler);
7
+ };
8
+ //# sourceMappingURL=validation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAElF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAwB,EAAE,EAAE;IAC1D,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAChD,OAAO,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAElD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;AACxC,CAAC,CAAC"}
@@ -0,0 +1,18 @@
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
+ export declare const AllVisibleEntityFilter: EntityVisibilityFilter;
6
+ export declare const AllVisibleSearchFilter: SearchVisibilityFilter;
7
+ export declare const isAnonymous: (isAuthenticated: IsAuthenticated | undefined, context: RequestContext) => Promise<boolean>;
8
+ export type RefusalOptions = {
9
+ promptLoginForHidden: boolean;
10
+ isAuthenticated?: IsAuthenticated;
11
+ };
12
+ type NotVisibleResponderOptions = RefusalOptions & {
13
+ notFoundMessage: string;
14
+ exists: (id: string) => Promise<boolean>;
15
+ };
16
+ export declare const createNotVisibleResponder: ({ promptLoginForHidden, isAuthenticated, notFoundMessage, exists }: NotVisibleResponderOptions) => (reply: FastifyReply, id: string, context: RequestContext) => Promise<never>;
17
+ export declare const createEntityNotVisibleResponder: (prisma: PrismaClient, refusal: RefusalOptions) => (reply: FastifyReply, id: string, context: RequestContext) => Promise<never>;
18
+ export {};
@@ -0,0 +1,16 @@
1
+ import { createNotFoundError, sendRefusal } from './errors.js';
2
+ export const AllVisibleEntityFilter = () => ({});
3
+ export const AllVisibleSearchFilter = () => ({});
4
+ export const isAnonymous = async (isAuthenticated, context) => isAuthenticated ? !(await isAuthenticated(context)) : false;
5
+ export const createNotVisibleResponder = ({ promptLoginForHidden, isAuthenticated, notFoundMessage, exists }) => async (reply, id, context) => {
6
+ if (promptLoginForHidden && (await isAnonymous(isAuthenticated, context)) && (await exists(id))) {
7
+ return sendRefusal(reply, true, id);
8
+ }
9
+ return reply.code(404).send(createNotFoundError(notFoundMessage, id));
10
+ };
11
+ export const createEntityNotVisibleResponder = (prisma, refusal) => createNotVisibleResponder({
12
+ ...refusal,
13
+ notFoundMessage: 'The requested entity was not found',
14
+ exists: async (id) => (await prisma.entity.count({ where: { id } })) > 0,
15
+ });
16
+ //# sourceMappingURL=visibility.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"visibility.js","sourceRoot":"","sources":["../../src/utils/visibility.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAO/D,MAAM,CAAC,MAAM,sBAAsB,GAA2B,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAOzE,MAAM,CAAC,MAAM,sBAAsB,GAA2B,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAKzE,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,eAA4C,EAAE,OAAuB,EAAE,EAAE,CACzG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAgB9D,MAAM,CAAC,MAAM,yBAAyB,GACpC,CAAC,EAAE,oBAAoB,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,EAA8B,EAAE,EAAE,CACnG,KAAK,EAAE,KAAmB,EAAE,EAAU,EAAE,OAAuB,EAAE,EAAE;IACjE,IAAI,oBAAoB,IAAI,CAAC,MAAM,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAChG,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC;AACxE,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,MAAoB,EAAE,OAAuB,EAAE,EAAE,CAC/F,yBAAyB,CAAC;IACxB,GAAG,OAAO;IACV,eAAe,EAAE,oCAAoC;IACrD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC;CACzE,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,12 +1,17 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "arocapi",
4
- "version": "4.0.1",
4
+ "version": "5.0.0-beta.10",
5
5
  "description": "An RO-Crate API",
6
6
  "main": "dist/app.js",
7
7
  "exports": {
8
8
  ".": "./dist/app.js",
9
- "./express": "./dist/express.js"
9
+ "./search/opensearch": "./dist/search/opensearch/opensearch.js",
10
+ "./search/postgres": "./dist/search/postgres/postgres.js",
11
+ "./storage/directory": "./dist/storage/directory/directory.js",
12
+ "./storage/entity-meta": "./dist/storage/entity-meta/entity-meta.js",
13
+ "./storage/s3": "./dist/storage/s3/s3.js",
14
+ "./storage/ocfl": "./dist/storage/ocfl/ocfl.js"
10
15
  },
11
16
  "keywords": [
12
17
  "rocrate",
@@ -15,53 +20,66 @@
15
20
  "author": "John Ferlito <johnf@inodes.org>",
16
21
  "license": "ISC",
17
22
  "dependencies": {
18
- "@fastify/cors": "^11.2.0",
19
- "@fastify/sensible": "^6.0.4",
20
- "@opensearch-project/opensearch": "^3.5.1",
21
- "@prisma/config": "^7.5.0",
22
- "dotenv": "^17.3.1",
23
- "express": "^5.2.1",
24
- "fastify": "^5.8.4",
25
- "fastify-type-provider-zod": "^6.1.0",
26
- "zod": "^4.3.6"
23
+ "@fastify/sensible": "^6.0.7",
24
+ "content-disposition": "^3.0.0",
25
+ "fastify-type-provider-zod": "^7.0.0",
26
+ "zod": "^4.6.7"
27
27
  },
28
28
  "devDependencies": {
29
- "@biomejs/biome": "^2.4.9",
30
- "@commitlint/cli": "^20.5.0",
31
- "@commitlint/config-conventional": "^20.5.0",
32
- "@prisma/adapter-mariadb": "^7.5.0",
33
- "@prisma/client": "^7.5.0",
34
- "@semantic-release/changelog": "^6.0.3",
35
- "@semantic-release/git": "^10.0.1",
29
+ "@aws-sdk/client-s3": "^3.1157.0",
30
+ "@aws-sdk/s3-request-presigner": "^3.1157.0",
31
+ "@biomejs/biome": "^2.6.3",
32
+ "@commitlint/cli": "^21.2.4",
33
+ "@commitlint/config-conventional": "^21.2.4",
34
+ "@ocfl/ocfl-fs": "^1.0.0-beta.59",
35
+ "@opensearch-project/opensearch": "^3.9.0",
36
+ "@prisma/adapter-pg": "^7.10.1",
37
+ "@prisma/client": "^7.10.1",
38
+ "@prisma/config": "^7.10.1",
39
+ "@semantic-release/changelog": "^7.0.0",
40
+ "@semantic-release/git": "^11.0.1",
36
41
  "@total-typescript/ts-reset": "^0.6.1",
37
- "@types/express": "^5.0.6",
38
- "@types/node": "^24.12.0",
39
- "@vitest/coverage-v8": "^4.1.1",
40
- "@vitest/ui": "^4.1.1",
41
- "concurrently": "^9.2.1",
42
- "conventional-changelog-conventionalcommits": "^9.3.0",
42
+ "@types/node": "^26.6.5",
43
+ "@vitest/coverage-v8": "^5.0.5",
44
+ "@vitest/ui": "^5.0.5",
45
+ "concurrently": "^10.0.6",
46
+ "conventional-changelog-conventionalcommits": "^9.3.1",
47
+ "dotenv": "^18.0.9",
48
+ "fastify": "^5.12.7",
43
49
  "fastify-tsconfig": "^3.0.0",
44
- "knip": "^6.0.5",
45
- "lefthook": "^2.1.4",
46
- "prisma": "^7.5.0",
47
- "prisma-json-types-generator": "^4.1.1",
48
- "semantic-release": "^25.0.3",
49
- "tsx": "^4.21.0",
50
- "typescript": "^6.0.2",
51
- "vitest": "^4.1.1",
52
- "vitest-mock-extended": "^3.1.0"
50
+ "knip": "^6.43.0",
51
+ "lefthook": "^2.2.2",
52
+ "prisma": "^7.10.1",
53
+ "semantic-release": "^25.0.9",
54
+ "tsx": "^4.23.15",
55
+ "typescript": "^7.0.2",
56
+ "vitest": "^5.0.5",
57
+ "vitest-mock-extended": "^5.1.1"
53
58
  },
54
59
  "peerDependencies": {
55
- "@prisma/client": ">=6"
60
+ "@aws-sdk/client-s3": "^3",
61
+ "@aws-sdk/s3-request-presigner": "^3",
62
+ "@ocfl/ocfl-fs": "^1.0.0-beta.59",
63
+ "@opensearch-project/opensearch": "^3.9.0",
64
+ "@prisma/client": "^7.10.0",
65
+ "fastify": "^5.12.7"
56
66
  },
57
67
  "files": [
58
68
  "src",
59
69
  "!src/generated",
70
+ "!src/index.dev.ts",
71
+ "!src/reset.d.ts",
72
+ "!src/**/*.test.ts",
73
+ "!src/test/**",
74
+ "!src/**/__snapshots__/**",
60
75
  "dist",
61
- "!dist/generated",
76
+ "!dist/generated/**/*.js",
77
+ "!dist/generated/**/*.js.map",
78
+ "!dist/index.dev.*",
79
+ "!dist/**/*.test.*",
80
+ "!dist/test/**",
62
81
  "README.md",
63
- "prisma/models",
64
- "prisma.config.ts"
82
+ "prisma/models"
65
83
  ],
66
84
  "scripts": {
67
85
  "build": "tsc",
@@ -69,28 +87,49 @@
69
87
  "dev": "pnpm run dev:clean && pnpm run build && concurrently -k -p \"[{name}]\" -n \"TypeScript,App\" -c \"yellow.bold,cyan.bold\" \"pnpm:dev:start\" \"pnpm:watch\" ",
70
88
  "dev:start": "node --watch --env-file=.env dist/index.dev.js",
71
89
  "dev:clean": "rm -rf dist",
72
- "dbconsole": "docker compose exec db mysql --password=password catalog",
73
- "load-test-data": "tsx src/scripts/loadEntities.ts",
90
+ "dbconsole": "docker compose exec db psql -U postgres catalog",
91
+ "load-test-data": "tsx scripts/loadEntities.ts",
92
+ "fixtures:ocfl": "node scripts/buildOcflFixtures.ts",
74
93
  "lint:biome": "biome check",
75
94
  "lint:types": "tsc --noEmit",
95
+ "lint:examples": "tsc --emitDeclarationOnly && tsc -p website/examples",
96
+ "lint:consumer": "./scripts/check-consumer-types.sh",
76
97
  "lint:knip": "knip",
77
- "lint": "concurrently -p \"[{name}]\" -n \"biome,types,knip\" -c \"yellow.bold,cyan.bold,magenta.bold\" \"pnpm:lint:biome\" \"pnpm:lint:types\" \"pnpm:lint:knip\"",
78
- "test": "vitest run",
98
+ "lint": "prisma generate >/dev/null && concurrently -p \"[{name}]\" -n \"biome,types,knip,examples,consumer\" -c \"yellow.bold,cyan.bold,magenta.bold,green.bold,blue.bold\" \"pnpm:lint:biome\" \"pnpm:lint:types\" \"pnpm:lint:knip\" \"pnpm:lint:examples\" \"pnpm:lint:consumer\"",
99
+ "test": "./scripts/setup-integration.sh vitest run",
100
+ "test:ci": "vitest run",
79
101
  "test:watch": "./scripts/setup-integration.sh && vitest",
80
102
  "test:ui": "./scripts/setup-integration.sh && vitest --ui",
81
- "test:coverage": "./scripts/setup-integration.sh && vitest run --coverage",
82
- "generate": "npx prisma generate",
103
+ "test:coverage": "./scripts/setup-integration.sh vitest run --coverage",
104
+ "generate": "prisma generate",
83
105
  "db:generate": "prisma generate",
84
106
  "db:migrate": "prisma migrate deploy",
85
107
  "seed": "rm -rf dist && pnpm run build && node --env-file=.env example/data/seed.ts"
86
108
  },
87
109
  "repository": {
88
110
  "type": "git",
89
- "url": "https://github.com/Language-Research-Technology/arocapi"
111
+ "url": "https://github.com/crate-works/arocapi"
90
112
  },
91
113
  "publishConfig": {
92
114
  "registry": "https://registry.npmjs.org/",
93
115
  "provenance": true
94
116
  },
95
- "packageManager": "pnpm@10.24.0+sha512.01ff8ae71b4419903b65c60fb2dc9d34cf8bb6e06d03bde112ef38f7a34d6904c424ba66bea5cdcf12890230bf39f9580473140ed9c946fef328b6e5238a345a"
117
+ "packageManager": "pnpm@12.15.0",
118
+ "peerDependenciesMeta": {
119
+ "@aws-sdk/client-s3": {
120
+ "optional": true
121
+ },
122
+ "@aws-sdk/s3-request-presigner": {
123
+ "optional": true
124
+ },
125
+ "@ocfl/ocfl-fs": {
126
+ "optional": true
127
+ },
128
+ "@opensearch-project/opensearch": {
129
+ "optional": true
130
+ }
131
+ },
132
+ "engines": {
133
+ "node": ">=22.18"
134
+ }
96
135
  }
@@ -1,14 +1,14 @@
1
1
  model Entity {
2
- id String @id @db.VarChar(768)
2
+ id String @id
3
3
 
4
- name String @db.VarChar(512)
5
- description String @db.Text
4
+ name String
5
+ description String
6
6
 
7
- entityType String @db.VarChar(255)
8
- memberOf String? @db.VarChar(768)
9
- rootCollection String? @db.VarChar(768)
10
- metadataLicenseId String @db.VarChar(255)
11
- contentLicenseId String @db.VarChar(255)
7
+ entityType String
8
+ memberOf String?
9
+ rootCollection String?
10
+ metadataLicenseId String
11
+ contentLicenseId String
12
12
 
13
13
  meta Json?
14
14
 
@@ -16,6 +16,7 @@ model Entity {
16
16
  updatedAt DateTime @updatedAt
17
17
 
18
18
  file File?
19
+ search EntitySearch?
19
20
 
20
21
  @@index([memberOf])
21
22
  @@index([rootCollection])
@@ -0,0 +1,21 @@
1
+ /// One entity's search document, written by PostgresBackend through raw SQL
2
+ model EntitySearch {
3
+ id String @id
4
+
5
+ /// The document's declared values by field name, with dates as UTC ISO strings and without the geo field
6
+ values Json @default("{}")
7
+ /// Basic search text, weighted A–D from field weights 4–1
8
+ basic Unsupported("tsvector")
9
+ /// Every text field's lexemes, each prefixed with `<field>.`
10
+ text Unsupported("tsvector")
11
+ point Unsupported("point")?
12
+ geohash String?
13
+
14
+ entity Entity @relation(fields: [id], references: [id], onDelete: Cascade)
15
+
16
+ @@index([values(ops: JsonbPathOps)], type: Gin)
17
+ @@index([basic], type: Gin)
18
+ @@index([text], type: Gin)
19
+ @@index([point], type: Gist)
20
+ @@map("entity_search")
21
+ }
@@ -1,8 +1,8 @@
1
1
  model File {
2
- id String @id @db.VarChar(768)
2
+ id String @id
3
3
 
4
- filename String @db.VarChar(255)
5
- mediaType String @db.VarChar(127)
4
+ filename String
5
+ mediaType String
6
6
  size BigInt
7
7
 
8
8
  meta Json?