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.
- package/README.md +76 -33
- package/dist/app.d.ts +2 -3
- package/dist/app.js +7 -9
- package/dist/app.js.map +1 -1
- package/dist/app.test.js +0 -7
- package/dist/app.test.js.map +1 -1
- package/dist/routes/capabilities.d.ts +7 -0
- package/dist/routes/capabilities.js +13 -0
- package/dist/routes/capabilities.js.map +1 -0
- package/dist/routes/capabilities.test.d.ts +1 -0
- package/dist/routes/capabilities.test.js +81 -0
- package/dist/routes/capabilities.test.js.map +1 -0
- package/dist/routes/crate.test.js +23 -23
- package/dist/routes/crate.test.js.map +1 -1
- package/dist/routes/entities.js +1 -1
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/entity.js +1 -1
- package/dist/routes/entity.js.map +1 -1
- package/dist/routes/file.js +1 -1
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/files.js +1 -1
- package/dist/routes/files.js.map +1 -1
- package/dist/routes/{crate.js → metadata.js} +4 -4
- package/dist/routes/metadata.js.map +1 -0
- package/dist/routes/search.d.ts +2 -3
- package/dist/routes/search.js +2 -4
- package/dist/routes/search.js.map +1 -1
- package/dist/routes/search.test.js +8 -1
- package/dist/routes/search.test.js.map +1 -1
- package/dist/test/helpers/fastify.d.ts +1 -1
- package/dist/test/integration.setup.d.ts +1 -1
- package/dist/test/integration.setup.js +0 -1
- package/dist/test/integration.setup.js.map +1 -1
- package/dist/utils/errors.d.ts +7 -7
- package/dist/utils/queryBuilder.d.ts +12 -0
- package/dist/utils/queryBuilder.js +9 -0
- package/dist/utils/queryBuilder.js.map +1 -1
- package/package.json +34 -37
- package/src/app.test.ts +0 -7
- package/src/app.ts +9 -12
- package/src/routes/__snapshots__/capabilities.test.ts.snap +34 -0
- package/src/routes/capabilities.test.ts +102 -0
- package/src/routes/capabilities.ts +22 -0
- package/src/routes/crate.test.ts +23 -23
- package/src/routes/entities.ts +1 -1
- package/src/routes/entity.ts +1 -1
- package/src/routes/file.ts +1 -1
- package/src/routes/files.ts +1 -1
- package/src/routes/{crate.ts → metadata.ts} +3 -3
- package/src/routes/search.test.ts +8 -1
- package/src/routes/search.ts +4 -13
- package/src/test/integration.setup.ts +0 -1
- package/src/utils/errors.ts +1 -1
- package/src/utils/queryBuilder.ts +25 -0
- package/dist/express.d.ts +0 -4
- package/dist/express.js +0 -14
- package/dist/express.js.map +0 -1
- package/dist/routes/crate.js.map +0 -1
- package/src/express.ts +0 -21
- /package/dist/routes/{crate.d.ts → metadata.d.ts} +0 -0
package/README.md
CHANGED
|
@@ -6,8 +6,9 @@ suitable use in long-term archival repository systems that aim to follow the
|
|
|
6
6
|
Protocols for Long Term Archival Repository Services
|
|
7
7
|
[PILARS](https://w3id.org/ldac/pilars).
|
|
8
8
|
|
|
9
|
-
The library
|
|
10
|
-
Express app
|
|
9
|
+
The library is a Fastify plugin that mounts the API endpoints into your own
|
|
10
|
+
Fastify app, or into an Express app via Fastify (see
|
|
11
|
+
[Using with Express](#using-with-express)).
|
|
11
12
|
|
|
12
13
|
The aim is to provide an API-centred reference implementation of a repository
|
|
13
14
|
with an access-controlled web portal for data dissemination and deposit:
|
|
@@ -50,6 +51,8 @@ pnpm add @prisma/client @opensearch-project/opensearch
|
|
|
50
51
|
pnpm add -D prisma
|
|
51
52
|
```
|
|
52
53
|
|
|
54
|
+
Changes merged to `main` are published as prereleases under the `beta` tag: `pnpm add arocapi@beta`.
|
|
55
|
+
|
|
53
56
|
### 2. Environment Setup
|
|
54
57
|
|
|
55
58
|
Create a `.env` file in your project root:
|
|
@@ -64,11 +67,6 @@ OPENSEARCH_URL="http://localhost:9200"
|
|
|
64
67
|
|
|
65
68
|
## Creating Your API
|
|
66
69
|
|
|
67
|
-
> [!TIP]
|
|
68
|
-
> We recommend using the Fastify as it will be a native integration
|
|
69
|
-
|
|
70
|
-
### Option 1: Fastify Implementation
|
|
71
|
-
|
|
72
70
|
Create your Fastify application with Typescript support:
|
|
73
71
|
|
|
74
72
|
```typescript
|
|
@@ -136,37 +134,27 @@ try {
|
|
|
136
134
|
}
|
|
137
135
|
```
|
|
138
136
|
|
|
139
|
-
###
|
|
140
|
-
|
|
141
|
-
Create your Express application:
|
|
137
|
+
### CORS
|
|
142
138
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
import express from 'express';
|
|
148
|
-
import expressListRoutes from 'express-list-routes';
|
|
149
|
-
import { PrismaClient } from './generated/prisma/client.js';
|
|
139
|
+
arocapi doesn't set CORS headers; CORS is up to your application. To let
|
|
140
|
+
browsers on other origins call the API, register
|
|
141
|
+
[`@fastify/cors`](https://github.com/fastify/fastify-cors) on the root
|
|
142
|
+
instance:
|
|
150
143
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
throw new Error('OPENSEARCH_URL environment variable is not set');
|
|
155
|
-
}
|
|
156
|
-
const opensearchUrl = process.env.OPENSEARCH_URL;
|
|
157
|
-
const opensearch = new Client({ node: opensearchUrl });
|
|
158
|
-
|
|
159
|
-
const app = express();
|
|
144
|
+
```bash
|
|
145
|
+
pnpm add @fastify/cors
|
|
146
|
+
```
|
|
160
147
|
|
|
161
|
-
|
|
162
|
-
|
|
148
|
+
```typescript
|
|
149
|
+
import cors from '@fastify/cors';
|
|
163
150
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
console.log(`API server listening on port ${port}`);
|
|
167
|
-
});
|
|
151
|
+
fastify.register(cors);
|
|
152
|
+
fastify.register(arocapi, { /* ... */ });
|
|
168
153
|
```
|
|
169
154
|
|
|
155
|
+
The defaults allow all origins with `GET`, `HEAD` and `POST`, matching what
|
|
156
|
+
arocapi registered before 5.0.0. See the `@fastify/cors` docs to restrict them.
|
|
157
|
+
|
|
170
158
|
## Database Setup with Prisma
|
|
171
159
|
|
|
172
160
|
### 1. Initialize Prisma
|
|
@@ -219,9 +207,10 @@ npx prisma generate
|
|
|
219
207
|
|
|
220
208
|
The arocapi provides the following endpoints:
|
|
221
209
|
|
|
210
|
+
- `GET /capabilities` - Declare the spec version and supported search filters and facets (always public)
|
|
222
211
|
- `GET /entities` - List all entities with pagination and filtering
|
|
223
212
|
- `GET /entity/:id` - Get a specific entity by ID
|
|
224
|
-
- `GET /entity/:id/
|
|
213
|
+
- `GET /entity/:id/metadata` - Download RO-Crate metadata
|
|
225
214
|
- `GET /files` - List files with pagination and filtering
|
|
226
215
|
- `GET /file/:id` - Download or access file content
|
|
227
216
|
- `POST /search` - Search entities using OpenSearch
|
|
@@ -242,6 +231,27 @@ may override any or all of the methods as required:
|
|
|
242
231
|
- `buildQuery`: For generating the base search query.
|
|
243
232
|
- `buildAggregations`: For generating the facets or aggregations related query.
|
|
244
233
|
- `buildSort`: For generating the ordering/sorting part of the query.
|
|
234
|
+
- `searchCapabilities`: For declaring the search filters and facets in `GET /capabilities`.
|
|
235
|
+
|
|
236
|
+
By default `searchCapabilities` declares each `terms` aggregation as a `string`
|
|
237
|
+
filter and a facet. Other aggregation types are not declared. Override it to add
|
|
238
|
+
labels or declare filter-only fields:
|
|
239
|
+
|
|
240
|
+
```typescript
|
|
241
|
+
import { OpensearchQueryBuilder, type SearchCapability } from 'arocapi';
|
|
242
|
+
|
|
243
|
+
class MyQueryBuilder extends OpensearchQueryBuilder {
|
|
244
|
+
searchCapabilities(): SearchCapability {
|
|
245
|
+
return {
|
|
246
|
+
filters: {
|
|
247
|
+
inLanguage: { type: 'string', label: 'Language' },
|
|
248
|
+
dateCreated: { type: 'date', label: 'Date created' },
|
|
249
|
+
},
|
|
250
|
+
facets: { inLanguage: { label: 'Language' } },
|
|
251
|
+
};
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
```
|
|
245
255
|
|
|
246
256
|
### Query Builder Options (Optional)
|
|
247
257
|
The `queryBuilderOptions` optional parameter is passed as a constructor argument
|
|
@@ -712,6 +722,39 @@ await prisma.entity.create({
|
|
|
712
722
|
|
|
713
723
|
Your file handler can use this metadata to locate files in your storage system.
|
|
714
724
|
|
|
725
|
+
## Using with Express
|
|
726
|
+
|
|
727
|
+
arocapi doesn't ship an Express adapter, but you can register the plugin on a
|
|
728
|
+
Fastify instance and forward requests to it. Install `express` in your app
|
|
729
|
+
first.
|
|
730
|
+
|
|
731
|
+
```typescript
|
|
732
|
+
// src/index.ts
|
|
733
|
+
import arocapi, { type Options } from 'arocapi';
|
|
734
|
+
import express from 'express';
|
|
735
|
+
import Fastify from 'fastify';
|
|
736
|
+
|
|
737
|
+
const options: Options = {
|
|
738
|
+
// Same options as passed to fastify.register in Creating Your API
|
|
739
|
+
};
|
|
740
|
+
|
|
741
|
+
const fastify = Fastify({
|
|
742
|
+
logger: true,
|
|
743
|
+
});
|
|
744
|
+
fastify.register(arocapi, options);
|
|
745
|
+
await fastify.ready();
|
|
746
|
+
|
|
747
|
+
const app = express();
|
|
748
|
+
app.use('/api', (req, res) => {
|
|
749
|
+
fastify.routing(req, res);
|
|
750
|
+
});
|
|
751
|
+
|
|
752
|
+
const port = process.env.PORT || 3000;
|
|
753
|
+
app.listen(port, () => {
|
|
754
|
+
console.log(`API server listening on port ${port}`);
|
|
755
|
+
});
|
|
756
|
+
```
|
|
757
|
+
|
|
715
758
|
## Development Workflow
|
|
716
759
|
|
|
717
760
|
### Local Development Setup
|
package/dist/app.d.ts
CHANGED
|
@@ -3,20 +3,19 @@ import type { FastifyPluginAsync } from 'fastify';
|
|
|
3
3
|
import type { PrismaClient } from './generated/prisma/client.js';
|
|
4
4
|
import type { FileHandler, RoCrateHandler } from './types/fileHandlers.js';
|
|
5
5
|
import type { AccessTransformer, EntityTransformer, FileAccessTransformer, FileTransformer } from './types/transformers.js';
|
|
6
|
-
import type { QueryBuilderOptions } from './utils/queryBuilder.js';
|
|
6
|
+
import type { FacetCapability, FilterCapability, QueryBuilderOptions, SearchCapability } from './utils/queryBuilder.js';
|
|
7
7
|
import { OpensearchQueryBuilder } from './utils/queryBuilder.js';
|
|
8
8
|
export type { AuthorisedEntity, AuthorisedFile, StandardEntity, StandardFile } from './transformers/default.js';
|
|
9
9
|
export { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from './transformers/default.js';
|
|
10
10
|
export type { FileHandler, FileHandlerContext, FileMetadata, FilePathResult, FileRedirectResult, FileResult, FileStreamResult, GetFileHandler, GetRoCrateHandler, HeadFileHandler, HeadRoCrateHandler, RoCrateHandler, } from './types/fileHandlers.js';
|
|
11
11
|
export type { AccessTransformer, EntityTransformer, FileAccessTransformer, FileTransformer, TransformerContext, } from './types/transformers.js';
|
|
12
|
-
export type { QueryBuilderOptions };
|
|
12
|
+
export type { FacetCapability, FilterCapability, QueryBuilderOptions, SearchCapability };
|
|
13
13
|
export { OpensearchQueryBuilder };
|
|
14
14
|
export type Options = {
|
|
15
15
|
prisma: PrismaClient;
|
|
16
16
|
opensearch: Client;
|
|
17
17
|
queryBuilderClass?: typeof OpensearchQueryBuilder;
|
|
18
18
|
queryBuilderOptions?: QueryBuilderOptions;
|
|
19
|
-
disableCors?: boolean;
|
|
20
19
|
accessTransformer: AccessTransformer;
|
|
21
20
|
entityTransformers?: EntityTransformer[];
|
|
22
21
|
fileAccessTransformer: FileAccessTransformer;
|
package/dist/app.js
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import cors from '@fastify/cors';
|
|
2
1
|
import sensible from '@fastify/sensible';
|
|
3
2
|
import { hasZodFastifySchemaValidationErrors, serializerCompiler, validatorCompiler } from 'fastify-type-provider-zod';
|
|
4
|
-
import
|
|
3
|
+
import capabilities from './routes/capabilities.js';
|
|
5
4
|
import entities from './routes/entities.js';
|
|
6
5
|
import entity from './routes/entity.js';
|
|
7
6
|
import file from './routes/file.js';
|
|
8
7
|
import files from './routes/files.js';
|
|
8
|
+
import metadata from './routes/metadata.js';
|
|
9
9
|
import search from './routes/search.js';
|
|
10
10
|
import { createValidationError } from './utils/errors.js';
|
|
11
11
|
import { OpensearchQueryBuilder } from './utils/queryBuilder.js';
|
|
@@ -27,7 +27,7 @@ const setupValidation = (fastify) => {
|
|
|
27
27
|
});
|
|
28
28
|
};
|
|
29
29
|
const app = async (fastify, options) => {
|
|
30
|
-
const { prisma, opensearch, queryBuilderClass, queryBuilderOptions,
|
|
30
|
+
const { prisma, opensearch, queryBuilderClass, queryBuilderOptions, accessTransformer, entityTransformers, fileAccessTransformer, fileTransformers, fileHandler, roCrateHandler, } = options;
|
|
31
31
|
if (!prisma) {
|
|
32
32
|
throw new Error('Prisma client is required');
|
|
33
33
|
}
|
|
@@ -47,22 +47,20 @@ const app = async (fastify, options) => {
|
|
|
47
47
|
throw new Error('roCrateHandler is required');
|
|
48
48
|
}
|
|
49
49
|
fastify.register(sensible);
|
|
50
|
-
if (!disableCors) {
|
|
51
|
-
fastify.register(cors);
|
|
52
|
-
}
|
|
53
50
|
setupValidation(fastify);
|
|
51
|
+
const queryBuilder = new (queryBuilderClass ?? OpensearchQueryBuilder)(queryBuilderOptions);
|
|
52
|
+
fastify.register(capabilities, { queryBuilder });
|
|
54
53
|
fastify.register(entities, { prisma, accessTransformer, entityTransformers });
|
|
55
54
|
fastify.register(entity, { prisma, accessTransformer, entityTransformers });
|
|
56
55
|
fastify.register(files, { prisma, fileAccessTransformer, fileTransformers });
|
|
57
56
|
fastify.register(file, { prisma, fileHandler });
|
|
58
|
-
fastify.register(
|
|
57
|
+
fastify.register(metadata, { prisma, roCrateHandler });
|
|
59
58
|
fastify.register(search, {
|
|
60
59
|
prisma,
|
|
61
60
|
opensearch,
|
|
62
61
|
accessTransformer,
|
|
63
62
|
entityTransformers,
|
|
64
|
-
|
|
65
|
-
queryBuilderOptions,
|
|
63
|
+
queryBuilder,
|
|
66
64
|
});
|
|
67
65
|
};
|
|
68
66
|
export default app;
|
package/dist/app.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAGzC,OAAO,EAAE,mCAAmC,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAEvH,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,IAAI,MAAM,kBAAkB,CAAC;AACpC,OAAO,KAAK,MAAM,mBAAmB,CAAC;AACtC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,MAAM,MAAM,oBAAoB,CAAC;AAQxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAGjE,OAAO,EAAE,0BAA0B,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAuBvG,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAElC,MAAM,eAAe,GAAG,CAAC,OAAwB,EAAE,EAAE;IACnD,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAChD,OAAO,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAElD,OAAO,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;QAE7C,IAAI,mCAAmC,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC9C,KAAK,EAAE,CAAC,CAAC,YAAY;gBACrB,OAAO,EAAE,CAAC,CAAC,OAAO;aACnB,CAAC,CAAC,CAAC;YAEJ,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,oCAAoC,EAAE,UAAU,CAAC,CAAC,CAAC;QACvG,CAAC;QAKD,MAAM,GAAG,GAAG,KAAc,CAAC;QAC3B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,uBAAuB,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IAExF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAcF,MAAM,GAAG,GAAgC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;IAClE,MAAM,EACJ,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,WAAW,EACX,cAAc,GACf,GAAG,OAAO,CAAC;IAEZ,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC3B,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,IAAI,sBAAsB,CAAC,CAAC,mBAAmB,CAAC,CAAC;IAE5F,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IACjD,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC9E,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC5E,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC7E,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;IACvD,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE;QACvB,MAAM;QACN,UAAU;QACV,iBAAiB;QACjB,kBAAkB;QAClB,YAAY;KACb,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,GAAG,CAAC"}
|
package/dist/app.test.js
CHANGED
|
@@ -13,7 +13,6 @@ describe('Entity Route', () => {
|
|
|
13
13
|
const fastify = Fastify({ logger: false });
|
|
14
14
|
fastify.register(app, {
|
|
15
15
|
opensearch,
|
|
16
|
-
disableCors: false,
|
|
17
16
|
});
|
|
18
17
|
await expect(() => fastify.ready()).rejects.toThrowError('Prisma client is required');
|
|
19
18
|
});
|
|
@@ -21,7 +20,6 @@ describe('Entity Route', () => {
|
|
|
21
20
|
const fastify = Fastify({ logger: false });
|
|
22
21
|
fastify.register(app, {
|
|
23
22
|
prisma,
|
|
24
|
-
disableCors: false,
|
|
25
23
|
});
|
|
26
24
|
await expect(() => fastify.ready()).rejects.toThrowError('OpenSearch client is required');
|
|
27
25
|
});
|
|
@@ -30,7 +28,6 @@ describe('Entity Route', () => {
|
|
|
30
28
|
fastify.register(app, {
|
|
31
29
|
prisma,
|
|
32
30
|
opensearch,
|
|
33
|
-
disableCors: false,
|
|
34
31
|
});
|
|
35
32
|
await expect(() => fastify.ready()).rejects.toThrowError('accessTransformer is required');
|
|
36
33
|
});
|
|
@@ -39,7 +36,6 @@ describe('Entity Route', () => {
|
|
|
39
36
|
fastify.register(app, {
|
|
40
37
|
prisma,
|
|
41
38
|
opensearch,
|
|
42
|
-
disableCors: false,
|
|
43
39
|
accessTransformer: AllPublicAccessTransformer,
|
|
44
40
|
});
|
|
45
41
|
await expect(() => fastify.ready()).rejects.toThrowError('fileAccessTransformer is required');
|
|
@@ -49,7 +45,6 @@ describe('Entity Route', () => {
|
|
|
49
45
|
fastify.register(app, {
|
|
50
46
|
prisma,
|
|
51
47
|
opensearch,
|
|
52
|
-
disableCors: false,
|
|
53
48
|
accessTransformer: AllPublicAccessTransformer,
|
|
54
49
|
fileAccessTransformer: AllPublicFileAccessTransformer,
|
|
55
50
|
});
|
|
@@ -60,7 +55,6 @@ describe('Entity Route', () => {
|
|
|
60
55
|
fastify.register(app, {
|
|
61
56
|
prisma,
|
|
62
57
|
opensearch,
|
|
63
|
-
disableCors: false,
|
|
64
58
|
accessTransformer: AllPublicAccessTransformer,
|
|
65
59
|
fileAccessTransformer: AllPublicFileAccessTransformer,
|
|
66
60
|
fileHandler: {
|
|
@@ -75,7 +69,6 @@ describe('Entity Route', () => {
|
|
|
75
69
|
await fastify.register(app, {
|
|
76
70
|
prisma,
|
|
77
71
|
opensearch,
|
|
78
|
-
disableCors: false,
|
|
79
72
|
accessTransformer: AllPublicAccessTransformer,
|
|
80
73
|
fileAccessTransformer: AllPublicFileAccessTransformer,
|
|
81
74
|
fileHandler: { get: vi.fn(), head: vi.fn() },
|
package/dist/app.test.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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;AAEjD,OAAO,GAAG,EAAE,EAAE,0BAA0B,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAE3F,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,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,UAAU;
|
|
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;AAEjD,OAAO,GAAG,EAAE,EAAE,0BAA0B,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAE3F,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,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,UAAU;aACX,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;YAChD,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;aACP,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,+BAA+B,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;gBACN,UAAU;aACX,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,+BAA+B,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;gBACN,UAAU;gBACV,iBAAiB,EAAE,0BAA0B;aAC9C,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,mCAAmC,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;gBACN,UAAU;gBACV,iBAAiB,EAAE,0BAA0B;gBAC7C,qBAAqB,EAAE,8BAA8B;aACtD,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,yBAAyB,CAAC,CAAC;QACtF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YACpD,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,MAAM;gBACN,UAAU;gBACV,iBAAiB,EAAE,0BAA0B;gBAC7C,qBAAqB,EAAE,8BAA8B;gBACrD,WAAW,EAAE;oBACX,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;oBACZ,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE;iBACd;aACF,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;QACzF,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;gBAC1B,MAAM;gBACN,UAAU;gBACV,iBAAiB,EAAE,0BAA0B;gBAC7C,qBAAqB,EAAE,8BAA8B;gBACrD,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;gBAC5C,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;aAChD,CAAC,CAAC;YAEH,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"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { FastifyPluginAsync } from 'fastify';
|
|
2
|
+
import type { OpensearchQueryBuilder } from '../utils/queryBuilder.js';
|
|
3
|
+
type CapabilitiesRouteOptions = {
|
|
4
|
+
queryBuilder: OpensearchQueryBuilder;
|
|
5
|
+
};
|
|
6
|
+
declare const capabilities: FastifyPluginAsync<CapabilitiesRouteOptions>;
|
|
7
|
+
export default capabilities;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
const SPEC_VERSION = '0.4.0';
|
|
2
|
+
const capabilities = async (fastify, opts) => {
|
|
3
|
+
const document = {
|
|
4
|
+
apiVersion: SPEC_VERSION,
|
|
5
|
+
deposit: { supported: false },
|
|
6
|
+
tombstonePolicy: '404',
|
|
7
|
+
extensions: {},
|
|
8
|
+
search: opts.queryBuilder.searchCapabilities(),
|
|
9
|
+
};
|
|
10
|
+
fastify.get('/capabilities', async () => document);
|
|
11
|
+
};
|
|
12
|
+
export default capabilities;
|
|
13
|
+
//# sourceMappingURL=capabilities.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"capabilities.js","sourceRoot":"","sources":["../../src/routes/capabilities.ts"],"names":[],"mappings":"AAGA,MAAM,YAAY,GAAG,OAAO,CAAC;AAM7B,MAAM,YAAY,GAAiD,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IACzF,MAAM,QAAQ,GAAG;QACf,UAAU,EAAE,YAAY;QACxB,OAAO,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;QAC7B,eAAe,EAAE,KAAK;QACtB,UAAU,EAAE,EAAE;QACd,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE;KAC/C,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,eAAe,YAAY,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { afterEach, describe, expect, it, vi } from 'vitest';
|
|
2
|
+
import app, { AllPublicFileAccessTransformer } from '../app.js';
|
|
3
|
+
import { fastify, fastifyAfter, fastifyBefore, opensearch, prisma } from '../test/helpers/fastify.js';
|
|
4
|
+
import { AllPublicAccessTransformer } from '../transformers/default.js';
|
|
5
|
+
import { OpensearchQueryBuilder } from '../utils/queryBuilder.js';
|
|
6
|
+
const registerApp = async (options = {}) => {
|
|
7
|
+
await fastifyBefore();
|
|
8
|
+
await fastify.register(app, {
|
|
9
|
+
prisma,
|
|
10
|
+
opensearch,
|
|
11
|
+
accessTransformer: AllPublicAccessTransformer,
|
|
12
|
+
fileAccessTransformer: AllPublicFileAccessTransformer,
|
|
13
|
+
fileHandler: { get: vi.fn(), head: vi.fn() },
|
|
14
|
+
roCrateHandler: { get: vi.fn(), head: vi.fn() },
|
|
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 transformer', async () => {
|
|
71
|
+
const accessTransformer = vi.fn(() => {
|
|
72
|
+
throw new Error('Unauthorised');
|
|
73
|
+
});
|
|
74
|
+
await registerApp({ accessTransformer });
|
|
75
|
+
const { statusCode } = await getCapabilities();
|
|
76
|
+
expect(statusCode).toBe(200);
|
|
77
|
+
expect(accessTransformer).not.toHaveBeenCalled();
|
|
78
|
+
});
|
|
79
|
+
});
|
|
80
|
+
});
|
|
81
|
+
//# sourceMappingURL=capabilities.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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,8BAA8B,EAAgB,MAAM,WAAW,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACtG,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AACxE,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,iBAAiB,EAAE,0BAA0B;QAC7C,qBAAqB,EAAE,8BAA8B;QACrD,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,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,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,iBAAiB,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE;gBACnC,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;YAClC,CAAC,CAAC,CAAC;YAEH,MAAM,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAEzC,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,eAAe,EAAE,CAAC;YAE/C,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7B,MAAM,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -2,7 +2,7 @@ import { createReadStream } from 'node:fs';
|
|
|
2
2
|
import { Readable } from 'node:stream';
|
|
3
3
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
4
4
|
import { fastify, fastifyAfter, fastifyBefore, prisma } from '../test/helpers/fastify.js';
|
|
5
|
-
import
|
|
5
|
+
import metadataRoute from './metadata.js';
|
|
6
6
|
vi.mock('node:fs', () => ({
|
|
7
7
|
createReadStream: vi.fn(),
|
|
8
8
|
}));
|
|
@@ -13,7 +13,7 @@ describe('Crate Route', () => {
|
|
|
13
13
|
};
|
|
14
14
|
beforeEach(async () => {
|
|
15
15
|
await fastifyBefore();
|
|
16
|
-
await fastify.register(
|
|
16
|
+
await fastify.register(metadataRoute, { prisma, roCrateHandler: mockRoCrateHandler });
|
|
17
17
|
vi.clearAllMocks();
|
|
18
18
|
});
|
|
19
19
|
afterEach(async () => {
|
|
@@ -48,7 +48,7 @@ describe('Crate Route', () => {
|
|
|
48
48
|
memberOf: 'http://example.com/collection',
|
|
49
49
|
rootCollection: 'http://example.com/collection',
|
|
50
50
|
};
|
|
51
|
-
describe('GET /entity/:id/
|
|
51
|
+
describe('GET /entity/:id/metadata', () => {
|
|
52
52
|
it('should stream RO-Crate metadata for File entity', async () => {
|
|
53
53
|
prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
|
|
54
54
|
const mockStream = Readable.from(['{"@context": "https://w3id.org/ro/crate/1.1/context"}']);
|
|
@@ -65,7 +65,7 @@ describe('Crate Route', () => {
|
|
|
65
65
|
vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
|
|
66
66
|
const response = await fastify.inject({
|
|
67
67
|
method: 'GET',
|
|
68
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
68
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
69
69
|
});
|
|
70
70
|
expect(response.statusCode).toBe(200);
|
|
71
71
|
expect(response.headers['content-type']).toBe('application/ld+json');
|
|
@@ -91,7 +91,7 @@ describe('Crate Route', () => {
|
|
|
91
91
|
vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
|
|
92
92
|
const response = await fastify.inject({
|
|
93
93
|
method: 'GET',
|
|
94
|
-
url: `/entity/${encodeURIComponent('http://example.com/collection')}/
|
|
94
|
+
url: `/entity/${encodeURIComponent('http://example.com/collection')}/metadata`,
|
|
95
95
|
});
|
|
96
96
|
expect(response.statusCode).toBe(200);
|
|
97
97
|
expect(response.headers['content-type']).toBe('application/ld+json');
|
|
@@ -111,7 +111,7 @@ describe('Crate Route', () => {
|
|
|
111
111
|
vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
|
|
112
112
|
const response = await fastify.inject({
|
|
113
113
|
method: 'GET',
|
|
114
|
-
url: `/entity/${encodeURIComponent('http://example.com/object')}/
|
|
114
|
+
url: `/entity/${encodeURIComponent('http://example.com/object')}/metadata`,
|
|
115
115
|
});
|
|
116
116
|
expect(response.statusCode).toBe(200);
|
|
117
117
|
expect(response.headers['content-type']).toBe('application/ld+json');
|
|
@@ -126,7 +126,7 @@ describe('Crate Route', () => {
|
|
|
126
126
|
vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
|
|
127
127
|
const response = await fastify.inject({
|
|
128
128
|
method: 'GET',
|
|
129
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
129
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
130
130
|
});
|
|
131
131
|
expect(response.statusCode).toBe(302);
|
|
132
132
|
expect(response.headers.location).toBe('https://storage.example.com/ro-crate-metadata.json');
|
|
@@ -146,7 +146,7 @@ describe('Crate Route', () => {
|
|
|
146
146
|
vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
|
|
147
147
|
const response = await fastify.inject({
|
|
148
148
|
method: 'GET',
|
|
149
|
-
url: `/entity/${encodeURIComponent('http://example.com/collection')}/
|
|
149
|
+
url: `/entity/${encodeURIComponent('http://example.com/collection')}/metadata`,
|
|
150
150
|
});
|
|
151
151
|
expect(response.statusCode).toBe(200);
|
|
152
152
|
expect(response.headers['content-type']).toBe('application/ld+json');
|
|
@@ -168,7 +168,7 @@ describe('Crate Route', () => {
|
|
|
168
168
|
vi.mocked(mockRoCrateHandler.get).mockResolvedValue(mockResult);
|
|
169
169
|
const response = await fastify.inject({
|
|
170
170
|
method: 'GET',
|
|
171
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
171
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
172
172
|
});
|
|
173
173
|
expect(response.statusCode).toBe(200);
|
|
174
174
|
expect(response.headers['content-type']).toBe('application/ld+json');
|
|
@@ -179,7 +179,7 @@ describe('Crate Route', () => {
|
|
|
179
179
|
prisma.entity.findUnique.mockResolvedValue(null);
|
|
180
180
|
const response = await fastify.inject({
|
|
181
181
|
method: 'GET',
|
|
182
|
-
url: `/entity/${encodeURIComponent('http://example.com/nonexistent')}/
|
|
182
|
+
url: `/entity/${encodeURIComponent('http://example.com/nonexistent')}/metadata`,
|
|
183
183
|
});
|
|
184
184
|
const body = JSON.parse(response.body);
|
|
185
185
|
expect(response.statusCode).toBe(404);
|
|
@@ -192,7 +192,7 @@ describe('Crate Route', () => {
|
|
|
192
192
|
vi.mocked(mockRoCrateHandler.get).mockResolvedValue(false);
|
|
193
193
|
const response = await fastify.inject({
|
|
194
194
|
method: 'GET',
|
|
195
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
195
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
196
196
|
});
|
|
197
197
|
const body = JSON.parse(response.body);
|
|
198
198
|
expect(response.statusCode).toBe(404);
|
|
@@ -203,7 +203,7 @@ describe('Crate Route', () => {
|
|
|
203
203
|
prisma.entity.findUnique.mockRejectedValue(new Error('Database connection failed'));
|
|
204
204
|
const response = await fastify.inject({
|
|
205
205
|
method: 'GET',
|
|
206
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
206
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
207
207
|
});
|
|
208
208
|
const body = JSON.parse(response.body);
|
|
209
209
|
expect(response.statusCode).toBe(500);
|
|
@@ -214,7 +214,7 @@ describe('Crate Route', () => {
|
|
|
214
214
|
vi.mocked(mockRoCrateHandler.get).mockRejectedValue(new Error('RO-Crate error'));
|
|
215
215
|
const response = await fastify.inject({
|
|
216
216
|
method: 'GET',
|
|
217
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
217
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
218
218
|
});
|
|
219
219
|
const body = JSON.parse(response.body);
|
|
220
220
|
expect(response.statusCode).toBe(500);
|
|
@@ -223,14 +223,14 @@ describe('Crate Route', () => {
|
|
|
223
223
|
it('should validate ID parameter format', async () => {
|
|
224
224
|
const response = await fastify.inject({
|
|
225
225
|
method: 'GET',
|
|
226
|
-
url: '/entity/invalid-id/
|
|
226
|
+
url: '/entity/invalid-id/metadata',
|
|
227
227
|
});
|
|
228
228
|
const body = JSON.parse(response.body);
|
|
229
229
|
expect(response.statusCode).toBe(400);
|
|
230
230
|
expect(body.error).toBe('Bad Request');
|
|
231
231
|
});
|
|
232
232
|
});
|
|
233
|
-
describe('HEAD /entity/:id/
|
|
233
|
+
describe('HEAD /entity/:id/metadata', () => {
|
|
234
234
|
it('should return RO-Crate metadata headers for File entity', async () => {
|
|
235
235
|
prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
|
|
236
236
|
const mockMetadata = {
|
|
@@ -242,7 +242,7 @@ describe('Crate Route', () => {
|
|
|
242
242
|
vi.mocked(mockRoCrateHandler.head).mockResolvedValue(mockMetadata);
|
|
243
243
|
const response = await fastify.inject({
|
|
244
244
|
method: 'HEAD',
|
|
245
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
245
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
246
246
|
});
|
|
247
247
|
expect(response.statusCode).toBe(200);
|
|
248
248
|
expect(response.headers['content-type']).toBe('application/ld+json');
|
|
@@ -263,7 +263,7 @@ describe('Crate Route', () => {
|
|
|
263
263
|
vi.mocked(mockRoCrateHandler.head).mockResolvedValue(mockMetadata);
|
|
264
264
|
const response = await fastify.inject({
|
|
265
265
|
method: 'HEAD',
|
|
266
|
-
url: `/entity/${encodeURIComponent('http://example.com/collection')}/
|
|
266
|
+
url: `/entity/${encodeURIComponent('http://example.com/collection')}/metadata`,
|
|
267
267
|
});
|
|
268
268
|
expect(response.statusCode).toBe(200);
|
|
269
269
|
expect(response.headers['content-type']).toBe('text/plain');
|
|
@@ -279,7 +279,7 @@ describe('Crate Route', () => {
|
|
|
279
279
|
vi.mocked(mockRoCrateHandler.head).mockResolvedValue(mockMetadata);
|
|
280
280
|
const response = await fastify.inject({
|
|
281
281
|
method: 'HEAD',
|
|
282
|
-
url: `/entity/${encodeURIComponent('http://example.com/object')}/
|
|
282
|
+
url: `/entity/${encodeURIComponent('http://example.com/object')}/metadata`,
|
|
283
283
|
});
|
|
284
284
|
expect(response.statusCode).toBe(200);
|
|
285
285
|
expect(response.headers['content-type']).toBe('application/json');
|
|
@@ -290,7 +290,7 @@ describe('Crate Route', () => {
|
|
|
290
290
|
prisma.entity.findUnique.mockResolvedValue(null);
|
|
291
291
|
const response = await fastify.inject({
|
|
292
292
|
method: 'HEAD',
|
|
293
|
-
url: `/entity/${encodeURIComponent('http://example.com/nonexistent')}/
|
|
293
|
+
url: `/entity/${encodeURIComponent('http://example.com/nonexistent')}/metadata`,
|
|
294
294
|
});
|
|
295
295
|
const body = JSON.parse(response.body);
|
|
296
296
|
expect(response.statusCode).toBe(404);
|
|
@@ -302,7 +302,7 @@ describe('Crate Route', () => {
|
|
|
302
302
|
vi.mocked(mockRoCrateHandler.head).mockResolvedValue(false);
|
|
303
303
|
const response = await fastify.inject({
|
|
304
304
|
method: 'HEAD',
|
|
305
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
305
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
306
306
|
});
|
|
307
307
|
const body = JSON.parse(response.body);
|
|
308
308
|
expect(response.statusCode).toBe(404);
|
|
@@ -314,14 +314,14 @@ describe('Crate Route', () => {
|
|
|
314
314
|
vi.mocked(mockRoCrateHandler.head).mockRejectedValue(new Error('Metadata error'));
|
|
315
315
|
const response = await fastify.inject({
|
|
316
316
|
method: 'HEAD',
|
|
317
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
317
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
318
318
|
});
|
|
319
319
|
const body = JSON.parse(response.body);
|
|
320
320
|
expect(response.statusCode).toBe(500);
|
|
321
321
|
expect(body.error.code).toBe('INTERNAL_ERROR');
|
|
322
322
|
});
|
|
323
323
|
});
|
|
324
|
-
describe('GET /entity/:id/
|
|
324
|
+
describe('GET /entity/:id/metadata - exhaustiveness check', () => {
|
|
325
325
|
it('should handle unexpected RO-Crate result type', async () => {
|
|
326
326
|
prisma.entity.findUnique.mockResolvedValue(mockFileEntity);
|
|
327
327
|
const invalidResult = {
|
|
@@ -331,7 +331,7 @@ describe('Crate Route', () => {
|
|
|
331
331
|
vi.mocked(mockRoCrateHandler.get).mockResolvedValue(invalidResult);
|
|
332
332
|
const response = await fastify.inject({
|
|
333
333
|
method: 'GET',
|
|
334
|
-
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/
|
|
334
|
+
url: `/entity/${encodeURIComponent('http://example.com/entity/file.wav')}/metadata`,
|
|
335
335
|
});
|
|
336
336
|
const body = JSON.parse(response.body);
|
|
337
337
|
expect(response.statusCode).toBe(500);
|