arocapi 5.0.0-beta.5 → 5.0.0-beta.7

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 (205) hide show
  1. package/LICENSE.md +1 -1
  2. package/README.md +2 -2
  3. package/dist/app.d.ts +22 -17
  4. package/dist/app.js +22 -16
  5. package/dist/app.js.map +1 -1
  6. package/dist/routes/capabilities.d.ts +2 -2
  7. package/dist/routes/capabilities.js +2 -2
  8. package/dist/routes/capabilities.js.map +1 -1
  9. package/dist/routes/entities.js +8 -9
  10. package/dist/routes/entities.js.map +1 -1
  11. package/dist/routes/file.d.ts +2 -2
  12. package/dist/routes/file.js +25 -72
  13. package/dist/routes/file.js.map +1 -1
  14. package/dist/routes/metadata.d.ts +5 -5
  15. package/dist/routes/metadata.js +22 -61
  16. package/dist/routes/metadata.js.map +1 -1
  17. package/dist/routes/search.d.ts +2 -4
  18. package/dist/routes/search.js +75 -97
  19. package/dist/routes/search.js.map +1 -1
  20. package/dist/search/advanced.d.ts +8 -0
  21. package/dist/search/advanced.js +198 -0
  22. package/dist/search/advanced.js.map +1 -0
  23. package/dist/search/backend.d.ts +95 -0
  24. package/dist/search/backend.js +5 -0
  25. package/dist/search/backend.js.map +1 -0
  26. package/dist/search/fields.d.ts +63 -0
  27. package/dist/search/fields.js +203 -0
  28. package/dist/search/fields.js.map +1 -0
  29. package/dist/search/opensearch/advanced.d.ts +4 -0
  30. package/dist/search/opensearch/advanced.js +28 -0
  31. package/dist/search/opensearch/advanced.js.map +1 -0
  32. package/dist/search/opensearch/opensearch.d.ts +16 -0
  33. package/dist/search/opensearch/opensearch.js +187 -0
  34. package/dist/search/opensearch/opensearch.js.map +1 -0
  35. package/dist/search/opensearch/visibility.d.ts +3 -0
  36. package/dist/search/opensearch/visibility.js +27 -0
  37. package/dist/search/opensearch/visibility.js.map +1 -0
  38. package/dist/search/postgres/advanced.d.ts +7 -0
  39. package/dist/search/postgres/advanced.js +54 -0
  40. package/dist/search/postgres/advanced.js.map +1 -0
  41. package/dist/search/postgres/facets.d.ts +2 -0
  42. package/dist/search/postgres/facets.js +27 -0
  43. package/dist/search/postgres/facets.js.map +1 -0
  44. package/dist/search/postgres/geo.d.ts +6 -0
  45. package/dist/search/postgres/geo.js +42 -0
  46. package/dist/search/postgres/geo.js.map +1 -0
  47. package/dist/search/postgres/postgres.d.ts +19 -0
  48. package/dist/search/postgres/postgres.js +157 -0
  49. package/dist/search/postgres/postgres.js.map +1 -0
  50. package/dist/search/postgres/values.d.ts +8 -0
  51. package/dist/search/postgres/values.js +20 -0
  52. package/dist/search/postgres/values.js.map +1 -0
  53. package/dist/search/postgres/visibility.d.ts +4 -0
  54. package/dist/search/postgres/visibility.js +38 -0
  55. package/dist/search/postgres/visibility.js.map +1 -0
  56. package/dist/search/requestFilters.d.ts +39 -0
  57. package/dist/search/requestFilters.js +125 -0
  58. package/dist/search/requestFilters.js.map +1 -0
  59. package/dist/search/visibility.d.ts +51 -0
  60. package/dist/search/visibility.js +100 -0
  61. package/dist/search/visibility.js.map +1 -0
  62. package/dist/storage/backend.d.ts +58 -0
  63. package/dist/storage/backend.js +2 -0
  64. package/dist/storage/backend.js.map +1 -0
  65. package/dist/storage/deliver.d.ts +12 -0
  66. package/dist/storage/deliver.js +34 -0
  67. package/dist/storage/deliver.js.map +1 -0
  68. package/dist/storage/directory/directory.d.ts +6 -0
  69. package/dist/storage/directory/directory.js +24 -0
  70. package/dist/storage/directory/directory.js.map +1 -0
  71. package/dist/storage/entity-meta/entity-meta.d.ts +5 -0
  72. package/dist/storage/entity-meta/entity-meta.js +14 -0
  73. package/dist/storage/entity-meta/entity-meta.js.map +1 -0
  74. package/dist/storage/location.d.ts +20 -0
  75. package/dist/storage/location.js +40 -0
  76. package/dist/storage/location.js.map +1 -0
  77. package/dist/storage/ocfl/ocfl.d.ts +7 -0
  78. package/dist/storage/ocfl/ocfl.js +79 -0
  79. package/dist/storage/ocfl/ocfl.js.map +1 -0
  80. package/dist/storage/ocfl/ocflFs.d.ts +7 -0
  81. package/dist/storage/ocfl/ocflFs.js +33 -0
  82. package/dist/storage/ocfl/ocflFs.js.map +1 -0
  83. package/dist/storage/results.d.ts +7 -0
  84. package/dist/storage/results.js +22 -0
  85. package/dist/storage/results.js.map +1 -0
  86. package/dist/storage/s3/s3.d.ts +10 -0
  87. package/dist/storage/s3/s3.js +47 -0
  88. package/dist/storage/s3/s3.js.map +1 -0
  89. package/dist/types/visibility.d.ts +3 -2
  90. package/dist/utils/visibility.js +1 -1
  91. package/dist/utils/visibility.js.map +1 -1
  92. package/package.json +66 -26
  93. package/prisma/models/entity.prisma +9 -8
  94. package/prisma/models/entitySearch.prisma +21 -0
  95. package/prisma/models/file.prisma +3 -3
  96. package/src/app.ts +85 -48
  97. package/src/routes/capabilities.ts +4 -4
  98. package/src/routes/entities.ts +10 -9
  99. package/src/routes/file.ts +23 -99
  100. package/src/routes/metadata.ts +24 -86
  101. package/src/routes/search.ts +104 -118
  102. package/src/search/advanced.ts +258 -0
  103. package/src/search/backend.ts +91 -0
  104. package/src/search/fields.ts +320 -0
  105. package/src/search/opensearch/advanced.ts +36 -0
  106. package/src/search/opensearch/opensearch.ts +290 -0
  107. package/src/search/opensearch/visibility.ts +38 -0
  108. package/src/search/postgres/advanced.ts +76 -0
  109. package/src/search/postgres/facets.ts +34 -0
  110. package/src/search/postgres/geo.ts +58 -0
  111. package/src/search/postgres/postgres.ts +232 -0
  112. package/src/search/postgres/values.ts +33 -0
  113. package/src/search/postgres/visibility.ts +54 -0
  114. package/src/search/requestFilters.ts +178 -0
  115. package/src/search/visibility.ts +193 -0
  116. package/src/storage/backend.ts +75 -0
  117. package/src/storage/deliver.ts +65 -0
  118. package/src/storage/directory/directory.ts +39 -0
  119. package/src/storage/entity-meta/entity-meta.ts +25 -0
  120. package/src/storage/location.ts +85 -0
  121. package/src/storage/ocfl/ocfl.ts +129 -0
  122. package/src/storage/ocfl/ocflFs.ts +67 -0
  123. package/src/storage/results.ts +32 -0
  124. package/src/storage/s3/s3.ts +79 -0
  125. package/src/types/visibility.ts +6 -3
  126. package/src/utils/visibility.ts +1 -1
  127. package/dist/app.test.d.ts +0 -1
  128. package/dist/app.test.js +0 -67
  129. package/dist/app.test.js.map +0 -1
  130. package/dist/errorHandling.test.d.ts +0 -1
  131. package/dist/errorHandling.test.js +0 -222
  132. package/dist/errorHandling.test.js.map +0 -1
  133. package/dist/index.dev.d.ts +0 -1
  134. package/dist/index.dev.js +0 -157
  135. package/dist/index.dev.js.map +0 -1
  136. package/dist/routes/capabilities.test.d.ts +0 -1
  137. package/dist/routes/capabilities.test.js +0 -81
  138. package/dist/routes/capabilities.test.js.map +0 -1
  139. package/dist/routes/crate.test.d.ts +0 -1
  140. package/dist/routes/crate.test.js +0 -390
  141. package/dist/routes/crate.test.js.map +0 -1
  142. package/dist/routes/entities.test.d.ts +0 -1
  143. package/dist/routes/entities.test.js +0 -277
  144. package/dist/routes/entities.test.js.map +0 -1
  145. package/dist/routes/entity.test.d.ts +0 -1
  146. package/dist/routes/entity.test.js +0 -136
  147. package/dist/routes/entity.test.js.map +0 -1
  148. package/dist/routes/file.test.d.ts +0 -1
  149. package/dist/routes/file.test.js +0 -435
  150. package/dist/routes/file.test.js.map +0 -1
  151. package/dist/routes/files.test.d.ts +0 -1
  152. package/dist/routes/files.test.js +0 -245
  153. package/dist/routes/files.test.js.map +0 -1
  154. package/dist/routes/search.test.d.ts +0 -1
  155. package/dist/routes/search.test.js +0 -833
  156. package/dist/routes/search.test.js.map +0 -1
  157. package/dist/test/helpers/fastify.d.ts +0 -9
  158. package/dist/test/helpers/fastify.js +0 -17
  159. package/dist/test/helpers/fastify.js.map +0 -1
  160. package/dist/test/integration.setup.d.ts +0 -47
  161. package/dist/test/integration.setup.js +0 -195
  162. package/dist/test/integration.setup.js.map +0 -1
  163. package/dist/test/integration.test.d.ts +0 -1
  164. package/dist/test/integration.test.js +0 -762
  165. package/dist/test/integration.test.js.map +0 -1
  166. package/dist/transformers/default.test.d.ts +0 -1
  167. package/dist/transformers/default.test.js +0 -225
  168. package/dist/transformers/default.test.js.map +0 -1
  169. package/dist/transformers/transformer.test.d.ts +0 -1
  170. package/dist/transformers/transformer.test.js +0 -165
  171. package/dist/transformers/transformer.test.js.map +0 -1
  172. package/dist/types/fileHandlers.d.ts +0 -37
  173. package/dist/types/fileHandlers.js +0 -2
  174. package/dist/types/fileHandlers.js.map +0 -1
  175. package/dist/utils/errors.test.d.ts +0 -1
  176. package/dist/utils/errors.test.js +0 -79
  177. package/dist/utils/errors.test.js.map +0 -1
  178. package/dist/utils/queryBuilder.d.ts +0 -47
  179. package/dist/utils/queryBuilder.js +0 -107
  180. package/dist/utils/queryBuilder.js.map +0 -1
  181. package/prisma.config.ts +0 -9
  182. package/src/app.test.ts +0 -91
  183. package/src/errorHandling.test.ts +0 -288
  184. package/src/index.dev.ts +0 -202
  185. package/src/reset.d.ts +0 -1
  186. package/src/routes/__snapshots__/capabilities.test.ts.snap +0 -34
  187. package/src/routes/__snapshots__/entities.test.ts.snap +0 -96
  188. package/src/routes/__snapshots__/entity.test.ts.snap +0 -74
  189. package/src/routes/__snapshots__/search.test.ts.snap +0 -165
  190. package/src/routes/capabilities.test.ts +0 -102
  191. package/src/routes/crate.test.ts +0 -484
  192. package/src/routes/entities.test.ts +0 -324
  193. package/src/routes/entity.test.ts +0 -166
  194. package/src/routes/file.test.ts +0 -538
  195. package/src/routes/files.test.ts +0 -304
  196. package/src/routes/search.test.ts +0 -959
  197. package/src/test/__snapshots__/integration.test.ts.snap +0 -18
  198. package/src/test/helpers/fastify.ts +0 -26
  199. package/src/test/integration.setup.ts +0 -220
  200. package/src/test/integration.test.ts +0 -953
  201. package/src/transformers/default.test.ts +0 -276
  202. package/src/transformers/transformer.test.ts +0 -226
  203. package/src/types/fileHandlers.ts +0 -57
  204. package/src/utils/errors.test.ts +0 -90
  205. package/src/utils/queryBuilder.ts +0 -157
