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
@@ -1,157 +0,0 @@
1
- import type { SortOrder } from '@opensearch-project/opensearch/api/_types/_common.js';
2
- import type { BoolQuery } from '@opensearch-project/opensearch/api/_types/_common.query_dsl.js';
3
- import type { Search_RequestBody } from '@opensearch-project/opensearch/api/index.js';
4
-
5
- type Aggregations = Required<Search_RequestBody>['aggs'];
6
-
7
- type BoundingBox = {
8
- topRight: {
9
- lat: number;
10
- lng: number;
11
- };
12
- bottomLeft: {
13
- lat: number;
14
- lng: number;
15
- };
16
- };
17
-
18
- export type QueryBuilderOptions = {
19
- aggregations?: Aggregations;
20
- };
21
-
22
- export type FilterCapability = {
23
- type: 'string' | 'date' | 'number' | 'boolean';
24
- label?: string;
25
- };
26
-
27
- export type FacetCapability = {
28
- label?: string;
29
- };
30
-
31
- export type SearchCapability = {
32
- filters: Record<string, FilterCapability>;
33
- facets: Record<string, FacetCapability>;
34
- };
35
-
36
- export class OpensearchQueryBuilder {
37
- aggregations: Aggregations;
38
-
39
- constructor(opts?: QueryBuilderOptions) {
40
- this.aggregations =
41
- opts?.aggregations ||
42
- Object.fromEntries(
43
- ['inLanguage', 'mediaType', 'communicationMode', 'entityType'].map((name) => [
44
- name,
45
- { terms: { field: `${name}.keyword`, size: 20 } },
46
- ]),
47
- );
48
- }
49
-
50
- buildQuery(searchType: string, query: string, filters?: Record<string, string[]>, boundingBox?: BoundingBox) {
51
- const must: BoolQuery['must'] = [];
52
- const filter: BoolQuery['filter'] = [];
53
-
54
- if (searchType === 'basic') {
55
- must.push({
56
- multi_match: {
57
- query,
58
- fields: ['name^2', 'description'],
59
- type: 'best_fields',
60
- fuzziness: 'AUTO',
61
- zero_terms_query: 'all',
62
- },
63
- });
64
- } else {
65
- must.push({
66
- query_string: {
67
- query,
68
- fields: ['name^2', 'description'],
69
- default_operator: 'AND',
70
- },
71
- });
72
- }
73
-
74
- if (filters) {
75
- Object.entries(filters).forEach(([field, values]) => {
76
- filter.push({
77
- terms: {
78
- [field]: values,
79
- },
80
- });
81
- });
82
- }
83
-
84
- if (boundingBox) {
85
- filter.push({
86
- geo_bounding_box: {
87
- location: {
88
- top_left: {
89
- lat: boundingBox.topRight.lat,
90
- lon: boundingBox.bottomLeft.lng,
91
- },
92
- bottom_right: {
93
- lat: boundingBox.bottomLeft.lat,
94
- lon: boundingBox.topRight.lng,
95
- },
96
- },
97
- },
98
- });
99
- }
100
-
101
- return {
102
- bool: {
103
- must,
104
- filter,
105
- },
106
- };
107
- }
108
-
109
- buildAggregations(geohashPrecision?: number, boundingBox?: BoundingBox) {
110
- const aggs = { ...this.aggregations };
111
-
112
- // Add geohash aggregation if precision is specified
113
- if (geohashPrecision && boundingBox) {
114
- aggs.geohash_grid = {
115
- geohash_grid: {
116
- field: 'location',
117
- precision: geohashPrecision,
118
- bounds: {
119
- top_left: {
120
- lat: boundingBox.topRight.lat,
121
- lon: boundingBox.bottomLeft.lng,
122
- },
123
- bottom_right: {
124
- lat: boundingBox.bottomLeft.lat,
125
- lon: boundingBox.topRight.lng,
126
- },
127
- },
128
- },
129
- };
130
- }
131
-
132
- return aggs;
133
- }
134
-
135
- searchCapabilities(): SearchCapability {
136
- const fields = Object.entries(this.aggregations)
137
- .filter(([, aggregation]) => 'terms' in aggregation)
138
- .map(([name]) => name);
139
-
140
- return {
141
- filters: Object.fromEntries(fields.map((name) => [name, { type: 'string' }])),
142
- facets: Object.fromEntries(fields.map((name) => [name, {}])),
143
- };
144
- }
145
-
146
- buildSort(sort: string, order: SortOrder) {
147
- if (sort === 'relevance') {
148
- return;
149
- }
150
-
151
- if (sort === 'name') {
152
- return [{ 'name.keyword': order }];
153
- }
154
-
155
- return [{ [sort]: order }];
156
- }
157
- }