arocapi 5.0.0-beta.4 → 5.0.0-beta.6

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 (160) hide show
  1. package/LICENSE.md +1 -1
  2. package/README.md +3 -3
  3. package/dist/app.d.ts +19 -13
  4. package/dist/app.js +13 -10
  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.js +5 -1
  12. package/dist/routes/file.js.map +1 -1
  13. package/dist/routes/search.d.ts +2 -4
  14. package/dist/routes/search.js +75 -97
  15. package/dist/routes/search.js.map +1 -1
  16. package/dist/search/advanced.d.ts +8 -0
  17. package/dist/search/advanced.js +198 -0
  18. package/dist/search/advanced.js.map +1 -0
  19. package/dist/search/backend.d.ts +95 -0
  20. package/dist/search/backend.js +5 -0
  21. package/dist/search/backend.js.map +1 -0
  22. package/dist/search/fields.d.ts +63 -0
  23. package/dist/search/fields.js +203 -0
  24. package/dist/search/fields.js.map +1 -0
  25. package/dist/search/opensearch/advanced.d.ts +4 -0
  26. package/dist/search/opensearch/advanced.js +28 -0
  27. package/dist/search/opensearch/advanced.js.map +1 -0
  28. package/dist/search/opensearch/opensearch.d.ts +16 -0
  29. package/dist/search/opensearch/opensearch.js +187 -0
  30. package/dist/search/opensearch/opensearch.js.map +1 -0
  31. package/dist/search/opensearch/visibility.d.ts +3 -0
  32. package/dist/search/opensearch/visibility.js +27 -0
  33. package/dist/search/opensearch/visibility.js.map +1 -0
  34. package/dist/search/postgres/advanced.d.ts +7 -0
  35. package/dist/search/postgres/advanced.js +54 -0
  36. package/dist/search/postgres/advanced.js.map +1 -0
  37. package/dist/search/postgres/facets.d.ts +2 -0
  38. package/dist/search/postgres/facets.js +27 -0
  39. package/dist/search/postgres/facets.js.map +1 -0
  40. package/dist/search/postgres/geo.d.ts +6 -0
  41. package/dist/search/postgres/geo.js +42 -0
  42. package/dist/search/postgres/geo.js.map +1 -0
  43. package/dist/search/postgres/postgres.d.ts +19 -0
  44. package/dist/search/postgres/postgres.js +157 -0
  45. package/dist/search/postgres/postgres.js.map +1 -0
  46. package/dist/search/postgres/values.d.ts +8 -0
  47. package/dist/search/postgres/values.js +20 -0
  48. package/dist/search/postgres/values.js.map +1 -0
  49. package/dist/search/postgres/visibility.d.ts +4 -0
  50. package/dist/search/postgres/visibility.js +38 -0
  51. package/dist/search/postgres/visibility.js.map +1 -0
  52. package/dist/search/requestFilters.d.ts +39 -0
  53. package/dist/search/requestFilters.js +125 -0
  54. package/dist/search/requestFilters.js.map +1 -0
  55. package/dist/search/visibility.d.ts +51 -0
  56. package/dist/search/visibility.js +100 -0
  57. package/dist/search/visibility.js.map +1 -0
  58. package/dist/types/visibility.d.ts +3 -2
  59. package/dist/utils/visibility.js +1 -1
  60. package/dist/utils/visibility.js.map +1 -1
  61. package/package.json +46 -26
  62. package/prisma/models/entity.prisma +9 -8
  63. package/prisma/models/entitySearch.prisma +21 -0
  64. package/prisma/models/file.prisma +3 -3
  65. package/src/app.ts +53 -24
  66. package/src/routes/capabilities.ts +4 -4
  67. package/src/routes/entities.ts +10 -9
  68. package/src/routes/file.ts +5 -1
  69. package/src/routes/search.ts +104 -118
  70. package/src/search/advanced.ts +258 -0
  71. package/src/search/backend.ts +91 -0
  72. package/src/search/fields.ts +320 -0
  73. package/src/search/opensearch/advanced.ts +36 -0
  74. package/src/search/opensearch/opensearch.ts +290 -0
  75. package/src/search/opensearch/visibility.ts +38 -0
  76. package/src/search/postgres/advanced.ts +76 -0
  77. package/src/search/postgres/facets.ts +34 -0
  78. package/src/search/postgres/geo.ts +58 -0
  79. package/src/search/postgres/postgres.ts +232 -0
  80. package/src/search/postgres/values.ts +33 -0
  81. package/src/search/postgres/visibility.ts +54 -0
  82. package/src/search/requestFilters.ts +178 -0
  83. package/src/search/visibility.ts +193 -0
  84. package/src/types/visibility.ts +6 -3
  85. package/src/utils/visibility.ts +1 -1
  86. package/dist/app.test.d.ts +0 -1
  87. package/dist/app.test.js +0 -67
  88. package/dist/app.test.js.map +0 -1
  89. package/dist/errorHandling.test.d.ts +0 -1
  90. package/dist/errorHandling.test.js +0 -222
  91. package/dist/errorHandling.test.js.map +0 -1
  92. package/dist/index.dev.d.ts +0 -1
  93. package/dist/index.dev.js +0 -157
  94. package/dist/index.dev.js.map +0 -1
  95. package/dist/routes/capabilities.test.d.ts +0 -1
  96. package/dist/routes/capabilities.test.js +0 -81
  97. package/dist/routes/capabilities.test.js.map +0 -1
  98. package/dist/routes/crate.test.d.ts +0 -1
  99. package/dist/routes/crate.test.js +0 -390
  100. package/dist/routes/crate.test.js.map +0 -1
  101. package/dist/routes/entities.test.d.ts +0 -1
  102. package/dist/routes/entities.test.js +0 -277
  103. package/dist/routes/entities.test.js.map +0 -1
  104. package/dist/routes/entity.test.d.ts +0 -1
  105. package/dist/routes/entity.test.js +0 -136
  106. package/dist/routes/entity.test.js.map +0 -1
  107. package/dist/routes/file.test.d.ts +0 -1
  108. package/dist/routes/file.test.js +0 -425
  109. package/dist/routes/file.test.js.map +0 -1
  110. package/dist/routes/files.test.d.ts +0 -1
  111. package/dist/routes/files.test.js +0 -245
  112. package/dist/routes/files.test.js.map +0 -1
  113. package/dist/routes/search.test.d.ts +0 -1
  114. package/dist/routes/search.test.js +0 -833
  115. package/dist/routes/search.test.js.map +0 -1
  116. package/dist/test/helpers/fastify.d.ts +0 -9
  117. package/dist/test/helpers/fastify.js +0 -17
  118. package/dist/test/helpers/fastify.js.map +0 -1
  119. package/dist/test/integration.setup.d.ts +0 -47
  120. package/dist/test/integration.setup.js +0 -195
  121. package/dist/test/integration.setup.js.map +0 -1
  122. package/dist/test/integration.test.d.ts +0 -1
  123. package/dist/test/integration.test.js +0 -762
  124. package/dist/test/integration.test.js.map +0 -1
  125. package/dist/transformers/default.test.d.ts +0 -1
  126. package/dist/transformers/default.test.js +0 -225
  127. package/dist/transformers/default.test.js.map +0 -1
  128. package/dist/transformers/transformer.test.d.ts +0 -1
  129. package/dist/transformers/transformer.test.js +0 -165
  130. package/dist/transformers/transformer.test.js.map +0 -1
  131. package/dist/utils/errors.test.d.ts +0 -1
  132. package/dist/utils/errors.test.js +0 -79
  133. package/dist/utils/errors.test.js.map +0 -1
  134. package/dist/utils/queryBuilder.d.ts +0 -47
  135. package/dist/utils/queryBuilder.js +0 -107
  136. package/dist/utils/queryBuilder.js.map +0 -1
  137. package/prisma.config.ts +0 -9
  138. package/src/app.test.ts +0 -91
  139. package/src/errorHandling.test.ts +0 -288
  140. package/src/index.dev.ts +0 -202
  141. package/src/reset.d.ts +0 -1
  142. package/src/routes/__snapshots__/capabilities.test.ts.snap +0 -34
  143. package/src/routes/__snapshots__/entities.test.ts.snap +0 -96
  144. package/src/routes/__snapshots__/entity.test.ts.snap +0 -74
  145. package/src/routes/__snapshots__/search.test.ts.snap +0 -165
  146. package/src/routes/capabilities.test.ts +0 -102
  147. package/src/routes/crate.test.ts +0 -484
  148. package/src/routes/entities.test.ts +0 -324
  149. package/src/routes/entity.test.ts +0 -166
  150. package/src/routes/file.test.ts +0 -526
  151. package/src/routes/files.test.ts +0 -304
  152. package/src/routes/search.test.ts +0 -959
  153. package/src/test/__snapshots__/integration.test.ts.snap +0 -18
  154. package/src/test/helpers/fastify.ts +0 -26
  155. package/src/test/integration.setup.ts +0 -220
  156. package/src/test/integration.test.ts +0 -953
  157. package/src/transformers/default.test.ts +0 -276
  158. package/src/transformers/transformer.test.ts +0 -226
  159. package/src/utils/errors.test.ts +0 -90
  160. package/src/utils/queryBuilder.ts +0 -157