@@ -0,0 +1,100 @@
1
+ import { DATE_FORMS, storeScalar, withId, } from './fields.js';
2
+ const COMBINATORS = ['AND', 'OR', 'NOT'];
3
+ const EQUALITY = ['equals', 'not', 'in', 'notIn'];
4
+ const RANGE = ['lt', 'lte', 'gt', 'gte'];
5
+ const isPlainObject = (value) => {
6
+ if (typeof value !== 'object' || value === null) {
7
+ return false;
8
+ }
9
+ const prototype = Object.getPrototypeOf(value);
10
+ return prototype === Object.prototype || prototype === null;
11
+ };
12
+ export const checkSearchVisibility = (fields, where) => {
13
+ const declarations = withId(fields);
14
+ const fail = (key, problem) => {
15
+ throw new Error(`Search visibility filter: "${key}" ${problem}`);
16
+ };
17
+ const scalar = (field, type, value) => {
18
+ if (type === 'date' && value instanceof Date && !Number.isNaN(value.getTime())) {
19
+ return value;
20
+ }
21
+ const stored = storeScalar(type, value);
22
+ if ('problem' in stored) {
23
+ const problem = type === 'date' ? `must be a Date or ${DATE_FORMS}` : stored.problem;
24
+ return fail(field, `${problem}, not ${JSON.stringify(value)}`);
25
+ }
26
+ return stored.value;
27
+ };
28
+ const equals = (field, type, value) => value === null
29
+ ? { type: 'not', clause: { type: 'present', field } }
30
+ : { type: 'in', field, values: [scalar(field, type, value)] };
31
+ const list = (field, type, operator, value) => {
32
+ if (!Array.isArray(value)) {
33
+ return fail(field, `takes an array for ${operator}`);
34
+ }
35
+ return { type: 'in', field, values: value.map((item) => scalar(field, type, item)) };
36
+ };
37
+ const condition = (field, declaration, value) => {
38
+ const { type } = declaration;
39
+ if (type === 'geo') {
40
+ return fail(field, "is a geo field, which a search visibility filter can't use");
41
+ }
42
+ if (!isPlainObject(value)) {
43
+ return equals(field, type, value);
44
+ }
45
+ const ordered = type === 'date' || type === 'number';
46
+ const clauses = [];
47
+ const bounds = {};
48
+ for (const [operator, operand] of Object.entries(value)) {
49
+ if (operand === undefined) {
50
+ continue;
51
+ }
52
+ if (ordered && RANGE.includes(operator)) {
53
+ bounds[operator] = scalar(field, type, operand);
54
+ continue;
55
+ }
56
+ if (!EQUALITY.includes(operator)) {
57
+ return fail(field, `is a ${type} field, which can't take ${operator}`);
58
+ }
59
+ const positive = operator === 'equals' || operator === 'not'
60
+ ? equals(field, type, operand)
61
+ : list(field, type, operator, operand);
62
+ clauses.push(operator === 'not' || operator === 'notIn' ? { type: 'not', clause: positive } : positive);
63
+ }
64
+ if (Object.keys(bounds).length > 0) {
65
+ clauses.push({ type: 'range', field, bounds });
66
+ }
67
+ return clauses.length === 1 ? clauses[0] : { type: 'and', clauses };
68
+ };
69
+ const check = (node, path) => {
70
+ if (!isPlainObject(node)) {
71
+ return fail(path, 'must be an object of field conditions');
72
+ }
73
+ const clauses = [];
74
+ for (const [key, value] of Object.entries(node)) {
75
+ if (value === undefined) {
76
+ continue;
77
+ }
78
+ if (COMBINATORS.includes(key)) {
79
+ if (!Array.isArray(value)) {
80
+ return fail(key, 'takes an array of filters');
81
+ }
82
+ const nested = value.map((item, index) => check(item, `${key}[${index}]`));
83
+ clauses.push(key === 'AND'
84
+ ? { type: 'and', clauses: nested }
85
+ : key === 'OR'
86
+ ? { type: 'or', clauses: nested }
87
+ : { type: 'not', clause: { type: 'or', clauses: nested } });
88
+ continue;
89
+ }
90
+ const declaration = Object.hasOwn(declarations, key) ? declarations[key] : undefined;
91
+ if (!declaration) {
92
+ return fail(key, "isn't a declared field");
93
+ }
94
+ clauses.push(condition(key, declaration, value));
95
+ }
96
+ return clauses.length === 1 ? clauses[0] : { type: 'and', clauses };
97
+ };
98
+ return check(where, 'filter');
99
+ };
100
+ //# sourceMappingURL=visibility.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"visibility.js","sourceRoot":"","sources":["../../src/search/visibility.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAKV,WAAW,EACX,MAAM,GACP,MAAM,aAAa,CAAC;AA4DrB,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAU,CAAC;AAClD,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAClD,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAU,CAAC;AAElD,MAAM,aAAa,GAAG,CAAC,KAAc,EAAoC,EAAE;IACzE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAE/C,OAAO,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC;AAC9D,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAyB,EAAE,KAAc,EAAuB,EAAE;IACtG,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,OAAe,EAAS,EAAE;QACnD,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,KAAK,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,IAAe,EAAE,KAAc,EAAU,EAAE;QACxE,IAAI,IAAI,KAAK,MAAM,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YAC/E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACxC,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,qBAAqB,UAAU,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;YAErF,OAAO,IAAI,CAAC,KAAK,EAAE,GAAG,OAAO,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,MAAM,CAAC,KAAe,CAAC;IAChC,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,IAAe,EAAE,KAAc,EAAuB,EAAE,CACrF,KAAK,KAAK,IAAI;QACZ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;QACrD,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;IAElE,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,IAAe,EAAE,QAAgB,EAAE,KAAc,EAAuB,EAAE;QACrG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,KAAK,EAAE,sBAAsB,QAAQ,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;IACvF,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,WAA6B,EAAE,KAAc,EAAuB,EAAE;QACtG,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;QAC7B,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,KAAK,EAAE,4DAA4D,CAAC,CAAC;QACnF,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,QAAQ,CAAC;QACrD,MAAM,OAAO,GAA0B,EAAE,CAAC;QAC1C,MAAM,MAAM,GAA8D,EAAE,CAAC;QAC7E,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,SAAS;YACX,CAAC;YACD,IAAI,OAAO,IAAK,KAA2B,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/D,MAAM,CAAC,QAAkC,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAkB,CAAC;gBAC3F,SAAS;YACX,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjC,OAAO,IAAI,CAAC,KAAK,EAAE,QAAQ,IAAI,4BAA4B,QAAQ,EAAE,CAAC,CAAC;YACzE,CAAC;YAED,MAAM,QAAQ,GACZ,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,KAAK;gBACzC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC;gBAC9B,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC3C,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,KAAK,IAAI,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC1G,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACtE,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,IAAY,EAAuB,EAAE;QACjE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,IAAI,EAAE,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QAED,MAAM,OAAO,GAA0B,EAAE,CAAC;QAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAS;YACX,CAAC;YAED,IAAK,WAAiC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,IAAI,CAAC,GAAG,EAAE,2BAA2B,CAAC,CAAC;gBAChD,CAAC;gBACD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;gBAC3E,OAAO,CAAC,IAAI,CACV,GAAG,KAAK,KAAK;oBACX,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE;oBAClC,CAAC,CAAC,GAAG,KAAK,IAAI;wBACZ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE;wBACjC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAC/D,CAAC;gBACF,SAAS;YACX,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACrF,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,OAAO,IAAI,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACtE,CAAC,CAAC;IAEF,OAAO,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAChC,CAAC,CAAC"}
@@ -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 { setFileHeaders } 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
+ setFileHeaders(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
+ setFileHeaders(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,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAiBrD,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,cAAc,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAE/F,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,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAClC,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,20 @@
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
+ export declare const inside: (root: string, path: string) => boolean;
8
+ type DefaultKeys<Key> = {
9
+ metadata: (entity: Entity) => Key | null;
10
+ content: (file: File) => Key | null;
11
+ };
12
+ export declare const locator: <Key>(locate: StorageLocate<Key>, defaults: DefaultKeys<Key>, check: (key: Key, id: string) => unknown) => {
13
+ metadata: (entity: Entity) => Promise<Key | null>;
14
+ content: (file: File, entity: Entity) => Promise<Key | null>;
15
+ };
16
+ export declare const keyLocator: <Meta>(locate: StorageLocate, key: Extract<keyof Meta, string>) => {
17
+ metadata: (entity: Entity) => Promise<string | null>;
18
+ content: (file: File, entity: Entity) => Promise<string | null>;
19
+ };
20
+ export {};
@@ -0,0 +1,40 @@
1
+ import { isAbsolute, relative, sep } 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 inside = (root, path) => {
21
+ const rel = relative(root, path);
22
+ return rel !== '' && rel !== '..' && !rel.startsWith(`..${sep}`) && !isAbsolute(rel);
23
+ };
24
+ export const locator = (locate, defaults, check) => {
25
+ const checked = (key, id) => {
26
+ if (key !== null) {
27
+ check(key, id);
28
+ }
29
+ return key;
30
+ };
31
+ return {
32
+ metadata: async (entity) => checked(await (locate.metadata ?? defaults.metadata)(entity), entity.id),
33
+ content: async (file, entity) => checked(await (locate.content ?? defaults.content)(file, entity), file.id),
34
+ };
35
+ };
36
+ export const keyLocator = (locate, key) => locator(locate, {
37
+ metadata: (entity) => metaString(entity.meta, entity.id, key),
38
+ content: (file) => metaString(file.meta, file.id, key),
39
+ }, safeKey);
40
+ //# 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,QAAQ,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAItD,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;AAGF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE;IACnD,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAEjC,OAAO,GAAG,KAAK,EAAE,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AACvF,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,7 @@
1
+ import type { MaybePromise, OcflLocation, StorageBackend, StorageLocate } from '../backend.js';
2
+ export type OcflStorageOptions = {
3
+ root: string;
4
+ objectRoot?: (id: string) => MaybePromise<string>;
5
+ locate?: StorageLocate<OcflLocation>;
6
+ };
7
+ export declare const OcflStorage: ({ root, objectRoot: custom, locate, }: OcflStorageOptions) => Promise<StorageBackend>;
@@ -0,0 +1,79 @@
1
+ import { readFile, stat } from 'node:fs/promises';
2
+ import { join, resolve } from 'node:path';
3
+ import { inside, locator, metaString, safeKey } from '../location.js';
4
+ import { nullIfMissing, pathDelivery, withContentType } from '../results.js';
5
+ import { headFile, layoutObjectRoot } from './ocflFs.js';
6
+ const LAYOUTS = new Set([
7
+ '0002-flat-direct-storage-layout',
8
+ '0003-hash-and-id-n-tuple-storage-layout',
9
+ '0004-hashed-n-tuple-storage-layout',
10
+ '000N-path-direct-storage-layout',
11
+ ]);
12
+ const METADATA_PATH = 'ro-crate-metadata.json';
13
+ const MARKERS = ['0=ocfl_1.1', '0=ocfl_1.0'];
14
+ const readJson = async (path) => {
15
+ const text = await nullIfMissing(readFile(path, 'utf8'));
16
+ return text === null ? null : JSON.parse(text);
17
+ };
18
+ const readLayoutObjectRoot = async (base) => {
19
+ const layout = await readJson(join(base, 'ocfl_layout.json'));
20
+ const extension = layout?.extension;
21
+ if (typeof extension !== 'string') {
22
+ throw new Error(`${base} has no ocfl_layout.json naming its storage layout; pass objectRoot`);
23
+ }
24
+ if (!LAYOUTS.has(extension)) {
25
+ throw new Error(`${base} uses the storage layout ${extension}, which OcflStorage doesn't implement; pass objectRoot`);
26
+ }
27
+ const config = await readJson(join(base, 'extensions', extension, 'config.json'));
28
+ return layoutObjectRoot(base, extension, config);
29
+ };
30
+ const metaKey = (row, key) => metaString(row.meta, row.id, key);
31
+ const defaultLocations = {
32
+ metadata: (entity) => {
33
+ const object = metaKey(entity, 'ocflObject');
34
+ const path = metaKey(entity, 'ocflPath') ?? METADATA_PATH;
35
+ return object === null ? null : { object, path };
36
+ },
37
+ content: (file) => {
38
+ const object = metaKey(file, 'ocflObject');
39
+ const path = metaKey(file, 'ocflPath');
40
+ return object === null || path === null ? null : { object, path };
41
+ },
42
+ };
43
+ const safeLocation = ({ path }, id) => safeKey(path, id);
44
+ export const OcflStorage = async ({ root, objectRoot: custom, locate = {}, }) => {
45
+ const base = resolve(root);
46
+ const markers = await Promise.all(MARKERS.map((name) => nullIfMissing(stat(join(base, name)))));
47
+ if (!markers.some(Boolean)) {
48
+ throw new Error(`${base} is not an OCFL storage root`);
49
+ }
50
+ const objectRoot = custom ?? (await readLayoutObjectRoot(base));
51
+ const locations = locator(locate, defaultLocations, safeLocation);
52
+ const deliver = async (location, id) => {
53
+ if (location === null) {
54
+ return null;
55
+ }
56
+ const objectPath = resolve(base, await objectRoot(location.object));
57
+ if (!inside(base, objectPath)) {
58
+ throw new Error(`${id}: the root of OCFL object ${location.object} is outside the storage root`);
59
+ }
60
+ const file = await headFile(objectPath, location.path);
61
+ if (file === null) {
62
+ return null;
63
+ }
64
+ const path = resolve(objectPath, file.contentPath);
65
+ if (!inside(objectPath, path)) {
66
+ throw new Error(`${id}: OCFL object ${location.object} has a manifest path outside its root`);
67
+ }
68
+ const stats = await stat(path);
69
+ if (!stats.isFile()) {
70
+ throw new Error(`${id}: OCFL object ${location.object} has a manifest path that is not a file`);
71
+ }
72
+ return pathDelivery(path, stats, `"${file.digest}"`);
73
+ };
74
+ return {
75
+ metadata: async (entity) => deliver(await locations.metadata(entity), entity.id),
76
+ content: async (file, entity) => withContentType(await deliver(await locations.content(file, entity), file.id), file.mediaType),
77
+ };
78
+ };
79
+ //# 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,QAAQ,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAU1C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAWzD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC;IACtB,iCAAiC;IACjC,yCAAyC;IACzC,oCAAoC;IACpC,iCAAiC;CAClC,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,wBAAwB,CAAC;AAE/C,MAAM,OAAO,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;AAE7C,MAAM,QAAQ,GAAG,KAAK,EAAE,IAAY,EAAoB,EAAE;IACxD,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAEzD,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,KAAK,EAAE,IAAY,EAAE,EAAE;IAClD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAI,MAAyC,EAAE,SAAS,CAAC;IACxE,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,qEAAqE,CAAC,CAAC;IAChG,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,4BAA4B,SAAS,wDAAwD,CACrG,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;IAElF,OAAO,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,MAAuB,CAAC,CAAC;AACpE,CAAC,CAAC;AAEF,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,EAChC,IAAI,EACJ,UAAU,EAAE,MAAM,EAClB,MAAM,GAAG,EAAE,GACQ,EAA2B,EAAE;IAChD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,8BAA8B,CAAC,CAAC;IACzD,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC;IAElE,MAAM,OAAO,GAAG,KAAK,EAAE,QAA6B,EAAE,EAAU,EAAgC,EAAE;QAChG,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,6BAA6B,QAAQ,CAAC,MAAM,8BAA8B,CAAC,CAAC;QACnG,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,iBAAiB,QAAQ,CAAC,MAAM,uCAAuC,CAAC,CAAC;QAChG,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,iBAAiB,QAAQ,CAAC,MAAM,yCAAyC,CAAC,CAAC;QAClG,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IACvD,CAAC,CAAC;IAEF,OAAO;QACL,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC;QAChF,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAC9B,eAAe,CAAC,MAAM,OAAO,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC;KACjG,CAAC;AACJ,CAAC,CAAC"}
@@ -0,0 +1,7 @@
1
+ type InventoryFile = {
2
+ digest: string;
3
+ contentPath: string;
4
+ };
5
+ export declare const layoutObjectRoot: (root: string, extension: string, config: object | null) => Promise<(id: string) => string>;
6
+ export declare const headFile: (root: string, logicalPath: string) => Promise<InventoryFile | null>;
7
+ export {};
@@ -0,0 +1,33 @@
1
+ import { dirname, join } from 'node:path';
2
+ import ocfl from '@ocfl/ocfl-fs';
3
+ const { loadStorage, object, storageLayout } = ocfl;
4
+ const HASH_AND_ID = '0003-hash-and-id-n-tuple-storage-layout';
5
+ const encapsulate = (id, digest) => {
6
+ const encoded = Array.from(new TextEncoder().encode(id), (byte) => {
7
+ const char = String.fromCharCode(byte);
8
+ return /[A-Za-z0-9_-]/.test(char) ? char : `%${byte.toString(16).padStart(2, '0')}`;
9
+ }).join('');
10
+ return encoded.length > 100 ? `${encoded.slice(0, 100)}-${digest}` : encoded;
11
+ };
12
+ export const layoutObjectRoot = async (root, extension, config) => {
13
+ const layout = storageLayout(config ? { ...config, extensionName: extension } : extension);
14
+ const digestAlgorithm = layout.get('digestAlgorithm');
15
+ if (digestAlgorithm) {
16
+ await loadStorage({ root });
17
+ }
18
+ if (extension !== HASH_AND_ID) {
19
+ return (id) => layout.map(id);
20
+ }
21
+ const digest = storageLayout({
22
+ extensionName: '0004-hashed-n-tuple-storage-layout',
23
+ digestAlgorithm,
24
+ tupleSize: 0,
25
+ numberOfTuples: 0,
26
+ });
27
+ return (id) => join(dirname(layout.map(id)), encapsulate(id, digest.map(id)));
28
+ };
29
+ export const headFile = async (root, logicalPath) => {
30
+ const inventory = await object({ root }).getInventory();
31
+ return inventory?.getFile(logicalPath) ?? null;
32
+ };
33
+ //# sourceMappingURL=ocflFs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ocflFs.js","sourceRoot":"","sources":["../../../src/storage/ocfl/ocflFs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,IAAI,MAAM,eAAe,CAAC;AAYjC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,IAAc,CAAC;AAE9D,MAAM,WAAW,GAAG,yCAAyC,CAAC;AAG9D,MAAM,WAAW,GAAG,CAAC,EAAU,EAAE,MAAc,EAAE,EAAE;IACjD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE;QAChE,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEvC,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;IACtF,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEZ,OAAO,OAAO,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AAC/E,CAAC,CAAC;AAOF,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,IAAY,EAAE,SAAiB,EAAE,MAAqB,EAAE,EAAE;IAC/F,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3F,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACtD,IAAI,eAAe,EAAE,CAAC;QAEpB,MAAM,WAAW,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IACD,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;QAC9B,OAAO,CAAC,EAAU,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC;IAGD,MAAM,MAAM,GAAG,aAAa,CAAC;QAC3B,aAAa,EAAE,oCAAoC;QACnD,eAAe;QACf,SAAS,EAAE,CAAC;QACZ,cAAc,EAAE,CAAC;KAClB,CAAC,CAAC;IAEH,OAAO,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACxF,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAAE,IAAY,EAAE,WAAmB,EAAE,EAAE;IAClE,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC;IAExD,OAAO,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC;AACjD,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,5 +1,6 @@
1
- import type { QueryContainer } from '@opensearch-project/opensearch/api/_types/_common.query_dsl.js';
2
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';
3
4
  import type { RequestContext } from './context.js';
4
5
  export type EntityVisibilityFilter = (context: RequestContext) => Promise<Prisma.EntityWhereInput> | Prisma.EntityWhereInput;
5
- export type SearchVisibilityFilter = (context: RequestContext) => Promise<QueryContainer> | QueryContainer;
6
+ export type SearchVisibilityFilter<Fields extends FieldDeclarations = FieldDeclarations> = (context: RequestContext) => Promise<SearchVisibilityWhere<Fields>> | SearchVisibilityWhere<Fields>;