arocapi 5.0.0-beta.1 → 5.0.0-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (234) hide show
  1. package/LICENSE.md +1 -1
  2. package/README.md +37 -802
  3. package/dist/app.d.ts +38 -20
  4. package/dist/app.js +62 -40
  5. package/dist/app.js.map +1 -1
  6. package/dist/routes/capabilities.d.ts +7 -0
  7. package/dist/routes/capabilities.js +13 -0
  8. package/dist/routes/capabilities.js.map +1 -0
  9. package/dist/routes/entities.d.ts +5 -2
  10. package/dist/routes/entities.js +37 -57
  11. package/dist/routes/entities.js.map +1 -1
  12. package/dist/routes/entity.d.ts +7 -2
  13. package/dist/routes/entity.js +13 -29
  14. package/dist/routes/entity.js.map +1 -1
  15. package/dist/routes/file.d.ts +8 -2
  16. package/dist/routes/file.js +37 -72
  17. package/dist/routes/file.js.map +1 -1
  18. package/dist/routes/files.d.ts +5 -2
  19. package/dist/routes/files.js +24 -39
  20. package/dist/routes/files.js.map +1 -1
  21. package/dist/routes/metadata.d.ts +11 -5
  22. package/dist/routes/metadata.js +24 -68
  23. package/dist/routes/metadata.js.map +1 -1
  24. package/dist/routes/search.d.ts +8 -7
  25. package/dist/routes/search.js +90 -119
  26. package/dist/routes/search.js.map +1 -1
  27. package/dist/search/advanced.d.ts +8 -0
  28. package/dist/search/advanced.js +198 -0
  29. package/dist/search/advanced.js.map +1 -0
  30. package/dist/search/backend.d.ts +95 -0
  31. package/dist/search/backend.js +5 -0
  32. package/dist/search/backend.js.map +1 -0
  33. package/dist/search/fields.d.ts +63 -0
  34. package/dist/search/fields.js +203 -0
  35. package/dist/search/fields.js.map +1 -0
  36. package/dist/search/opensearch/advanced.d.ts +4 -0
  37. package/dist/search/opensearch/advanced.js +28 -0
  38. package/dist/search/opensearch/advanced.js.map +1 -0
  39. package/dist/search/opensearch/opensearch.d.ts +16 -0
  40. package/dist/search/opensearch/opensearch.js +187 -0
  41. package/dist/search/opensearch/opensearch.js.map +1 -0
  42. package/dist/search/opensearch/visibility.d.ts +3 -0
  43. package/dist/search/opensearch/visibility.js +27 -0
  44. package/dist/search/opensearch/visibility.js.map +1 -0
  45. package/dist/search/postgres/advanced.d.ts +7 -0
  46. package/dist/search/postgres/advanced.js +54 -0
  47. package/dist/search/postgres/advanced.js.map +1 -0
  48. package/dist/search/postgres/facets.d.ts +2 -0
  49. package/dist/search/postgres/facets.js +27 -0
  50. package/dist/search/postgres/facets.js.map +1 -0
  51. package/dist/search/postgres/geo.d.ts +6 -0
  52. package/dist/search/postgres/geo.js +42 -0
  53. package/dist/search/postgres/geo.js.map +1 -0
  54. package/dist/search/postgres/postgres.d.ts +19 -0
  55. package/dist/search/postgres/postgres.js +157 -0
  56. package/dist/search/postgres/postgres.js.map +1 -0
  57. package/dist/search/postgres/values.d.ts +8 -0
  58. package/dist/search/postgres/values.js +20 -0
  59. package/dist/search/postgres/values.js.map +1 -0
  60. package/dist/search/postgres/visibility.d.ts +4 -0
  61. package/dist/search/postgres/visibility.js +38 -0
  62. package/dist/search/postgres/visibility.js.map +1 -0
  63. package/dist/search/requestFilters.d.ts +39 -0
  64. package/dist/search/requestFilters.js +125 -0
  65. package/dist/search/requestFilters.js.map +1 -0
  66. package/dist/search/visibility.d.ts +51 -0
  67. package/dist/search/visibility.js +100 -0
  68. package/dist/search/visibility.js.map +1 -0
  69. package/dist/storage/backend.d.ts +58 -0
  70. package/dist/storage/backend.js +2 -0
  71. package/dist/storage/backend.js.map +1 -0
  72. package/dist/storage/deliver.d.ts +12 -0
  73. package/dist/storage/deliver.js +34 -0
  74. package/dist/storage/deliver.js.map +1 -0
  75. package/dist/storage/directory/directory.d.ts +6 -0
  76. package/dist/storage/directory/directory.js +24 -0
  77. package/dist/storage/directory/directory.js.map +1 -0
  78. package/dist/storage/entity-meta/entity-meta.d.ts +5 -0
  79. package/dist/storage/entity-meta/entity-meta.js +14 -0
  80. package/dist/storage/entity-meta/entity-meta.js.map +1 -0
  81. package/dist/storage/location.d.ts +19 -0
  82. package/dist/storage/location.js +36 -0
  83. package/dist/storage/location.js.map +1 -0
  84. package/dist/storage/ocfl/ocfl.d.ts +6 -0
  85. package/dist/storage/ocfl/ocfl.js +45 -0
  86. package/dist/storage/ocfl/ocfl.js.map +1 -0
  87. package/dist/storage/results.d.ts +7 -0
  88. package/dist/storage/results.js +22 -0
  89. package/dist/storage/results.js.map +1 -0
  90. package/dist/storage/s3/s3.d.ts +10 -0
  91. package/dist/storage/s3/s3.js +47 -0
  92. package/dist/storage/s3/s3.js.map +1 -0
  93. package/dist/transformers/default.d.ts +11 -22
  94. package/dist/transformers/default.js +41 -15
  95. package/dist/transformers/default.js.map +1 -1
  96. package/dist/types/access.d.ts +9 -0
  97. package/dist/types/access.js +2 -0
  98. package/dist/types/access.js.map +1 -0
  99. package/dist/types/context.d.ts +6 -0
  100. package/dist/types/context.js +2 -0
  101. package/dist/types/context.js.map +1 -0
  102. package/dist/types/transformers.d.ts +4 -10
  103. package/dist/types/visibility.d.ts +6 -0
  104. package/dist/types/visibility.js +2 -0
  105. package/dist/types/visibility.js.map +1 -0
  106. package/dist/utils/access.d.ts +17 -0
  107. package/dist/utils/access.js +41 -0
  108. package/dist/utils/access.js.map +1 -0
  109. package/dist/utils/errors.d.ts +19 -10
  110. package/dist/utils/errors.js +44 -8
  111. package/dist/utils/errors.js.map +1 -1
  112. package/dist/utils/headers.d.ts +1 -1
  113. package/dist/utils/headers.js +10 -1
  114. package/dist/utils/headers.js.map +1 -1
  115. package/dist/utils/validation.d.ts +2 -0
  116. package/dist/utils/validation.js +8 -0
  117. package/dist/utils/validation.js.map +1 -0
  118. package/dist/utils/visibility.d.ts +18 -0
  119. package/dist/utils/visibility.js +16 -0
  120. package/dist/utils/visibility.js.map +1 -0
  121. package/package.json +82 -40
  122. package/prisma/models/entity.prisma +9 -8
  123. package/prisma/models/entitySearch.prisma +21 -0
  124. package/prisma/models/file.prisma +3 -3
  125. package/src/app.ts +168 -95
  126. package/src/routes/capabilities.ts +22 -0
  127. package/src/routes/entities.ts +48 -67
  128. package/src/routes/entity.ts +21 -35
  129. package/src/routes/file.ts +53 -103
  130. package/src/routes/files.ts +31 -47
  131. package/src/routes/metadata.ts +42 -98
  132. package/src/routes/search.ts +131 -151
  133. package/src/search/advanced.ts +258 -0
  134. package/src/search/backend.ts +91 -0
  135. package/src/search/fields.ts +320 -0
  136. package/src/search/opensearch/advanced.ts +36 -0
  137. package/src/search/opensearch/opensearch.ts +290 -0
  138. package/src/search/opensearch/visibility.ts +38 -0
  139. package/src/search/postgres/advanced.ts +76 -0
  140. package/src/search/postgres/facets.ts +34 -0
  141. package/src/search/postgres/geo.ts +58 -0
  142. package/src/search/postgres/postgres.ts +232 -0
  143. package/src/search/postgres/values.ts +33 -0
  144. package/src/search/postgres/visibility.ts +54 -0
  145. package/src/search/requestFilters.ts +178 -0
  146. package/src/search/visibility.ts +193 -0
  147. package/src/storage/backend.ts +75 -0
  148. package/src/storage/deliver.ts +65 -0
  149. package/src/storage/directory/directory.ts +39 -0
  150. package/src/storage/entity-meta/entity-meta.ts +25 -0
  151. package/src/storage/location.ts +78 -0
  152. package/src/storage/ocfl/ocfl.ts +71 -0
  153. package/src/storage/results.ts +32 -0
  154. package/src/storage/s3/s3.ts +79 -0
  155. package/src/transformers/default.ts +115 -85
  156. package/src/types/access.ts +25 -0
  157. package/src/types/context.ts +15 -0
  158. package/src/types/transformers.ts +8 -34
  159. package/src/types/visibility.ts +21 -0
  160. package/src/utils/access.ts +80 -0
  161. package/src/utils/errors.ts +68 -11
  162. package/src/utils/headers.ts +22 -2
  163. package/src/utils/validation.ts +11 -0
  164. package/src/utils/visibility.ts +56 -0
  165. package/dist/app.test.d.ts +0 -1
  166. package/dist/app.test.js +0 -82
  167. package/dist/app.test.js.map +0 -1
  168. package/dist/index.dev.d.ts +0 -1
  169. package/dist/index.dev.js +0 -156
  170. package/dist/index.dev.js.map +0 -1
  171. package/dist/routes/crate.test.d.ts +0 -1
  172. package/dist/routes/crate.test.js +0 -342
  173. package/dist/routes/crate.test.js.map +0 -1
  174. package/dist/routes/entities.test.d.ts +0 -1
  175. package/dist/routes/entities.test.js +0 -273
  176. package/dist/routes/entities.test.js.map +0 -1
  177. package/dist/routes/entity.test.d.ts +0 -1
  178. package/dist/routes/entity.test.js +0 -130
  179. package/dist/routes/entity.test.js.map +0 -1
  180. package/dist/routes/file.test.d.ts +0 -1
  181. package/dist/routes/file.test.js +0 -315
  182. package/dist/routes/file.test.js.map +0 -1
  183. package/dist/routes/files.test.d.ts +0 -1
  184. package/dist/routes/files.test.js +0 -222
  185. package/dist/routes/files.test.js.map +0 -1
  186. package/dist/routes/search.test.d.ts +0 -1
  187. package/dist/routes/search.test.js +0 -780
  188. package/dist/routes/search.test.js.map +0 -1
  189. package/dist/test/helpers/fastify.d.ts +0 -9
  190. package/dist/test/helpers/fastify.js +0 -18
  191. package/dist/test/helpers/fastify.js.map +0 -1
  192. package/dist/test/integration.setup.d.ts +0 -29
  193. package/dist/test/integration.setup.js +0 -187
  194. package/dist/test/integration.setup.js.map +0 -1
  195. package/dist/test/integration.test.d.ts +0 -1
  196. package/dist/test/integration.test.js +0 -396
  197. package/dist/test/integration.test.js.map +0 -1
  198. package/dist/transformers/default.test.d.ts +0 -1
  199. package/dist/transformers/default.test.js +0 -163
  200. package/dist/transformers/default.test.js.map +0 -1
  201. package/dist/transformers/transformer.test.d.ts +0 -1
  202. package/dist/transformers/transformer.test.js +0 -187
  203. package/dist/transformers/transformer.test.js.map +0 -1
  204. package/dist/types/fileHandlers.d.ts +0 -41
  205. package/dist/types/fileHandlers.js +0 -2
  206. package/dist/types/fileHandlers.js.map +0 -1
  207. package/dist/utils/errors.test.d.ts +0 -1
  208. package/dist/utils/errors.test.js +0 -66
  209. package/dist/utils/errors.test.js.map +0 -1
  210. package/dist/utils/queryBuilder.d.ts +0 -35
  211. package/dist/utils/queryBuilder.js +0 -98
  212. package/dist/utils/queryBuilder.js.map +0 -1
  213. package/prisma.config.ts +0 -9
  214. package/src/app.test.ts +0 -112
  215. package/src/index.dev.ts +0 -200
  216. package/src/reset.d.ts +0 -1
  217. package/src/routes/__snapshots__/entities.test.ts.snap +0 -96
  218. package/src/routes/__snapshots__/entity.test.ts.snap +0 -74
  219. package/src/routes/__snapshots__/search.test.ts.snap +0 -165
  220. package/src/routes/crate.test.ts +0 -423
  221. package/src/routes/entities.test.ts +0 -320
  222. package/src/routes/entity.test.ts +0 -160
  223. package/src/routes/file.test.ts +0 -395
  224. package/src/routes/files.test.ts +0 -278
  225. package/src/routes/search.test.ts +0 -903
  226. package/src/test/__snapshots__/integration.test.ts.snap +0 -18
  227. package/src/test/helpers/fastify.ts +0 -27
  228. package/src/test/integration.setup.ts +0 -209
  229. package/src/test/integration.test.ts +0 -482
  230. package/src/transformers/default.test.ts +0 -184
  231. package/src/transformers/transformer.test.ts +0 -252
  232. package/src/types/fileHandlers.ts +0 -65
  233. package/src/utils/errors.test.ts +0 -75
  234. package/src/utils/queryBuilder.ts +0 -132
