arocapi 4.0.1 → 5.0.0-beta.2

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 (60) hide show
  1. package/README.md +76 -33
  2. package/dist/app.d.ts +2 -3
  3. package/dist/app.js +7 -9
  4. package/dist/app.js.map +1 -1
  5. package/dist/app.test.js +0 -7
  6. package/dist/app.test.js.map +1 -1
  7. package/dist/routes/capabilities.d.ts +7 -0
  8. package/dist/routes/capabilities.js +13 -0
  9. package/dist/routes/capabilities.js.map +1 -0
  10. package/dist/routes/capabilities.test.d.ts +1 -0
  11. package/dist/routes/capabilities.test.js +81 -0
  12. package/dist/routes/capabilities.test.js.map +1 -0
  13. package/dist/routes/crate.test.js +23 -23
  14. package/dist/routes/crate.test.js.map +1 -1
  15. package/dist/routes/entities.js +1 -1
  16. package/dist/routes/entities.js.map +1 -1
  17. package/dist/routes/entity.js +1 -1
  18. package/dist/routes/entity.js.map +1 -1
  19. package/dist/routes/file.js +1 -1
  20. package/dist/routes/file.js.map +1 -1
  21. package/dist/routes/files.js +1 -1
  22. package/dist/routes/files.js.map +1 -1
  23. package/dist/routes/{crate.js → metadata.js} +4 -4
  24. package/dist/routes/metadata.js.map +1 -0
  25. package/dist/routes/search.d.ts +2 -3
  26. package/dist/routes/search.js +2 -4
  27. package/dist/routes/search.js.map +1 -1
  28. package/dist/routes/search.test.js +8 -1
  29. package/dist/routes/search.test.js.map +1 -1
  30. package/dist/test/helpers/fastify.d.ts +1 -1
  31. package/dist/test/integration.setup.d.ts +1 -1
  32. package/dist/test/integration.setup.js +0 -1
  33. package/dist/test/integration.setup.js.map +1 -1
  34. package/dist/utils/errors.d.ts +7 -7
  35. package/dist/utils/queryBuilder.d.ts +12 -0
  36. package/dist/utils/queryBuilder.js +9 -0
  37. package/dist/utils/queryBuilder.js.map +1 -1
  38. package/package.json +34 -37
  39. package/src/app.test.ts +0 -7
  40. package/src/app.ts +9 -12
  41. package/src/routes/__snapshots__/capabilities.test.ts.snap +34 -0
  42. package/src/routes/capabilities.test.ts +102 -0
  43. package/src/routes/capabilities.ts +22 -0
  44. package/src/routes/crate.test.ts +23 -23
  45. package/src/routes/entities.ts +1 -1
  46. package/src/routes/entity.ts +1 -1
  47. package/src/routes/file.ts +1 -1
  48. package/src/routes/files.ts +1 -1
  49. package/src/routes/{crate.ts → metadata.ts} +3 -3
  50. package/src/routes/search.test.ts +8 -1
  51. package/src/routes/search.ts +4 -13
  52. package/src/test/integration.setup.ts +0 -1
  53. package/src/utils/errors.ts +1 -1
  54. package/src/utils/queryBuilder.ts +25 -0
  55. package/dist/express.d.ts +0 -4
  56. package/dist/express.js +0 -14
  57. package/dist/express.js.map +0 -1
  58. package/dist/routes/crate.js.map +0 -1
  59. package/src/express.ts +0 -21
  60. /package/dist/routes/{crate.d.ts → metadata.d.ts} +0 -0
@@ -3,12 +3,18 @@ import { afterEach, beforeEach, describe, expect, it } from 'vitest';
3
3
  import { fastify, fastifyAfter, fastifyBefore, opensearch, prisma } from '../test/helpers/fastify.js';
4
4
  import { AllPublicAccessTransformer } from '../transformers/default.js';
5
5
  import type { StandardErrorResponse } from '../utils/errors.js';
6
+ import { OpensearchQueryBuilder } from '../utils/queryBuilder.js';
6
7
  import searchRoute from './search.js';
7
8
 