@@ -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
 
5
6
  /**
@@ -12,7 +13,9 @@ export type EntityVisibilityFilter = (
12
13
 
13
14
  /**
14
15
  * Search visibility filter - required
15
- * Returns an OpenSearch query matching the entities visible to this request
16
+ * Returns a condition over `id` and the search backend's declared fields matching the entities visible to this request
16
17
  * Must agree with the entity visibility filter
17
18
  */
18
- export type SearchVisibilityFilter = (context: RequestContext) => Promise<QueryContainer> | QueryContainer;
19
+ export type SearchVisibilityFilter<Fields extends FieldDeclarations = FieldDeclarations> = (
20
+ context: RequestContext,
21
+ ) => Promise<SearchVisibilityWhere<Fields>> | SearchVisibilityWhere<Fields>;
@@ -16,7 +16,7 @@ export const AllVisibleEntityFilter: EntityVisibilityFilter = () => ({});
16
16
  *
17
17
  * Use together with AllVisibleEntityFilter for repositories with no hidden entities.
18
18
  */
19
- export const AllVisibleSearchFilter: SearchVisibilityFilter = () => ({ match_all: {} });
19
+ export const AllVisibleSearchFilter: SearchVisibilityFilter = () => ({});
20
20
 
21
21
  /**
22
22
  * Whether a request has no credentials; without isAuthenticated the repository has no logins, so no request is
@@ -1 +0,0 @@
1
- export {};
package/dist/app.test.js DELETED
@@ -1,67 +0,0 @@
1
- import Fastify from 'fastify';
2
- import { beforeEach, describe, expect, it, vi } from 'vitest';
3
- import { mockReset } from 'vitest-mock-extended';
4
- import app, { AllPublicAccess, AllVisibleEntityFilter, AllVisibleSearchFilter } from './app.js';
5
- import { opensearch, prisma } from './test/helpers/fastify.js';
6
- describe('Entity Route', () => {
7
- beforeEach(() => {
8
- mockReset(prisma);
9
- mockReset(opensearch);
10
- });
11
- const requiredOptions = () => ({
12
- prisma,
13
- opensearch,
14
- access: AllPublicAccess,
15
- fileHandler: { get: vi.fn(), head: vi.fn() },
16
- roCrateHandler: { get: vi.fn(), head: vi.fn() },
17
- entityVisibilityFilter: AllVisibleEntityFilter,
18
- searchVisibilityFilter: AllVisibleSearchFilter,
19
- });
20
- describe('App Registration', () => {
21
- it.each([
22
- ['prisma', 'Prisma client is required'],
23
- ['opensearch', 'OpenSearch client is required'],
24
- ['access', 'access is required'],
25
- ['fileHandler', 'fileHandler is required'],
26
- ['roCrateHandler', 'roCrateHandler is required'],
27
- ['entityVisibilityFilter', 'entityVisibilityFilter is required'],
28
- ['searchVisibilityFilter', 'searchVisibilityFilter is required'],
29
- ])('should handle missing %s', async (option, message) => {
30
- const fastify = Fastify({ logger: false });
31
- const { [option]: _omitted, ...options } = requiredOptions();
32
- fastify.register(app, options);
33
- await expect(() => fastify.ready()).rejects.toThrowError(message);
34
- });
35
- it.each([
36
- ['accessTransformer', 'access', 'https://arocapi.crate-works.org/configuration/access/'],
37
- ['fileAccessTransformer', 'access', 'https://arocapi.crate-works.org/configuration/access/'],
38
- [
39
- 'hiddenResponse',
40
- 'promptLoginForHidden and isAuthenticated',
41
- 'https://arocapi.crate-works.org/configuration/visibility/#promptloginforhidden',
42
- ],
43
- ])('should reject the removed %s option', async (option, replacement, docs) => {
44
- const fastify = Fastify({ logger: false });
45
- fastify.register(app, { ...requiredOptions(), [option]: 'notFound' });
46
- await expect(() => fastify.ready()).rejects.toThrowError(`${option} has been replaced by ${replacement}, see ${docs}`);
47
- });
48
- it('should reject promptLoginForHidden without isAuthenticated', async () => {
49
- const fastify = Fastify({ logger: false });
50
- fastify.register(app, { ...requiredOptions(), promptLoginForHidden: true });
51
- await expect(() => fastify.ready()).rejects.toThrowError('promptLoginForHidden requires isAuthenticated');
52
- });
53
- it('should ignore a removed option left undefined', async () => {
54
- const fastify = Fastify({ logger: false });
55
- await fastify.register(app, { ...requiredOptions(), accessTransformer: undefined });
56
- await expect(fastify.ready()).resolves.toBeDefined();
57
- await fastify.close();
58
- });
59
- it('should register successfully with all required options', async () => {
60
- const fastify = Fastify({ logger: false });
61
- await fastify.register(app, requiredOptions());
62
- await expect(fastify.ready()).resolves.toBeDefined();
63
- await fastify.close();
64
- });
65
- });
66
- });
67
- //# sourceMappingURL=app.test.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"app.test.js","sourceRoot":"","sources":["../src/app.test.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGjD,OAAO,GAAG,EAAE,EAAE,eAAe,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAEhG,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAE/D,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,UAAU,CAAC,GAAG,EAAE;QACd,SAAS,CAAC,MAAM,CAAC,CAAC;QAClB,SAAS,CAAC,UAAU,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,GAAY,EAAE,CAAC,CAAC;QACtC,MAAM;QACN,UAAU;QACV,MAAM,EAAE,eAAe;QACvB,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;QAC5C,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;QAC/C,sBAAsB,EAAE,sBAAsB;QAC9C,sBAAsB,EAAE,sBAAsB;KAC/C,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,IAAI,CAAC;YACN,CAAC,QAAQ,EAAE,2BAA2B,CAAC;YACvC,CAAC,YAAY,EAAE,+BAA+B,CAAC;YAC/C,CAAC,QAAQ,EAAE,oBAAoB,CAAC;YAChC,CAAC,aAAa,EAAE,yBAAyB,CAAC;YAC1C,CAAC,gBAAgB,EAAE,4BAA4B,CAAC;YAChD,CAAC,wBAAwB,EAAE,oCAAoC,CAAC;YAChE,CAAC,wBAAwB,EAAE,oCAAoC,CAAC;SACxD,CAAC,CAAC,0BAA0B,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;YAChE,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAC3C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,GAAG,eAAe,EAAE,CAAC;YAG7D,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAE/B,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC;YACN,CAAC,mBAAmB,EAAE,QAAQ,EAAE,uDAAuD,CAAC;YACxF,CAAC,uBAAuB,EAAE,QAAQ,EAAE,uDAAuD,CAAC;YAC5F;gBACE,gBAAgB;gBAChB,0CAA0C;gBAC1C,gFAAgF;aACjF;SACF,CAAC,CAAC,qCAAqC,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;YAC5E,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAE3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,GAAG,eAAe,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;YAEtE,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CACtD,GAAG,MAAM,yBAAyB,WAAW,SAAS,IAAI,EAAE,CAC7D,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAE3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,GAAG,eAAe,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;YAE5E,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,+CAA+C,CAAC,CAAC;QAC5G,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC7D,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAE3C,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,GAAG,eAAe,EAAE,EAAE,iBAAiB,EAAE,SAAS,EAAa,CAAC,CAAC;YAE/F,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;YAErD,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;YACtE,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAE3C,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,EAAE,CAAC,CAAC;YAE/C,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;YAErD,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1 +0,0 @@
1
- export {};
@@ -1,222 +0,0 @@
1
- import sensible from '@fastify/sensible';
2
- import Fastify from 'fastify';
3
- import { serializerCompiler, validatorCompiler } from 'fastify-type-provider-zod';
4
- import { describe, expect, it, vi } from 'vitest';
5
- import { z } from 'zod';
6
- import arocapi, { AllPublicAccess, AllVisibleEntityFilter, AllVisibleSearchFilter, errorHandler, notFoundHandler, } from './app.js';
7
- import { opensearch, prisma } from './test/helpers/fastify.js';
8
- const arocapiOptions = {
9
- prisma,
10
- opensearch,
11
- access: AllPublicAccess,
12
- fileHandler: { get: vi.fn(), head: vi.fn() },
13
- roCrateHandler: { get: vi.fn(), head: vi.fn() },
14
- entityVisibilityFilter: AllVisibleEntityFilter,
15
- searchVisibilityFilter: AllVisibleSearchFilter,
16
- };
17
- const internalErrorBody = { error: { code: 'INTERNAL_ERROR', message: 'Internal server error' } };
18
- const notFoundBody = { error: { code: 'NOT_FOUND', message: 'The requested resource was not found' } };
19
- const message = 'Something specific went wrong';
20
- const buildConsumer = () => {
21
- const logs = [];
22
- const fastify = Fastify({
23
- logger: {
24
- level: 'info',
25
- stream: { write: (line) => logs.push(JSON.parse(line)) },
26
- },
27
- });
28
- fastify.setValidatorCompiler(validatorCompiler);
29
- fastify.setSerializerCompiler(serializerCompiler);
30
- fastify.setErrorHandler(errorHandler);
31
- fastify.setNotFoundHandler(notFoundHandler);
32
- return { fastify, logs };
33
- };
34
- describe('Error handling for consumer routes', () => {
35
- it('hides unexpected errors behind a generic 500 and logs them', async () => {
36
- const { fastify, logs } = buildConsumer();
37
- fastify.get('/boom', async () => {
38
- throw new Error('db password is hunter2');
39
- });
40
- const response = await fastify.inject({ method: 'GET', url: '/boom' });
41
- expect(response.statusCode).toBe(500);
42
- expect(response.json()).toEqual(internalErrorBody);
43
- expect(logs.some((l) => l.level === 50 && l.err.message === 'db password is hunter2')).toBe(true);
44
- });
45
- it.each([
46
- [400, 400, { error: { code: 'VALIDATION_ERROR', message } }],
47
- [401, 401, { error: { code: 'UNAUTHORIZED', message } }],
48
- [403, 403, { error: { code: 'FORBIDDEN', message } }],
49
- [404, 404, { error: { code: 'NOT_FOUND', message } }],
50
- [405, 405, { error: { code: 'VALIDATION_ERROR', message } }],
51
- [409, 409, { error: { code: 'CONFLICT', message } }],
52
- [413, 413, { error: { code: 'VALIDATION_ERROR', message } }],
53
- [416, 416, { error: { code: 'RANGE_NOT_SATISFIABLE', message } }],
54
- [422, 422, { error: { code: 'VALIDATION_ERROR', message } }],
55
- [429, 429, { error: { code: 'RATE_LIMIT_EXCEEDED', message } }],
56
- [503, 500, internalErrorBody],
57
- ])('answers a thrown %i http error with %i in the spec shape', async (thrown, status, body) => {
58
- const { fastify } = buildConsumer();
59
- await fastify.register(sensible);
60
- fastify.get('/fail', async () => {
61
- throw fastify.httpErrors.createError(thrown, message);
62
- });
63
- const response = await fastify.inject({ method: 'GET', url: '/fail' });
64
- expect(response.statusCode).toBe(status);
65
- expect(response.json()).toEqual(body);
66
- });
67
- it('keeps headers carried by the error', async () => {
68
- const { fastify } = buildConsumer();
69
- await fastify.register(sensible);
70
- fastify.get('/fail', async () => {
71
- throw fastify.httpErrors.createError(401, message, { headers: { 'www-authenticate': 'Bearer' } });
72
- });
73
- const response = await fastify.inject({ method: 'GET', url: '/fail' });
74
- expect(response.statusCode).toBe(401);
75
- expect(response.headers['www-authenticate']).toBe('Bearer');
76
- });
77
- it('hides a library error with a 4xx status behind a generic 500 and logs it with its stack', async () => {
78
- const { fastify, logs } = buildConsumer();
79
- const raw = 'index_not_found_exception: no such index [items-v2]';
80
- fastify.get('/fail', async () => {
81
- throw Object.assign(new Error(raw), { name: 'ResponseError', statusCode: 404, meta: { statusCode: 404 } });
82
- });
83
- const response = await fastify.inject({ method: 'GET', url: '/fail' });
84
- expect(response.statusCode).toBe(500);
85
- expect(response.json()).toEqual(internalErrorBody);
86
- expect(response.body).not.toContain('items-v2');
87
- const logged = logs.find((l) => l.level === 50)?.err;
88
- expect(logged?.message).toBe(raw);
89
- expect(logged?.stack).toContain(raw);
90
- });
91
- it('keeps the status and message of a custom error marked expose', async () => {
92
- class ConflictError extends Error {
93
- statusCode = 409;
94
- expose = true;
95
- }
96
- const { fastify } = buildConsumer();
97
- fastify.get('/fail', async () => {
98
- throw new ConflictError(message);
99
- });
100
- const response = await fastify.inject({ method: 'GET', url: '/fail' });
101
- expect(response.statusCode).toBe(409);
102
- expect(response.json()).toEqual({ error: { code: 'CONFLICT', message } });
103
- });
104
- it.each([
105
- ['an invalid JSON body', { 'content-type': 'application/json' }, '{"broken', 400],
106
- ['an oversized body', { 'content-type': 'application/json' }, JSON.stringify({ big: 'x'.repeat(200) }), 413],
107
- ['an unsupported media type', { 'content-type': 'application/x-unknown' }, 'whatever', 415],
108
- ])("keeps Fastify's own client error for %s", async (_label, headers, payload, status) => {
109
- const { fastify } = buildConsumer();
110
- fastify.post('/things', { bodyLimit: 100 }, async () => ({}));
111
- const response = await fastify.inject({ method: 'POST', url: '/things', headers, payload });
112
- expect(response.statusCode).toBe(status);
113
- expect(response.json().error.code).toBe('VALIDATION_ERROR');
114
- expect(response.json().error.message).not.toBe('');
115
- });
116
- it('hides errors that carry only a status behind a generic 500', async () => {
117
- const { fastify } = buildConsumer();
118
- fastify.get('/fail', async () => {
119
- throw Object.assign(new Error(message), { status: 403 });
120
- });
121
- const response = await fastify.inject({ method: 'GET', url: '/fail' });
122
- expect(response.statusCode).toBe(500);
123
- expect(response.json()).toEqual(internalErrorBody);
124
- });
125
- it('maps a thrown plain object marked expose with no message', async () => {
126
- const { fastify } = buildConsumer();
127
- fastify.get('/fail', async () => {
128
- throw { statusCode: 404, expose: true };
129
- });
130
- const response = await fastify.inject({ method: 'GET', url: '/fail' });
131
- expect(response.statusCode).toBe(404);
132
- expect(response.json()).toEqual({ error: { code: 'NOT_FOUND', message: '' } });
133
- });
134
- it('hides an error with a non-string code behind a generic 500', async () => {
135
- const { fastify } = buildConsumer();
136
- fastify.get('/fail', async () => {
137
- throw Object.assign(new Error(message), { code: 14, statusCode: 400 });
138
- });
139
- const response = await fastify.inject({ method: 'GET', url: '/fail' });
140
- expect(response.statusCode).toBe(500);
141
- expect(response.json()).toEqual(internalErrorBody);
142
- });
143
- it('hides a thrown plain object with a status behind a generic 500', async () => {
144
- const { fastify } = buildConsumer();
145
- fastify.get('/fail', async () => {
146
- throw { statusCode: 404 };
147
- });
148
- const response = await fastify.inject({ method: 'GET', url: '/fail' });
149
- expect(response.statusCode).toBe(500);
150
- expect(response.json()).toEqual(internalErrorBody);
151
- });
152
- it.each([null, undefined])('answers a thrown %s with a generic 500', async (thrown) => {
153
- const { fastify } = buildConsumer();
154
- fastify.get('/fail', async () => {
155
- throw thrown;
156
- });
157
- const response = await fastify.inject({ method: 'GET', url: '/fail' });
158
- expect(response.statusCode).toBe(500);
159
- expect(response.json()).toEqual(internalErrorBody);
160
- });
161
- it('answers Zod validation failures with VALIDATION_ERROR violations', async () => {
162
- const { fastify } = buildConsumer();
163
- fastify
164
- .withTypeProvider()
165
- .get('/things', { schema: { querystring: z.object({ limit: z.coerce.number().int() }) } }, async () => ({}));
166
- const response = await fastify.inject({ method: 'GET', url: '/things?limit=abc' });
167
- expect(response.statusCode).toBe(400);
168
- expect(response.json()).toMatchObject({
169
- error: {
170
- code: 'VALIDATION_ERROR',
171
- message: 'The request parameters are invalid',
172
- details: { violations: [{ field: '/limit' }] },
173
- },
174
- });
175
- });
176
- it('answers unknown routes with NOT_FOUND', async () => {
177
- const { fastify } = buildConsumer();
178
- const response = await fastify.inject({ method: 'GET', url: '/nowhere' });
179
- expect(response.statusCode).toBe(404);
180
- expect(response.json()).toEqual(notFoundBody);
181
- });
182
- it.each([
183
- ['without a prefix', undefined, '/entities'],
184
- ['under a prefix', '/api', '/api/entities'],
185
- ])('answers arocapi routes registered %s in the spec shape', async (_label, prefix, url) => {
186
- const { fastify } = buildConsumer();
187
- await fastify.register(arocapi, { ...arocapiOptions, prefix });
188
- const invalid = await fastify.inject({ method: 'GET', url: `${url}?limit=abc` });
189
- const unknown = await fastify.inject({ method: 'GET', url: `${url}/nowhere/else` });
190
- expect(invalid.statusCode).toBe(400);
191
- expect(invalid.json().error.code).toBe('VALIDATION_ERROR');
192
- expect(unknown.statusCode).toBe(404);
193
- expect(unknown.json().error.code).toBe('NOT_FOUND');
194
- });
195
- it('leaves 404s to a prefixed consumer scope that mounts arocapi without its own prefix', async () => {
196
- const { fastify } = buildConsumer();
197
- await fastify.register(async (api) => {
198
- api.setNotFoundHandler((_request, reply) => reply.code(404).send({ scope: 'api' }));
199
- await api.register(arocapi, arocapiOptions);
200
- }, { prefix: '/api' });
201
- const response = await fastify.inject({ method: 'GET', url: '/api/nowhere' });
202
- expect(response.statusCode).toBe(404);
203
- expect(response.json()).toEqual({ scope: 'api' });
204
- });
205
- it("leaves the consumer's root 404s alone when arocapi is registered with prefix '/'", async () => {
206
- const fastify = Fastify({ logger: false });
207
- fastify.setNotFoundHandler((_request, reply) => reply.code(404).send({ scope: 'root' }));
208
- await fastify.register(arocapi, { ...arocapiOptions, prefix: '/' });
209
- const response = await fastify.inject({ method: 'GET', url: '/nowhere' });
210
- expect(response.json()).toEqual({ scope: 'root' });
211
- });
212
- });
213
- describe('Error handling for arocapi on its own', () => {
214
- it('answers unknown paths under its prefix with NOT_FOUND', async () => {
215
- const fastify = Fastify({ logger: false });
216
- await fastify.register(arocapi, { ...arocapiOptions, prefix: '/api' });
217
- const response = await fastify.inject({ method: 'GET', url: '/api/nowhere' });
218
- expect(response.statusCode).toBe(404);
219
- expect(response.json()).toEqual(notFoundBody);
220
- });
221
- });
222
- //# sourceMappingURL=errorHandling.test.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"errorHandling.test.js","sourceRoot":"","sources":["../src/errorHandling.test.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAwB,MAAM,2BAA2B,CAAC;AACxG,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,OAAO,EAAE,EACd,eAAe,EACf,sBAAsB,EACtB,sBAAsB,EACtB,YAAY,EACZ,eAAe,GAChB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAE/D,MAAM,cAAc,GAAG;IACrB,MAAM;IACN,UAAU;IACV,MAAM,EAAE,eAAe;IACvB,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;IAC5C,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;IAC/C,sBAAsB,EAAE,sBAAsB;IAC9C,sBAAsB,EAAE,sBAAsB;CAC/C,CAAC;AAEF,MAAM,iBAAiB,GAAG,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,uBAAuB,EAAE,EAAE,CAAC;AAClG,MAAM,YAAY,GAAG,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,sCAAsC,EAAE,EAAE,CAAC;AACvG,MAAM,OAAO,GAAG,+BAA+B,CAAC;AAEhD,MAAM,aAAa,GAAG,GAAG,EAAE;IACzB,MAAM,IAAI,GAA8B,EAAE,CAAC;IAC3C,MAAM,OAAO,GAAG,OAAO,CAAC;QACtB,MAAM,EAAE;YACN,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAA4B,CAAC,EAAE;SAC5F;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAChD,OAAO,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAClD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IACtC,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAE5C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;IAClD,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACnD,MAAM,CACJ,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,IAAK,CAAC,CAAC,GAA2B,CAAC,OAAO,KAAK,wBAAwB,CAAC,CACxG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAAC;QAC5D,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,EAAE,CAAC;QACxD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;QACrD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;QACrD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAAC;QAC5D,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;QACpD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAAC;QAC5D,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,EAAE,EAAE,CAAC;QACjE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAAC;QAC5D,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,EAAE,EAAE,CAAC;QAC/D,CAAC,GAAG,EAAE,GAAG,EAAE,iBAAiB,CAAC;KAC9B,CAAC,CAAC,0DAA0D,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QAC5F,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,MAAM,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,MAAM,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QACpG,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yFAAyF,EAAE,KAAK,IAAI,EAAE;QACvG,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAG,qDAAqD,CAAC;QAClE,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAC7G,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACnD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,EAAE,GAAqD,CAAC;QACvG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,aAAc,SAAQ,KAAK;YAC/B,UAAU,GAAG,GAAG,CAAC;YACjB,MAAM,GAAG,IAAI,CAAC;SACf;QACD,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,sBAAsB,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,EAAE,UAAU,EAAE,GAAG,CAAC;QACjF,CAAC,mBAAmB,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC;QAC5G,CAAC,2BAA2B,EAAE,EAAE,cAAc,EAAE,uBAAuB,EAAE,EAAE,UAAU,EAAE,GAAG,CAAC;KAC5F,CAAC,CAAC,yCAAyC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QACvF,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE9D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAE5F,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACjF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,wCAAwC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACpF,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,MAAM,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QAChF,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,OAAO;aACJ,gBAAgB,EAAmB;aACnC,GAAG,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE/G,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAEnF,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC;YACpC,KAAK,EAAE;gBACL,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,oCAAoC;gBAC7C,OAAO,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE;aAC/C;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;QAE1E,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,kBAAkB,EAAE,SAAS,EAAE,WAAW,CAAC;QAC5C,CAAC,gBAAgB,EAAE,MAAM,EAAE,eAAe,CAAC;KAC5C,CAAC,CAAC,wDAAwD,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE;QACzF,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,GAAG,cAAc,EAAE,MAAM,EAAE,CAAC,CAAC;QAE/D,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,GAAG,YAAY,EAAE,CAAC,CAAC;QACjF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,GAAG,eAAe,EAAE,CAAC,CAAC;QAEpF,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qFAAqF,EAAE,KAAK,IAAI,EAAE;QACnG,MAAM,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,CAAC;QACpC,MAAM,OAAO,CAAC,QAAQ,CACpB,KAAK,EAAE,GAAG,EAAE,EAAE;YACZ,GAAG,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;YACpF,MAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAC9C,CAAC,EACD,EAAE,MAAM,EAAE,MAAM,EAAE,CACnB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,CAAC;QAE9E,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3C,OAAO,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QACzF,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,GAAG,cAAc,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QAEpE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;QAE1E,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,uCAAuC,EAAE,GAAG,EAAE;IACrD,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3C,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,GAAG,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QAEvE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,CAAC;QAE9E,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1 +0,0 @@
1
- export {};
package/dist/index.dev.js DELETED
@@ -1,157 +0,0 @@
1
- import { createReadStream, existsSync, readFileSync, statSync } from 'node:fs';
2
- import { Readable } from 'node:stream';
3
- import { Client } from '@opensearch-project/opensearch';
4
- import { PrismaMariaDb } from '@prisma/adapter-mariadb';
5
- import Fastify from 'fastify';
6
- import arocapi, { AllPublicAccess, AllVisibleEntityFilter, AllVisibleSearchFilter, } from './app.js';
7
- import { PrismaClient } from './generated/prisma/client.js';
8
- const adapter = new PrismaMariaDb({
9
- host: 'localhost',
10
- user: 'root',
11
- password: 'password',
12
- database: 'catalog',
13
- port: 3306,
14
- connectionLimit: 5,
15
- allowPublicKeyRetrieval: true,
16
- });
17
- const prisma = new PrismaClient({ adapter });
18
- if (!process.env.OPENSEARCH_URL) {
19
- throw new Error('OPENSEARCH_URL environment variable is not set');
20
- }
21
- const opensearchUrl = process.env.OPENSEARCH_URL;
22
- const opensearch = new Client({ node: opensearchUrl });
23
- const fileHandler = {
24
- head: async (file) => {
25
- const filePath = file.meta.storagePath;
26
- if (!existsSync(filePath)) {
27
- return false;
28
- }
29
- const stats = statSync(filePath);
30
- return {
31
- contentType: file.mediaType,
32
- contentLength: Number(file.size),
33
- lastModified: stats.mtime,
34
- };
35
- },
36
- get: async (file) => {
37
- const filePath = file.meta.storagePath;
38
- if (!existsSync(filePath)) {
39
- return false;
40
- }
41
- const stats = statSync(filePath);
42
- return {
43
- type: 'stream',
44
- stream: createReadStream(filePath),
45
- metadata: {
46
- contentType: file.mediaType,
47
- contentLength: Number(file.size),
48
- lastModified: stats.mtime,
49
- },
50
- };
51
- },
52
- };
53
- const transformRoCrate = (filePath, remapRootTo) => {
54
- const fileContents = readFileSync(filePath, 'utf-8');
55
- const rocrate = JSON.parse(fileContents);
56
- const graph = rocrate['@graph'] || [];
57
- const rootNode = graph.find((node) => node['@id'] === 'ro-crate-metadata.json');
58
- if (!rootNode) {
59
- return false;
60
- }
61
- rootNode.about['@id'] = remapRootTo;
62
- const jsonString = JSON.stringify(rocrate);
63
- return { rocrate, jsonString };
64
- };
65
- const roCrateHandler = {
66
- head: async (entity) => {
67
- const meta = entity.meta;
68
- const filePath = meta.storagePath;
69
- if (!existsSync(filePath)) {
70
- return false;
71
- }
72
- if (meta.remapRootTo) {
73
- const result = transformRoCrate(filePath, meta.remapRootTo);
74
- if (!result) {
75
- return false;
76
- }
77
- return {
78
- contentType: 'application/ld+json',
79
- contentLength: Buffer.byteLength(result.jsonString),
80
- lastModified: statSync(filePath).mtime,
81
- };
82
- }
83
- const stats = statSync(filePath);
84
- return {
85
- contentType: 'application/ld+json',
86
- contentLength: stats.size,
87
- lastModified: stats.mtime,
88
- };
89
- },
90
- get: async (entity) => {
91
- const meta = entity.meta;
92
- const filePath = meta.storagePath;
93
- if (!existsSync(filePath)) {
94
- return false;
95
- }
96
- if (meta.remapRootTo) {
97
- const result = transformRoCrate(filePath, meta.remapRootTo);
98
- if (!result) {
99
- return false;
100
- }
101
- return {
102
- type: 'stream',
103
- stream: Readable.from(result.jsonString),
104
- metadata: {
105
- contentType: 'application/ld+json',
106
- contentLength: Buffer.byteLength(result.jsonString),
107
- lastModified: statSync(filePath).mtime,
108
- },
109
- };
110
- }
111
- const stats = statSync(filePath);
112
- return {
113
- type: 'stream',
114
- stream: createReadStream(filePath),
115
- metadata: {
116
- contentType: 'application/ld+json',
117
- contentLength: stats.size,
118
- lastModified: stats.mtime,
119
- },
120
- };
121
- },
122
- };
123
- const oniTransformer = (entity) => {
124
- return {
125
- ...entity,
126
- accessControl: 'Public',
127
- counts: {
128
- collections: 0,
129
- objects: 0,
130
- files: 0,
131
- },
132
- };
133
- };
134
- const fastify = Fastify({
135
- logger: true,
136
- });
137
- fastify.register(arocapi, {
138
- prisma,
139
- opensearch,
140
- fileHandler,
141
- roCrateHandler,
142
- access: AllPublicAccess,
143
- entityTransformers: [oniTransformer],
144
- entityVisibilityFilter: AllVisibleEntityFilter,
145
- searchVisibilityFilter: AllVisibleSearchFilter,
146
- });
147
- const start = async () => {
148
- try {
149
- await fastify.listen({ port: 9000 });
150
- }
151
- catch (err) {
152
- fastify.log.error(err);
153
- process.exit(1);
154
- }
155
- };
156
- start();
157
- //# sourceMappingURL=index.dev.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.dev.js","sourceRoot":"","sources":["../src/index.dev.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,OAAO,EAAE,EACd,eAAe,EACf,sBAAsB,EACtB,sBAAsB,GAIvB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC;IAChC,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,SAAS;IACnB,IAAI,EAAE,IAAI;IACV,eAAe,EAAE,CAAC;IAElB,uBAAuB,EAAE,IAAI;CAC9B,CAAC,CAAC;AACH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;AAE7C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;IAChC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;AACpE,CAAC;AACD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;AACjD,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;AAEvD,MAAM,WAAW,GAAgB;IAC/B,IAAI,EAAE,KAAK,EAAE,IAAU,EAAE,EAAE;QACzB,MAAM,QAAQ,GAAI,IAAI,CAAC,IAAgC,CAAC,WAAW,CAAC;QAEpE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,SAAS;YAC3B,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YAChC,YAAY,EAAE,KAAK,CAAC,KAAK;SAC1B,CAAC;IACJ,CAAC;IACD,GAAG,EAAE,KAAK,EAAE,IAAU,EAAE,EAAE;QACxB,MAAM,QAAQ,GAAI,IAAI,CAAC,IAAgC,CAAC,WAAW,CAAC;QAEpE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC;YAClC,QAAQ,EAAE;gBACR,WAAW,EAAE,IAAI,CAAC,SAAS;gBAC3B,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;gBAChC,YAAY,EAAE,KAAK,CAAC,KAAK;aAC1B;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,WAAmB,EAAoD,EAAE;IACnH,MAAM,YAAY,GAAG,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAItC,CAAC;IAEF,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,wBAAwB,CAEjE,CAAC;IAEd,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC;IAEpC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE3C,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,cAAc,GAAmB;IACrC,IAAI,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAoD,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;QAElC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YAE5D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO;gBACL,WAAW,EAAE,qBAAqB;gBAClC,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;gBACnD,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,KAAK;aACvC,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO;YACL,WAAW,EAAE,qBAAqB;YAClC,aAAa,EAAE,KAAK,CAAC,IAAI;YACzB,YAAY,EAAE,KAAK,CAAC,KAAK;SAC1B,CAAC;IACJ,CAAC;IACD,GAAG,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAoD,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;QAElC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YAE5D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;gBACxC,QAAQ,EAAE;oBACR,WAAW,EAAE,qBAAqB;oBAClC,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;oBACnD,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,KAAK;iBACvC;aACF,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC;YAClC,QAAQ,EAAE;gBACR,WAAW,EAAE,qBAAqB;gBAClC,aAAa,EAAE,KAAK,CAAC,IAAI;gBACzB,YAAY,EAAE,KAAK,CAAC,KAAK;aAC1B;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,MAAM,cAAc,GAAsB,CAAC,MAAM,EAAE,EAAE;IACnD,OAAO;QACL,GAAG,MAAM;QACT,aAAa,EAAE,QAAQ;QACvB,MAAM,EAAE;YACN,WAAW,EAAE,CAAC;YACd,OAAO,EAAE,CAAC;YACV,KAAK,EAAE,CAAC;SACT;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,OAAO,CAAC;IACtB,MAAM,EAAE,IAAI;CACb,CAAC,CAAC;AACH,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE;IACxB,MAAM;IACN,UAAU;IACV,WAAW;IACX,cAAc;IACd,MAAM,EAAE,eAAe;IACvB,kBAAkB,EAAE,CAAC,cAAc,CAAC;IACpC,sBAAsB,EAAE,sBAAsB;IAC9C,sBAAsB,EAAE,sBAAsB;CAC/C,CAAC,CAAC;AAEH,MAAM,KAAK,GAAG,KAAK,IAAI,EAAE;IACvB,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC;AACF,KAAK,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export {};
@@ -1,81 +0,0 @@
1
- import { afterEach, describe, expect, it, vi } from 'vitest';
2
- import app, { AllPublicAccess, AllVisibleEntityFilter, AllVisibleSearchFilter } from '../app.js';
3
- import { fastify, fastifyAfter, fastifyBefore, opensearch, prisma } from '../test/helpers/fastify.js';
4
- import { OpensearchQueryBuilder } from '../utils/queryBuilder.js';
5
- const registerApp = async (options = {}) => {
6
- await fastifyBefore();
7
- await fastify.register(app, {
8
- prisma,
9
- opensearch,
10
- access: AllPublicAccess,
11
- fileHandler: { get: vi.fn(), head: vi.fn() },
12
- roCrateHandler: { get: vi.fn(), head: vi.fn() },
13
- entityVisibilityFilter: AllVisibleEntityFilter,
14
- searchVisibilityFilter: AllVisibleSearchFilter,
15
- ...options,
16
- });
17
- };
18
- const getCapabilities = async () => {
19
- const response = await fastify.inject({ method: 'GET', url: '/capabilities' });
20
- return { statusCode: response.statusCode, body: response.json() };
21
- };
22
- describe('Capabilities Route', () => {
23
- afterEach(async () => {
24
- await fastifyAfter();
25
- });
26
- describe('GET /capabilities', () => {
27
- it('should declare the default capabilities', async () => {
28
- await registerApp();
29
- const { statusCode, body } = await getCapabilities();
30
- expect(statusCode).toBe(200);
31
- expect(body).toMatchSnapshot();
32
- });
33
- it('should declare every facet as a filter', async () => {
34
- await registerApp();
35
- const { body } = await getCapabilities();
36
- expect(Object.keys(body.search.filters)).toEqual(expect.arrayContaining(Object.keys(body.search.facets)));
37
- });
38
- it('should declare only terms aggregations', async () => {
39
- await registerApp({
40
- queryBuilderOptions: {
41
- aggregations: {
42
- inLanguage: { terms: { size: 20 } },
43
- dateCreated: { date_histogram: { field: 'dateCreated', calendar_interval: 'year' } },
44
- },
45
- },
46
- });
47
- const { body } = await getCapabilities();
48
- expect(body.search).toEqual({
49
- filters: { inLanguage: { type: 'string' } },
50
- facets: { inLanguage: {} },
51
- });
52
- });
53
- it('should use an overridden searchCapabilities', async () => {
54
- const labelled = {
55
- filters: {
56
- inLanguage: { type: 'string', label: 'Language' },
57
- dateCreated: { type: 'date', label: 'Date created' },
58
- },
59
- facets: { inLanguage: { label: 'Language' } },
60
- };
61
- class LabelledQueryBuilder extends OpensearchQueryBuilder {
62
- searchCapabilities() {
63
- return labelled;
64
- }
65
- }
66
- await registerApp({ queryBuilderClass: LabelledQueryBuilder });
67
- const { body } = await getCapabilities();
68
- expect(body.search).toEqual(labelled);
69
- });
70
- it('should not run the access function', async () => {
71
- const access = vi.fn(() => {
72
- throw new Error('Unauthorised');
73
- });
74
- await registerApp({ access });
75
- const { statusCode } = await getCapabilities();
76
- expect(statusCode).toBe(200);
77
- expect(access).not.toHaveBeenCalled();
78
- });
79
- });
80
- });
81
- //# sourceMappingURL=capabilities.test.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"capabilities.test.js","sourceRoot":"","sources":["../../src/routes/capabilities.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE7D,OAAO,GAAG,EAAE,EAAE,eAAe,EAAE,sBAAsB,EAAE,sBAAsB,EAAgB,MAAM,WAAW,CAAC;AAC/G,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACtG,OAAO,EAAE,sBAAsB,EAAyB,MAAM,0BAA0B,CAAC;AAEzF,MAAM,WAAW,GAAG,KAAK,EAAE,OAAO,GAAqB,EAAE,EAAE,EAAE;IAC3D,MAAM,aAAa,EAAE,CAAC;IACtB,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;QAC1B,MAAM;QACN,UAAU;QACV,MAAM,EAAE,eAAe;QACvB,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;QAC5C,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;QAC/C,sBAAsB,EAAE,sBAAsB;QAC9C,sBAAsB,EAAE,sBAAsB;QAC9C,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,KAAK,IAAI,EAAE;IACjC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAAC;IAE/E,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAgC,EAAE,CAAC;AAClG,CAAC,CAAC;AAEF,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,YAAY,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,WAAW,EAAE,CAAC;YAEpB,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,MAAM,eAAe,EAAE,CAAC;YAErD,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,WAAW,EAAE,CAAC;YAEpB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAe,EAAE,CAAC;YAEzC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC5G,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,WAAW,CAAC;gBAChB,mBAAmB,EAAE;oBACnB,YAAY,EAAE;wBACZ,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;wBACnC,WAAW,EAAE,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,EAAE,EAAE;qBACrF;iBACF;aACF,CAAC,CAAC;YAEH,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAe,EAAE,CAAC;YAEzC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBAC1B,OAAO,EAAE,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;gBAC3C,MAAM,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;aAC3B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,QAAQ,GAAqB;gBACjC,OAAO,EAAE;oBACP,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE;oBACjD,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE;iBACrD;gBACD,MAAM,EAAE,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;aAC9C,CAAC;YACF,MAAM,oBAAqB,SAAQ,sBAAsB;gBACvD,kBAAkB;oBAChB,OAAO,QAAQ,CAAC;gBAClB,CAAC;aACF;YAED,MAAM,WAAW,CAAC,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,CAAC,CAAC;YAE/D,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAe,EAAE,CAAC;YAEzC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE;gBACxB,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;YAClC,CAAC,CAAC,CAAC;YAEH,MAAM,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YAE9B,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,eAAe,EAAE,CAAC;YAE/C,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1 +0,0 @@
1
- export {};