@@ -1,18 +0,0 @@
1
- // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
2
-
3
- exports[`Integration Tests > GET /entity/:id > should return entity from database 1`] = `
4
- {
5
- "access": {
6
- "content": true,
7
- "metadata": true,
8
- },
9
- "contentLicenseId": "https://creativecommons.org/licenses/by/4.0/",
10
- "description": "First test entity",
11
- "entityType": "http://pcdm.org/models#Collection",
12
- "id": "http://example.com/entity/1",
13
- "memberOf": null,
14
- "metadataLicenseId": "https://creativecommons.org/licenses/by/4.0/",
15
- "name": "Test Collection",
16
- "rootCollection": null,
17
- }
18
- `;
@@ -1,27 +0,0 @@
1
- import type { Client } from '@opensearch-project/opensearch';
2
- import type { FastifyInstance } from 'fastify';
3
- import Fastify from 'fastify';
4
- import { serializerCompiler, validatorCompiler } from 'fastify-type-provider-zod';
5
- import { mockDeep, mockReset } from 'vitest-mock-extended';
6
-
7
- import type { PrismaClient } from '../../generated/prisma/client.js';
8
-
9
- export let fastify: FastifyInstance;
10
- export const prisma = mockDeep<PrismaClient>();
11
- export const opensearch = mockDeep<Client>();
12
-
13
- export const fastifyBefore = async () => {
14
- mockReset(prisma);
15
- mockReset(opensearch);
16
-
17
- fastify = Fastify({ logger: false });
18
-
19
- fastify.setValidatorCompiler(validatorCompiler);
20
- fastify.setSerializerCompiler(serializerCompiler);
21
-
22
- return fastify;
23
- };
24
-
25
- export const fastifyAfter = async () => {
26
- await fastify.close();
27
- };
@@ -1,209 +0,0 @@
1
- import { Client } from '@opensearch-project/opensearch';
2
- import { PrismaMariaDb } from '@prisma/adapter-mariadb';
3
- import type { FastifyInstance } from 'fastify';
4
- import Fastify from 'fastify';
5
- import app, { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from '../app.js';
6
- import { PrismaClient } from '../generated/prisma/client.js';
7
-
8
- let fastify: FastifyInstance;
9
- let prisma: PrismaClient;
10
- let opensearch: Client;
11
-
12
- export const getTestApp = () => fastify;
13
-
14
- export async function setupIntegrationTests() {
15
- process.env.DATABASE_URL = 'mysql://root:password@localhost:3307/catalog_test';
16
- process.env.OPENSEARCH_URL = 'http://localhost:9201';
17
- process.env.NODE_ENV = 'test';
18
-
19
- const adapter = new PrismaMariaDb({
20
- host: 'localhost',
21
- user: 'root',
22
- password: 'password',
23
- database: 'catalog_test',
24
- port: 3307,
25
- connectionLimit: 5,
26
- // NOTE: This is required when using the default MariaDB server configuration with SSL disabled. In production, you should properly configure SSL and remove this option.
27
- allowPublicKeyRetrieval: true,
28
- });
29
- prisma = new PrismaClient({ adapter });
30
-
31
- opensearch = new Client({
32
- node: process.env.OPENSEARCH_URL,
33
- });
34
-
35
- fastify = Fastify({ logger: false });
36
-
37
- await fastify.register(app, {
38
- prisma,
39
- opensearch,
40
- accessTransformer: AllPublicAccessTransformer,
41
- fileAccessTransformer: AllPublicFileAccessTransformer,
42
- fileHandler: {
43
- get: async () => {
44
- throw new Error('File handler not implemented in integration tests');
45
- },
46
- head: async () => {
47
- throw new Error('File handler not implemented in integration tests');
48
- },
49
- },
50
- roCrateHandler: {
51
- get: async () => {
52
- throw new Error('RO-Crate handler not implemented in integration tests');
53
- },
54
- head: async () => {
55
- throw new Error('RO-Crate head handler not implemented in integration tests');
56
- },
57
- },
58
- });
59
-
60
- await fastify.ready();
61
- }
62
-
63
- export async function teardownIntegrationTests() {
64
- await cleanupTestData();
65
-
66
- await fastify.close();
67
- await prisma.$disconnect();
68
- opensearch.close();
69
- }
70
-
71
- export async function cleanupTestData() {
72
- await prisma.file.deleteMany({});
73
- await prisma.entity.deleteMany({});
74
-
75
- await opensearch.indices.delete({
76
- index: 'entities',
77
- ignore_unavailable: true,
78
- });
79
- }
80
-
81
- export async function seedTestData() {
82
- await cleanupTestData();
83
-
84
- const testEntities = [
85
- {
86
- id: 'http://example.com/entity/1',
87
- name: 'Test Collection',
88
- description: 'First test entity',
89
- entityType: 'http://pcdm.org/models#Collection',
90
- memberOf: null,
91
- rootCollection: null,
92
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
93
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
94
- createdAt: new Date(),
95
- updatedAt: new Date(),
96
- },
97
- {
98
- id: 'http://example.com/entity/2',
99
- name: 'Test Object',
100
- description: 'Second test entity',
101
- entityType: 'http://pcdm.org/models#Object',
102
- memberOf: 'http://example.com/entity/1',
103
- rootCollection: 'http://example.com/entity/1',
104
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
105
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
106
- createdAt: new Date(),
107
- updatedAt: new Date(),
108
- },
109
- {
110
- id: 'http://example.com/entity/3',
111
- name: 'Test Person',
112
- description: 'Third test entity',
113
- entityType: 'http://schema.org/Person',
114
- memberOf: 'http://example.com/entity/1',
115
- rootCollection: 'http://example.com/entity/1',
116
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
117
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
118
- createdAt: new Date(),
119
- updatedAt: new Date(),
120
- },
121
- {
122
- id: 'http://example.com/entity/4',
123
- name: 'test-audio.wav',
124
- description: 'Test audio file',
125
- entityType: 'http://schema.org/MediaObject',
126
- memberOf: 'http://example.com/entity/2',
127
- rootCollection: 'http://example.com/entity/1',
128
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
129
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
130
- createdAt: new Date(),
131
- updatedAt: new Date(),
132
- },
133
- {
134
- id: 'http://example.com/entity/5',
135
- name: 'collection-metadata.csv',
136
- description: 'Collection metadata file',
137
- entityType: 'http://schema.org/MediaObject',
138
- memberOf: 'http://example.com/entity/1',
139
- rootCollection: 'http://example.com/entity/1',
140
- metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
141
- contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
142
- createdAt: new Date(),
143
- updatedAt: new Date(),
144
- },
145
- ];
146
-
147
- await prisma.entity.createMany({
148
- data: testEntities,
149
- });
150
-
151
- const testFiles = [
152
- {
153
- id: 'http://example.com/entity/4',
154
- filename: 'test-audio.wav',
155
- mediaType: 'audio/wav',
156
- size: BigInt(2048),
157
- meta: {},
158
- createdAt: new Date(),
159
- updatedAt: new Date(),
160
- },
161
- {
162
- id: 'http://example.com/entity/5',
163
- filename: 'collection-metadata.csv',
164
- mediaType: 'text/csv',
165
- size: BigInt(512),
166
- meta: {},
167
- createdAt: new Date(),
168
- updatedAt: new Date(),
169
- },
170
- ];
171
-
172
- await prisma.file.createMany({
173
- data: testFiles,
174
- });
175
-
176
- await opensearch.indices.create({
177
- index: 'entities',
178
- body: {
179
- mappings: {
180
- properties: {
181
- id: { type: 'keyword' },
182
- name: {
183
- type: 'text',
184
- fields: {
185
- keyword: { type: 'keyword' },
186
- },
187
- },
188
- description: { type: 'text' },
189
- entityType: { type: 'keyword' },
190
- memberOf: { type: 'keyword' },
191
- rootCollection: { type: 'keyword' },
192
- location: { type: 'geo_point' },
193
- inLanguage: { type: 'keyword' },
194
- mediaType: { type: 'keyword' },
195
- communicationMode: { type: 'keyword' },
196
- },
197
- },
198
- },
199
- });
200
-
201
- const testDocs = testEntities.flatMap((entity) => [{ index: { _index: 'entities', _id: entity.id } }, entity]);
202
-
203
- await opensearch.bulk({
204
- body: testDocs,
205
- refresh: true,
206
- });
207
-
208
- return testEntities;
209
- }