8
9
  describe('Search Route', () => {
9
10
  beforeEach(async () => {
10
11
  await fastifyBefore();
11
- await fastify.register(searchRoute, { prisma, opensearch, accessTransformer: AllPublicAccessTransformer });
12
+ await fastify.register(searchRoute, {
13
+ prisma,
14
+ opensearch,
15
+ accessTransformer: AllPublicAccessTransformer,
16
+ queryBuilder: new OpensearchQueryBuilder(),
17
+ });
12
18
  });
13
19
 
14
20
  afterEach(async () => {
@@ -615,6 +621,7 @@ describe('Search Route', () => {
615
621
  opensearch,
616
622
  accessTransformer: AllPublicAccessTransformer,
617
623
  entityTransformers: [customTransformer],
624
+ queryBuilder: new OpensearchQueryBuilder(),
618
625
  });
619
626
 
620
627
  const mockEntities = [
@@ -3,12 +3,12 @@ import type { MultiBucketAggregateBaseFiltersBucket } from '@opensearch-project/
3
3
  import type { Search_Request } from '@opensearch-project/opensearch/api/index.js';
4
4
  import type { FastifyPluginAsync } from 'fastify';
5
5
  import type { ZodTypeProvider } from 'fastify-type-provider-zod';
6
- import { z } from 'zod/v4';
6
+ import { z } from 'zod';
7
7
  import type { PrismaClient } from '../generated/prisma/client.js';
8
8
  import { baseEntityTransformer, resolveEntityReferences } from '../transformers/default.js';
9
9
  import type { AccessTransformer, EntityTransformer } from '../types/transformers.js';
10
10
  import { createInternalError, createInvalidRequestError } from '../utils/errors.js';
11
- import { OpensearchQueryBuilder, type QueryBuilderOptions } from '../utils/queryBuilder.js';
11
+ import type { OpensearchQueryBuilder } from '../utils/queryBuilder.js';
12
12
 
13
13
  const boundingBoxSchema = z.object({
14
14
  topRight: z.object({
@@ -38,20 +38,11 @@ type SearchRouteOptions = {
38
38
  opensearch: Client;
39
39
  accessTransformer: AccessTransformer;
40
40
  entityTransformers?: EntityTransformer[];
41
- queryBuilderClass?: typeof OpensearchQueryBuilder;
42
- queryBuilderOptions?: QueryBuilderOptions;
41
+ queryBuilder: OpensearchQueryBuilder;
43
42
  };
44
43
 
45
44
  const search: FastifyPluginAsync<SearchRouteOptions> = async (fastify, opts) => {
46
- const {
47
- prisma,
48
- opensearch,
49
- accessTransformer,
50
- entityTransformers = [],
51
- queryBuilderClass = OpensearchQueryBuilder,
52
- queryBuilderOptions,
53
- } = opts;
54
- const queryBuilder = new queryBuilderClass(queryBuilderOptions);
45
+ const { prisma, opensearch, accessTransformer, entityTransformers = [], queryBuilder } = opts;
55
46
  fastify.withTypeProvider<ZodTypeProvider>().post(
56
47
  '/search',
57
48
  {
@@ -37,7 +37,6 @@ export async function setupIntegrationTests() {
37
37
  await fastify.register(app, {
38
38
  prisma,
39
39
  opensearch,
40
- disableCors: true,
41
40
  accessTransformer: AllPublicAccessTransformer,
42
41
  fileAccessTransformer: AllPublicFileAccessTransformer,
43
42
  fileHandler: {
@@ -31,7 +31,7 @@ const createErrorResponse = (code: ErrorCode, message: string, details?: ErrorDe
31
31
 
32
32
  type ValidationViolation = {
33
33
  field: string;
34
- message: string;
34
+ message?: string;
35
35
  value?: unknown;
36
36
  };
37
37
 
@@ -19,6 +19,20 @@ export type QueryBuilderOptions = {
19
19
  aggregations?: Aggregations;
20
20
  };
21
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
+
22
36
  export class OpensearchQueryBuilder {
23
37
  aggregations: Aggregations;
24
38
 
@@ -118,6 +132,17 @@ export class OpensearchQueryBuilder {
118
132
  return aggs;
119
133
  }
120
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
+
121
146
  buildSort(sort: string, order: SortOrder) {
122
147
  if (sort === 'relevance') {
123
148
  return;
package/dist/express.d.ts DELETED
@@ -1,4 +0,0 @@
1
- import type { Express } from 'express';
2
- import { type Options } from './app.js';
3
- declare const _default: (options: Options) => Promise<Express>;
4
- export default _default;
package/dist/express.js DELETED
@@ -1,14 +0,0 @@
1
- import express from 'express';
2
- import Fastify from 'fastify';
3
- import arocapi from './app.js';
4
- const fastify = Fastify();
5
- export default async (options) => {
6
- fastify.register(arocapi, options);
7
- await fastify.ready();
8
- const app = express();
9
- app.use(async (req, res) => {
10
- fastify.routing(req, res);
11
- });
12
- return app;
13
- };
14
- //# sourceMappingURL=express.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"express.js","sourceRoot":"","sources":["../src/express.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,OAAyB,MAAM,UAAU,CAAC;AAEjD,MAAM,OAAO,GAAG,OAAO,EAAE,CAAC;AAE1B,eAAe,KAAK,EAAE,OAAgB,EAAE,EAAE;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEnC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;IAEtB,MAAM,GAAG,GAAY,OAAO,EAAE,CAAC;IAE/B,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QACzB,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"crate.js","sourceRoot":"","sources":["../../src/routes/crate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAG3C,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAG3B,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE;CACZ,CAAC,CAAC;AAOH,MAAM,KAAK,GAA0C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IAC3E,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAExC,OAAO,CAAC,gBAAgB,EAAmB,CAAC,IAAI,CAC9C,qBAAqB,EACrB;QACE,MAAM,EAAE;YACN,MAAM,EAAE,YAAY;SACrB;KACF,EACD,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACvB,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;QAE9B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;gBAC5C,KAAK,EAAE,EAAE,EAAE,EAAE;aACd,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC7F,CAAC;YAED,MAAM,QAAQ,GAAyB,MAAM,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YAE/F,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,+CAA+C,EAAE,EAAE,CAAC,CAAC,CAAC;YACxG,CAAC;YAED,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAEhC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,GAAG,GAAG,KAAc,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,sCAAsC,GAAG,EAAE,CAAC,CAAC;YAE/D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC,CACF,CAAC;IAEF,OAAO,CAAC,gBAAgB,EAAmB,CAAC,GAAG,CAC7C,qBAAqB,EACrB;QACE,MAAM,EAAE;YACN,MAAM,EAAE,YAAY;SACrB;KACF,EACD,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACvB,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;QAE9B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;gBAC5C,KAAK,EAAE,EAAE,EAAE,EAAE;aACd,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC7F,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YAEtE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,+CAA+C,EAAE,EAAE,CAAC,CAAC,CAAC;YACxG,CAAC;YAED,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBAC/B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC9C,CAAC;YAGD,MAAM,QAAQ,GAAG;gBACf,GAAG,MAAM,CAAC,QAAQ;gBAClB,WAAW,EAAE,qBAAqB;aACnC,CAAC;YAEF,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAGhC,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC7C,CAAC;YAED,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC3B,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;oBACrB,KAAK,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;oBACnD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;gBAChC,CAAC;gBAED,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC7C,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtC,CAAC;YAGD,MAAM,IAAI,KAAK,CAAC,oCAAqC,MAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,GAAG,GAAG,KAAc,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAE9D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,KAAK,CAAC"}
package/src/express.ts DELETED
@@ -1,21 +0,0 @@
1
- import type { Express } from 'express';
2
- import express from 'express';
3
- import Fastify from 'fastify';
4
-
5
- import arocapi, { type Options } from './app.js';
6
-
7
- const fastify = Fastify();
8
-
9
- export default async (options: Options) => {
10
- fastify.register(arocapi, options);
11
-
12
- await fastify.ready();
13
-
14
- const app: Express = express();
15
-
16
- app.use(async (req, res) => {
17
- fastify.routing(req, res);
18
- });
19
-
20
- return app;
21
- };
File without changes