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,58 @@
1
+ import type { Readable } from 'node:stream';
2
+ import type { Entity, File } from '../generated/prisma/client.js';
3
+ import type { RequestContext } from '../types/context.js';
4
+ export type MaybePromise<T> = T | Promise<T>;
5
+ export type DeliveryHeaders = {
6
+ contentLength: number;
7
+ etag?: string;
8
+ lastModified?: Date;
9
+ };
10
+ export type StreamDelivery = {
11
+ type: 'stream';
12
+ open: () => MaybePromise<Readable>;
13
+ } & DeliveryHeaders;
14
+ export type PathDelivery = {
15
+ type: 'path';
16
+ path: string;
17
+ } & DeliveryHeaders;
18
+ export type RedirectDelivery = {
19
+ type: 'redirect';
20
+ url: string;
21
+ };
22
+ export type JsonDelivery = {
23
+ type: 'json';
24
+ value: unknown;
25
+ };
26
+ export type ContentDelivery = (StreamDelivery & {
27
+ contentType: string;
28
+ }) | (PathDelivery & {
29
+ contentType: string;
30
+ }) | RedirectDelivery;
31
+ export type MetadataDelivery = StreamDelivery | PathDelivery | RedirectDelivery | JsonDelivery;
32
+ export type ContentContext = RequestContext & {
33
+ contentDisposition: string;
34
+ };
35
+ export type MetadataSource = (entity: Entity, context: RequestContext) => MaybePromise<MetadataDelivery | null>;
36
+ export type ContentSource = (file: File, entity: Entity, context: ContentContext) => MaybePromise<ContentDelivery | null>;
37
+ export type StorageBackend = {
38
+ metadata: MetadataSource;
39
+ content: ContentSource;
40
+ };
41
+ export type StorageLocate<Key = string> = {
42
+ metadata?: (entity: Entity) => MaybePromise<Key | null>;
43
+ content?: (file: File, entity: Entity) => MaybePromise<Key | null>;
44
+ };
45
+ export type DirectoryStorageMeta = {
46
+ storagePath: string;
47
+ };
48
+ export type S3StorageMeta = {
49
+ storageKey: string;
50
+ };
51
+ export type OcflStorageMeta = {
52
+ ocflObject: string;
53
+ ocflPath?: string;
54
+ };
55
+ export type OcflLocation = {
56
+ object: string;
57
+ path: string;
58
+ };
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=backend.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"backend.js","sourceRoot":"","sources":["../../src/storage/backend.ts"],"names":[],"mappings":""}
@@ -0,0 +1,12 @@
1
+ import type { FastifyReply, FastifyRequest } from 'fastify';
2
+ import type { ContentDelivery, JsonDelivery } from './backend.js';
3
+ type SendOptions = {
4
+ contentDisposition?: string;
5
+ noRedirect?: boolean;
6
+ json?: boolean;
7
+ };
8
+ type TypedDelivery = ContentDelivery | (JsonDelivery & {
9
+ contentType: string;
10
+ });
11
+ export declare const sendDelivery: (request: FastifyRequest, reply: FastifyReply, delivery: TypedDelivery, { contentDisposition, noRedirect, json }?: SendOptions) => Promise<never>;
12
+ export {};
@@ -0,0 +1,34 @@
1
+ import { createHash } from 'node:crypto';
2
+ import { open } from 'node:fs/promises';
3
+ import { setDeliveryHeaders } from '../utils/headers.js';
4
+ export const sendDelivery = async (request, reply, delivery, { contentDisposition, noRedirect = false, json = false } = {}) => {
5
+ if (delivery.type === 'redirect') {
6
+ return noRedirect ? reply.code(200).send({ location: delivery.url }) : reply.redirect(delivery.url, 302);
7
+ }
8
+ const head = request.method === 'HEAD';
9
+ if (delivery.type === 'json' && json) {
10
+ const body = Buffer.from(JSON.stringify(delivery.value));
11
+ const etag = `"${createHash('sha256').update(body).digest('base64url')}"`;
12
+ setDeliveryHeaders(reply, { contentType: delivery.contentType, contentLength: body.length, etag });
13
+ return reply.code(200).send(head ? undefined : body);
14
+ }
15
+ if (delivery.type !== 'stream' && delivery.type !== 'path') {
16
+ throw new Error(`Storage returned a delivery of type ${JSON.stringify(delivery.type)}, which this route can't send`);
17
+ }
18
+ let body;
19
+ if (!head) {
20
+ body = delivery.type === 'stream' ? await delivery.open() : (await open(delivery.path)).createReadStream();
21
+ }
22
+ try {
23
+ setDeliveryHeaders(reply, delivery);
24
+ }
25
+ catch (error) {
26
+ body?.destroy();
27
+ throw error;
28
+ }
29
+ if (contentDisposition) {
30
+ reply.header('Content-Disposition', contentDisposition);
31
+ }
32
+ return reply.code(200).send(body);
33
+ };
34
+ //# sourceMappingURL=deliver.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"deliver.js","sourceRoot":"","sources":["../../src/storage/deliver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAiBzD,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,OAAuB,EACvB,KAAmB,EACnB,QAAuB,EACvB,EAAE,kBAAkB,EAAE,UAAU,GAAG,KAAK,EAAE,IAAI,GAAG,KAAK,EAAE,GAAgB,EAAE,EAC1E,EAAE;IACF,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACjC,OAAO,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC3G,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC;IAEvC,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACzD,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC;QAC1E,kBAAkB,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAEnG,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC3D,MAAM,IAAI,KAAK,CACb,uCAAuC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,+BAA+B,CACpG,CAAC;IACJ,CAAC;IAGD,IAAI,IAA0B,CAAC;IAC/B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,IAAI,GAAG,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,EAAE,CAAC;IAC7G,CAAC;IAED,IAAI,CAAC;QACH,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,EAAE,OAAO,EAAE,CAAC;QAChB,MAAM,KAAK,CAAC;IACd,CAAC;IACD,IAAI,kBAAkB,EAAE,CAAC;QACvB,KAAK,CAAC,MAAM,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC,CAAC"}
@@ -0,0 +1,6 @@
1
+ import type { StorageBackend, StorageLocate } from '../backend.js';
2
+ export type DirectoryStorageOptions = {
3
+ root: string;
4
+ locate?: StorageLocate;
5
+ };
6
+ export declare const DirectoryStorage: ({ root, locate }: DirectoryStorageOptions) => StorageBackend;
@@ -0,0 +1,24 @@
1
+ import { stat } from 'node:fs/promises';
2
+ import { join, resolve } from 'node:path';
3
+ import { keyLocator } from '../location.js';
4
+ import { nullIfMissing, pathDelivery, withContentType } from '../results.js';
5
+ export const DirectoryStorage = ({ root, locate = {} }) => {
6
+ const base = resolve(root);
7
+ const keys = keyLocator(locate, 'storagePath');
8
+ const deliver = async (key) => {
9
+ if (key === null) {
10
+ return null;
11
+ }
12
+ const path = join(base, key);
13
+ const stats = await nullIfMissing(stat(path));
14
+ if (!stats?.isFile()) {
15
+ return null;
16
+ }
17
+ return pathDelivery(path, stats, `W/"${stats.size.toString(16)}-${stats.mtime.getTime().toString(16)}"`);
18
+ };
19
+ return {
20
+ metadata: async (entity) => deliver(await keys.metadata(entity)),
21
+ content: async (file, entity) => withContentType(await deliver(await keys.content(file, entity)), file.mediaType),
22
+ };
23
+ };
24
+ //# sourceMappingURL=directory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"directory.js","sourceRoot":"","sources":["../../../src/storage/directory/directory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAY7E,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,EAAE,EAA2B,EAAkB,EAAE;IACjG,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,MAAM,IAAI,GAAG,UAAU,CAAuB,MAAM,EAAE,aAAa,CAAC,CAAC;IAErE,MAAM,OAAO,GAAG,KAAK,EAAE,GAAkB,EAAgC,EAAE;QACzE,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC3G,CAAC,CAAC;IAEF,OAAO;QACL,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAChE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,eAAe,CAAC,MAAM,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC;KAClH,CAAC;AACJ,CAAC,CAAC"}
@@ -0,0 +1,5 @@
1
+ import type { MetadataSource } from '../backend.js';
2
+ export type EntityMetaMetadataOptions = {
3
+ key?: string;
4
+ };
5
+ export declare const EntityMetaMetadata: ({ key }?: EntityMetaMetadataOptions) => MetadataSource;
@@ -0,0 +1,14 @@
1
+ import { isJsonObject, metaValue } from '../location.js';
2
+ export const EntityMetaMetadata = ({ key = 'rocrate' } = {}) => {
3
+ return async (entity) => {
4
+ const value = metaValue(entity.meta, key);
5
+ if (value === undefined) {
6
+ return null;
7
+ }
8
+ if (!isJsonObject(value)) {
9
+ throw new Error(`${entity.id} has a meta.${key} that is not a JSON object`);
10
+ }
11
+ return { type: 'json', value };
12
+ };
13
+ };
14
+ //# sourceMappingURL=entity-meta.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"entity-meta.js","sourceRoot":"","sources":["../../../src/storage/entity-meta/entity-meta.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAUzD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EAAE,GAAG,GAAG,SAAS,EAAE,GAA8B,EAAE,EAAkB,EAAE;IACxG,OAAO,KAAK,EAAE,MAAM,EAAE,EAAE;QACtB,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC1C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,CAAC,EAAE,eAAe,GAAG,4BAA4B,CAAC,CAAC;QAC9E,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IACjC,CAAC,CAAC;AACJ,CAAC,CAAC"}
@@ -0,0 +1,19 @@
1
+ import type { Entity, File, Prisma } from '../generated/prisma/client.js';
2
+ import type { StorageLocate } from './backend.js';
3
+ export declare const isJsonObject: (value: Prisma.JsonValue | undefined) => value is Prisma.JsonObject;
4
+ export declare const metaValue: (meta: Prisma.JsonValue, key: string) => import("@prisma/client/runtime/client").JsonValue | undefined;
5
+ export declare const metaString: <Meta>(meta: Prisma.JsonValue, id: string, key: Extract<keyof Meta, string>) => string | null;
6
+ export declare const safeKey: (key: string, id: string) => string;
7
+ type DefaultKeys<Key> = {
8
+ metadata: (entity: Entity) => Key | null;
9
+ content: (file: File) => Key | null;
10
+ };
11
+ export declare const locator: <Key>(locate: StorageLocate<Key>, defaults: DefaultKeys<Key>, check: (key: Key, id: string) => unknown) => {
12
+ metadata: (entity: Entity) => Promise<Key | null>;
13
+ content: (file: File, entity: Entity) => Promise<Key | null>;
14
+ };
15
+ export declare const keyLocator: <Meta>(locate: StorageLocate, key: Extract<keyof Meta, string>) => {
16
+ metadata: (entity: Entity) => Promise<string | null>;
17
+ content: (file: File, entity: Entity) => Promise<string | null>;
18
+ };
19
+ export {};
@@ -0,0 +1,36 @@
1
+ import { isAbsolute } from 'node:path';
2
+ export const isJsonObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
3
+ export const metaValue = (meta, key) => (isJsonObject(meta) ? meta[key] : undefined);
4
+ export const metaString = (meta, id, key) => {
5
+ const value = metaValue(meta, key);
6
+ if (value === undefined) {
7
+ return null;
8
+ }
9
+ if (typeof value !== 'string') {
10
+ throw new Error(`${id} has a meta.${key} that is not a string`);
11
+ }
12
+ return value;
13
+ };
14
+ export const safeKey = (key, id) => {
15
+ if (isAbsolute(key) || key.split(/[\\/]/).includes('..')) {
16
+ throw new Error(`${id} has an unsafe storage key ${JSON.stringify(key)}`);
17
+ }
18
+ return key;
19
+ };
20
+ export const locator = (locate, defaults, check) => {
21
+ const checked = (key, id) => {
22
+ if (key !== null) {
23
+ check(key, id);
24
+ }
25
+ return key;
26
+ };
27
+ return {
28
+ metadata: async (entity) => checked(await (locate.metadata ?? defaults.metadata)(entity), entity.id),
29
+ content: async (file, entity) => checked(await (locate.content ?? defaults.content)(file, entity), file.id),
30
+ };
31
+ };
32
+ export const keyLocator = (locate, key) => locator(locate, {
33
+ metadata: (entity) => metaString(entity.meta, entity.id, key),
34
+ content: (file) => metaString(file.meta, file.id, key),
35
+ }, safeKey);
36
+ //# sourceMappingURL=location.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"location.js","sourceRoot":"","sources":["../../src/storage/location.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAIvC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAmC,EAA8B,EAAE,CAC9F,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAGvE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAsB,EAAE,GAAW,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAM/G,MAAM,CAAC,MAAM,UAAU,GAAG,CAAO,IAAsB,EAAE,EAAU,EAAE,GAAgC,EAAE,EAAE;IACvG,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,eAAe,GAAG,uBAAuB,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,EAAU,EAAE,EAAE;IACjD,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,8BAA8B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAUF,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,MAA0B,EAC1B,QAA0B,EAC1B,KAAwC,EACxC,EAAE;IACF,MAAM,OAAO,GAAG,CAAC,GAAe,EAAE,EAAU,EAAE,EAAE;QAC9C,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACjB,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IAEF,OAAO;QACL,QAAQ,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC;QAC5G,OAAO,EAAE,KAAK,EAAE,IAAU,EAAE,MAAc,EAAE,EAAE,CAC5C,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;KAC7E,CAAC;AACJ,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAO,MAAqB,EAAE,GAAgC,EAAE,EAAE,CAC1F,OAAO,CACL,MAAM,EACN;IACE,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAO,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC;IACnE,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAO,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC;CAC7D,EACD,OAAO,CACR,CAAC"}
@@ -0,0 +1,6 @@
1
+ import type { OcflLocation, StorageBackend, StorageLocate } from '../backend.js';
2
+ export type OcflStorageOptions = {
3
+ root: string;
4
+ locate?: StorageLocate<OcflLocation>;
5
+ };
6
+ export declare const OcflStorage: ({ root, locate }: OcflStorageOptions) => Promise<StorageBackend>;
@@ -0,0 +1,45 @@
1
+ import { openStorageRoot } from '@ocfl/ocfl-fs';
2
+ import { locator, metaString, safeKey } from '../location.js';
3
+ import { nullIfMissing, withContentType } from '../results.js';
4
+ const METADATA_PATH = 'ro-crate-metadata.json';
5
+ const MISSING = new Set(['OBJECT_NOT_FOUND']);
6
+ const metaKey = (row, key) => metaString(row.meta, row.id, key);
7
+ const defaultLocations = {
8
+ metadata: (entity) => {
9
+ const object = metaKey(entity, 'ocflObject');
10
+ const path = metaKey(entity, 'ocflPath') ?? METADATA_PATH;
11
+ return object === null ? null : { object, path };
12
+ },
13
+ content: (file) => {
14
+ const object = metaKey(file, 'ocflObject');
15
+ const path = metaKey(file, 'ocflPath');
16
+ return object === null || path === null ? null : { object, path };
17
+ },
18
+ };
19
+ const safeLocation = ({ path }, id) => safeKey(path, id);
20
+ export const OcflStorage = async ({ root, locate = {} }) => {
21
+ const storageRoot = await openStorageRoot(root);
22
+ const locations = locator(locate, defaultLocations, safeLocation);
23
+ const deliver = async (location) => {
24
+ if (location === null) {
25
+ return null;
26
+ }
27
+ const object = await nullIfMissing(storageRoot.open(location.object), MISSING);
28
+ const file = object?.head.files.get(location.path);
29
+ if (!file) {
30
+ return null;
31
+ }
32
+ return {
33
+ type: 'stream',
34
+ open: () => file.stream(),
35
+ contentLength: await file.size(),
36
+ etag: `"${file.digest}"`,
37
+ lastModified: file.modifiedAt,
38
+ };
39
+ };
40
+ return {
41
+ metadata: async (entity) => deliver(await locations.metadata(entity)),
42
+ content: async (file, entity) => withContentType(await deliver(await locations.content(file, entity)), file.mediaType),
43
+ };
44
+ };
45
+ //# sourceMappingURL=ocfl.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ocfl.js","sourceRoot":"","sources":["../../../src/storage/ocfl/ocfl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGhD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAS/D,MAAM,aAAa,GAAG,wBAAwB,CAAC;AAE/C,MAAM,OAAO,GAAwB,IAAI,GAAG,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAEnE,MAAM,OAAO,GAAG,CAAC,GAAkB,EAAE,GAA0B,EAAE,EAAE,CAAC,UAAU,CAAkB,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;AAEvH,MAAM,gBAAgB,GAAG;IACvB,QAAQ,EAAE,CAAC,MAAc,EAAuB,EAAE;QAChD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,aAAa,CAAC;QAE1D,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IACD,OAAO,EAAE,CAAC,IAAU,EAAuB,EAAE;QAC3C,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAEvC,OAAO,MAAM,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACpE,CAAC;CACF,CAAC;AAGF,MAAM,YAAY,GAAG,CAAC,EAAE,IAAI,EAAgB,EAAE,EAAU,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAM/E,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,EAAE,EAAsB,EAA2B,EAAE;IACtG,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC;IAElE,MAAM,OAAO,GAAG,KAAK,EAAE,QAA6B,EAAkC,EAAE;QACtF,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;QAC/E,MAAM,IAAI,GAAG,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE;YACzB,aAAa,EAAE,MAAM,IAAI,CAAC,IAAI,EAAE;YAChC,IAAI,EAAE,IAAI,IAAI,CAAC,MAAM,GAAG;YACxB,YAAY,EAAE,IAAI,CAAC,UAAU;SAC9B,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAC9B,eAAe,CAAC,MAAM,OAAO,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC;KACxF,CAAC;AACJ,CAAC,CAAC"}
@@ -0,0 +1,7 @@
1
+ import type { Stats } from 'node:fs';
2
+ import type { PathDelivery } from './backend.js';
3
+ export declare const nullIfMissing: <T>(promise: Promise<T>, missing?: ReadonlySet<string>) => Promise<T | null>;
4
+ export declare const pathDelivery: (path: string, stats: Stats, etag: string) => PathDelivery;
5
+ export declare const withContentType: <Delivery extends object>(delivery: Delivery | null, contentType: string) => (Delivery & {
6
+ contentType: string;
7
+ }) | null;
@@ -0,0 +1,22 @@
1
+ const FS_MISSING = new Set(['ENOENT', 'ENOTDIR']);
2
+ export const nullIfMissing = async (promise, missing = FS_MISSING) => {
3
+ try {
4
+ return await promise;
5
+ }
6
+ catch (error) {
7
+ const { code, name } = error;
8
+ if (missing.has(String(code)) || missing.has(name)) {
9
+ return null;
10
+ }
11
+ throw error;
12
+ }
13
+ };
14
+ export const pathDelivery = (path, stats, etag) => ({
15
+ type: 'path',
16
+ path,
17
+ contentLength: stats.size,
18
+ etag,
19
+ lastModified: stats.mtime,
20
+ });
21
+ export const withContentType = (delivery, contentType) => delivery && { ...delivery, contentType };
22
+ //# sourceMappingURL=results.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"results.js","sourceRoot":"","sources":["../../src/storage/results.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,GAAwB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AAKvE,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAK,OAAmB,EAAE,OAAO,GAAG,UAAU,EAAqB,EAAE;IACrG,IAAI,CAAC;QACH,OAAO,MAAM,OAAO,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,KAA8B,CAAC;QACtD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,KAAY,EAAE,IAAY,EAAgB,EAAE,CAAC,CAAC;IACvF,IAAI,EAAE,MAAM;IACZ,IAAI;IACJ,aAAa,EAAE,KAAK,CAAC,IAAI;IACzB,IAAI;IACJ,YAAY,EAAE,KAAK,CAAC,KAAK;CAC1B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,eAAe,GAAG,CAA0B,QAAyB,EAAE,WAAmB,EAAE,EAAE,CACzG,QAAQ,IAAI,EAAE,GAAG,QAAQ,EAAE,WAAW,EAAE,CAAC"}
@@ -0,0 +1,10 @@
1
+ import { type S3Client } from '@aws-sdk/client-s3';
2
+ import type { StorageBackend, StorageLocate } from '../backend.js';
3
+ export type S3StorageOptions = {
4
+ client: S3Client;
5
+ bucket: string;
6
+ locate?: StorageLocate;
7
+ delivery?: 'redirect' | 'stream';
8
+ expiresIn?: number;
9
+ };
10
+ export declare const S3Storage: ({ client, bucket, locate, delivery, expiresIn, }: S3StorageOptions) => StorageBackend;
@@ -0,0 +1,47 @@
1
+ import { GetObjectCommand, HeadObjectCommand } from '@aws-sdk/client-s3';
2
+ import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
3
+ import { keyLocator } from '../location.js';
4
+ import { nullIfMissing, withContentType } from '../results.js';
5
+ const MISSING = new Set(['NoSuchKey', 'NotFound']);
6
+ export const S3Storage = ({ client, bucket, locate = {}, delivery = 'redirect', expiresIn = 300, }) => {
7
+ const keys = keyLocator(locate, 'storageKey');
8
+ const stream = async (key) => {
9
+ if (key === null) {
10
+ return null;
11
+ }
12
+ const head = await nullIfMissing(client.send(new HeadObjectCommand({ Bucket: bucket, Key: key })), MISSING);
13
+ if (!head) {
14
+ return null;
15
+ }
16
+ return {
17
+ type: 'stream',
18
+ contentLength: Number(head.ContentLength),
19
+ etag: head.ETag,
20
+ lastModified: head.LastModified,
21
+ open: async () => {
22
+ const object = await client.send(new GetObjectCommand({ Bucket: bucket, Key: key, IfMatch: head.ETag }));
23
+ return object.Body;
24
+ },
25
+ };
26
+ };
27
+ return {
28
+ metadata: async (entity) => stream(await keys.metadata(entity)),
29
+ content: async (file, entity, { contentDisposition }) => {
30
+ const Key = await keys.content(file, entity);
31
+ if (delivery === 'stream') {
32
+ return withContentType(await stream(Key), file.mediaType);
33
+ }
34
+ if (Key === null) {
35
+ return null;
36
+ }
37
+ const command = new GetObjectCommand({
38
+ Bucket: bucket,
39
+ Key,
40
+ ResponseContentType: file.mediaType,
41
+ ResponseContentDisposition: contentDisposition,
42
+ });
43
+ return { type: 'redirect', url: await getSignedUrl(client, command, { expiresIn }) };
44
+ },
45
+ };
46
+ };
47
+ //# sourceMappingURL=s3.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"s3.js","sourceRoot":"","sources":["../../../src/storage/s3/s3.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAiB,MAAM,oBAAoB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAc/D,MAAM,OAAO,GAAwB,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;AAKxE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,EACxB,MAAM,EACN,MAAM,EACN,MAAM,GAAG,EAAE,EACX,QAAQ,GAAG,UAAU,EACrB,SAAS,GAAG,GAAG,GACE,EAAkB,EAAE;IACrC,MAAM,IAAI,GAAG,UAAU,CAAgB,MAAM,EAAE,YAAY,CAAC,CAAC;IAE7D,MAAM,MAAM,GAAG,KAAK,EAAE,GAAkB,EAAkC,EAAE;QAC1E,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5G,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,YAAY,EAAE,IAAI,CAAC,YAAY;YAE/B,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;gBAEzG,OAAO,MAAM,CAAC,IAAgB,CAAC;YACjC,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC/D,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,kBAAkB,EAAE,EAAE,EAAE;YACtD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC7C,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC1B,OAAO,eAAe,CAAC,MAAM,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACjB,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;gBACnC,MAAM,EAAE,MAAM;gBACd,GAAG;gBACH,mBAAmB,EAAE,IAAI,CAAC,SAAS;gBACnC,0BAA0B,EAAE,kBAAkB;aAC/C,CAAC,CAAC;YAEH,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;QACvF,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}
@@ -1,8 +1,9 @@
1
1
  import type { Entity, File, PrismaClient } from '../generated/prisma/client.js';
2
- type EntityWithFile = Entity & {
3
- file?: {
4
- id: string;
5
- } | null;
2
+ import type { AccessFunction, AccessInfo } from '../types/access.js';
3
+ import type { RequestContext } from '../types/context.js';
4
+ export type EntityRow = Entity;
5
+ export type FileRow = File & {
6
+ entity: EntityRow;
6
7
  };
7
8
  type EntityReference = {
8
9
  id: string;
@@ -28,19 +29,10 @@ export type StandardEntity = {
28
29
  metadataLicenseId: string;
29
30
  contentLicenseId: string;
30
31
  };
31
- type AccessInfo = {
32
- metadata: boolean;
33
- content: boolean;
34
- metadataAuthorizationUrl?: string;
35
- contentAuthorizationUrl?: string;
36
- };
37
32
  export type AuthorisedEntity = StandardEntity & {
38
33
  access: AccessInfo;
39
34
  };
40
- type FileAccessInfo = {
41
- content: boolean;
42
- contentAuthorizationUrl?: string;
43
- };
35
+ type FileAccessInfo = Pick<AccessInfo, 'content' | 'contentAuthorizationUrl'>;
44
36
  export type StandardFile = {
45
37
  id: string;
46
38
  filename: string;
@@ -50,12 +42,9 @@ export type StandardFile = {
50
42
  export type AuthorisedFile = StandardFile & {
51
43
  access: FileAccessInfo;
52
44
  };
53
- export declare const baseEntityTransformer: (entity: EntityWithFile) => BaseEntity;
54
- export declare const AllPublicAccessTransformer: (entity: StandardEntity) => AuthorisedEntity;
55
- export declare const baseFileTransformer: (file: File) => StandardFile;
56
- export declare const AllPublicFileAccessTransformer: (file: StandardFile) => AuthorisedFile;
57
- export declare const resolveEntityReferences: (entities: Array<{
58
- memberOf: string | null;
59
- rootCollection: string | null;
60
- }>, prisma: PrismaClient) => Promise<Map<string, EntityReference>>;
45
+ export declare const baseEntityTransformer: (entity: EntityRow) => BaseEntity;
46
+ export declare const decideAccess: (entities: EntityRow[], access: AccessFunction, context: RequestContext) => Promise<AccessInfo[]>;
47
+ export declare const authoriseEntities: (entities: EntityRow[], prisma: PrismaClient, access: AccessFunction, context: RequestContext) => Promise<AuthorisedEntity[]>;
48
+ export declare const authoriseFiles: (files: FileRow[], access: AccessFunction, context: RequestContext) => Promise<AuthorisedFile[]>;
49
+ export declare const applyTransformers: <T, R>(item: T, transformers: Array<(item: T, context: RequestContext, row: R) => Promise<T> | T>, context: RequestContext, row: R) => Promise<T>;
61
50
  export {};
@@ -11,26 +11,13 @@ export const baseEntityTransformer = (entity) => {
11
11
  };
12
12
  return base;
13
13
  };
14
- export const AllPublicAccessTransformer = (entity) => ({
15
- ...entity,
16
- access: {
17
- metadata: true,
18
- content: true,
19
- },
20
- });
21
- export const baseFileTransformer = (file) => ({
14
+ const baseFileTransformer = (file) => ({
22
15
  id: file.id,
23
16
  filename: file.filename,
24
17
  mediaType: file.mediaType,
25
18
  size: Number(file.size),
26
19
  });
27
- export const AllPublicFileAccessTransformer = (file) => ({
28
- ...file,
29
- access: {
30
- content: true,
31
- },
32
- });
33
- export const resolveEntityReferences = async (entities, prisma) => {
20
+ const resolveEntityReferences = async (entities, prisma) => {
34
21
  const refIds = new Set();
35
22
  entities.forEach((e) => {
36
23
  if (e.memberOf) {
@@ -49,4 +36,43 @@ export const resolveEntityReferences = async (entities, prisma) => {
49
36
  });
50
37
  return new Map(refs.map((r) => [r.id, { id: r.id, name: r.name }]));
51
38
  };
39
+ const toStandardEntities = async (entities, prisma) => {
40
+ const refMap = await resolveEntityReferences(entities, prisma);
41
+ return entities.map((entity) => {
42
+ const base = baseEntityTransformer(entity);
43
+ return {
44
+ ...base,
45
+ memberOf: base.memberOf ? (refMap.get(base.memberOf) ?? null) : null,
46
+ rootCollection: base.rootCollection ? (refMap.get(base.rootCollection) ?? null) : null,
47
+ };
48
+ });
49
+ };
50
+ const pickAccess = ({ metadata, content, metadataAuthorizationUrl, contentAuthorizationUrl, }) => ({
51
+ metadata,
52
+ content,
53
+ ...(metadataAuthorizationUrl && { metadataAuthorizationUrl }),
54
+ ...(contentAuthorizationUrl && { contentAuthorizationUrl }),
55
+ });
56
+ export const decideAccess = async (entities, access, context) => Promise.all(entities.map(async (entity) => pickAccess(await access(baseEntityTransformer(entity), context, entity))));
57
+ export const authoriseEntities = async (entities, prisma, access, context) => {
58
+ const [standardEntities, entityAccess] = await Promise.all([
59
+ toStandardEntities(entities, prisma),
60
+ decideAccess(entities, access, context),
61
+ ]);
62
+ return standardEntities.map((entity, i) => ({ ...entity, access: entityAccess[i] }));
63
+ };
64
+ export const authoriseFiles = async (files, access, context) => {
65
+ const fileEntityAccess = await decideAccess(files.map((file) => file.entity), access, context);
66
+ return files.map((file, i) => {
67
+ const { metadata: _metadata, metadataAuthorizationUrl: _metadataUrl, ...fileAccess } = fileEntityAccess[i];
68
+ return { ...baseFileTransformer(file), access: fileAccess };
69
+ });
70
+ };
71
+ export const applyTransformers = async (item, transformers, context, row) => {
72
+ let result = item;
73
+ for (const transformer of transformers) {
74
+ result = await transformer(result, context, row);
75
+ }
76
+ return result;
77
+ };
52
78
  //# sourceMappingURL=default.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"default.js","sourceRoot":"","sources":["../../src/transformers/default.ts"],"names":[],"mappings":"AA8FA,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAsB,EAAc,EAAE;IAC1E,MAAM,IAAI,GAAe;QACvB,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;QAC3C,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;KAC1C,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAoBF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,MAAsB,EAAoB,EAAE,CAAC,CAAC;IACvF,GAAG,MAAM;IACT,MAAM,EAAE;QACN,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI;KACd;CACF,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAU,EAAgB,EAAE,CAAC,CAAC;IAChE,EAAE,EAAE,IAAI,CAAC,EAAE;IACX,QAAQ,EAAE,IAAI,CAAC,QAAQ;IACvB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;CACxB,CAAC,CAAC;AAwBH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,IAAkB,EAAkB,EAAE,CAAC,CAAC;IACrF,GAAG,IAAI;IACP,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;KACd;CACF,CAAC,CAAC;AAUH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAC1C,QAA2E,EAC3E,MAAoB,EACmB,EAAE;IACzC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IAEjC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACrB,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,CAAC,cAAc,EAAE,CAAC;YACrB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACxC,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,EAAE;QAClC,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;KACjC,CAAC,CAAC;IAEH,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC"}
1
+ {"version":3,"file":"default.js","sourceRoot":"","sources":["../../src/transformers/default.ts"],"names":[],"mappings":"AAqFA,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAiB,EAAc,EAAE;IACrE,MAAM,IAAI,GAAe;QACvB,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;QAC3C,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;KAC1C,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAMF,MAAM,mBAAmB,GAAG,CAAC,IAAU,EAAgB,EAAE,CAAC,CAAC;IACzD,EAAE,EAAE,IAAI,CAAC,EAAE;IACX,QAAQ,EAAE,IAAI,CAAC,QAAQ;IACvB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;CACxB,CAAC,CAAC;AAUH,MAAM,uBAAuB,GAAG,KAAK,EACnC,QAA2E,EAC3E,MAAoB,EACmB,EAAE;IACzC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IAEjC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACrB,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,CAAC,cAAc,EAAE,CAAC;YACrB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACxC,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,EAAE;QAClC,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;KACjC,CAAC,CAAC;IAEH,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC;AAKF,MAAM,kBAAkB,GAAG,KAAK,EAAE,QAAqB,EAAE,MAAoB,EAA6B,EAAE;IAC1G,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE/D,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE3C,OAAO;YACL,GAAG,IAAI;YACP,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;YACpE,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;SACvF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,EAClB,QAAQ,EACR,OAAO,EACP,wBAAwB,EACxB,uBAAuB,GACZ,EAAc,EAAE,CAAC,CAAC;IAC7B,QAAQ;IACR,OAAO;IACP,GAAG,CAAC,wBAAwB,IAAI,EAAE,wBAAwB,EAAE,CAAC;IAC7D,GAAG,CAAC,uBAAuB,IAAI,EAAE,uBAAuB,EAAE,CAAC;CAC5D,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,QAAqB,EACrB,MAAsB,EACtB,OAAuB,EACA,EAAE,CACzB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAKxH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EACpC,QAAqB,EACrB,MAAoB,EACpB,MAAsB,EACtB,OAAuB,EACM,EAAE;IAC/B,MAAM,CAAC,gBAAgB,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACzD,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC;QACpC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC;KACxC,CAAC,CAAC;IAEH,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACvF,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EACjC,KAAgB,EAChB,MAAsB,EACtB,OAAuB,EACI,EAAE;IAC7B,MAAM,gBAAgB,GAAG,MAAM,YAAY,CACzC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAChC,MAAM,EACN,OAAO,CACR,CAAC;IAEF,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QAC3B,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,wBAAwB,EAAE,YAAY,EAAE,GAAG,UAAU,EAAE,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAE3G,OAAO,EAAE,GAAG,mBAAmB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EACpC,IAAO,EACP,YAAiF,EACjF,OAAuB,EACvB,GAAM,EACM,EAAE;IACd,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
@@ -0,0 +1,9 @@
1
+ import type { BaseEntity, EntityRow } from '../transformers/default.js';
2
+ import type { RequestContext } from './context.js';
3
+ export type AccessInfo = {
4
+ metadata: boolean;
5
+ content: boolean;
6
+ metadataAuthorizationUrl?: string;
7
+ contentAuthorizationUrl?: string;
8
+ };
9
+ export type AccessFunction = (entity: BaseEntity, context: RequestContext, row: EntityRow) => Promise<AccessInfo> | AccessInfo;
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=access.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"access.js","sourceRoot":"","sources":["../../src/types/access.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ import type { FastifyInstance, FastifyRequest } from 'fastify';
2
+ export type RequestContext = {
3
+ request: FastifyRequest;
4
+ fastify: FastifyInstance;
5
+ };
6
+ export type IsAuthenticated = (context: RequestContext) => Promise<boolean> | boolean;
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/types/context.ts"],"names":[],"mappings":""}
@@ -1,10 +1,4 @@
1
- import type { FastifyInstance, FastifyRequest } from 'fastify';
2
- import type { AuthorisedEntity, AuthorisedFile, StandardEntity, StandardFile } from '../transformers/default.js';
3
- export type TransformerContext = {
4
- request: FastifyRequest;
5
- fastify: FastifyInstance;
6
- };
7
- export type AccessTransformer = (entity: StandardEntity, context: TransformerContext) => Promise<AuthorisedEntity> | AuthorisedEntity;
8
- export type EntityTransformer<TInput = AuthorisedEntity, TOutput = TInput> = (entity: TInput, context: TransformerContext) => Promise<TOutput> | TOutput;
9
- export type FileAccessTransformer = (file: StandardFile, context: TransformerContext) => Promise<AuthorisedFile> | AuthorisedFile;
10
- export type FileTransformer<TInput = AuthorisedFile, TOutput = TInput> = (file: TInput, context: TransformerContext) => Promise<TOutput> | TOutput;
1
+ import type { AuthorisedEntity, AuthorisedFile, EntityRow, FileRow } from '../transformers/default.js';
2
+ import type { RequestContext } from './context.js';
3
+ export type EntityTransformer<TInput = AuthorisedEntity, TOutput = TInput> = (entity: TInput, context: RequestContext, row: EntityRow) => Promise<TOutput> | TOutput;
4
+ export type FileTransformer<TInput = AuthorisedFile, TOutput = TInput> = (file: TInput, context: RequestContext, row: FileRow) => Promise<TOutput> | TOutput;
@@ -0,0 +1,6 @@
1
+ import type { Prisma } from '../generated/prisma/client.js';
2
+ import type { FieldDeclarations } from '../search/fields.js';
3
+ import type { SearchVisibilityWhere } from '../search/visibility.js';
4
+ import type { RequestContext } from './context.js';
5
+ export type EntityVisibilityFilter = (context: RequestContext) => Promise<Prisma.EntityWhereInput> | Prisma.EntityWhereInput;
6
+ export type SearchVisibilityFilter<Fields extends FieldDeclarations = FieldDeclarations> = (context: RequestContext) => Promise<SearchVisibilityWhere<Fields>> | SearchVisibilityWhere<Fields>;
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=visibility.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"visibility.js","sourceRoot":"","sources":["../../src/types/visibility.ts"],"names":[],"mappings":""}