arocapi 5.0.0-beta.5 → 5.0.0-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +1 -1
- package/README.md +2 -2
- package/dist/app.d.ts +22 -17
- package/dist/app.js +22 -16
- package/dist/app.js.map +1 -1
- package/dist/routes/capabilities.d.ts +2 -2
- package/dist/routes/capabilities.js +2 -2
- package/dist/routes/capabilities.js.map +1 -1
- package/dist/routes/entities.js +8 -9
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/file.d.ts +2 -2
- package/dist/routes/file.js +25 -72
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/metadata.d.ts +5 -5
- package/dist/routes/metadata.js +22 -61
- package/dist/routes/metadata.js.map +1 -1
- package/dist/routes/search.d.ts +2 -4
- package/dist/routes/search.js +75 -97
- package/dist/routes/search.js.map +1 -1
- package/dist/search/advanced.d.ts +8 -0
- package/dist/search/advanced.js +198 -0
- package/dist/search/advanced.js.map +1 -0
- package/dist/search/backend.d.ts +95 -0
- package/dist/search/backend.js +5 -0
- package/dist/search/backend.js.map +1 -0
- package/dist/search/fields.d.ts +63 -0
- package/dist/search/fields.js +203 -0
- package/dist/search/fields.js.map +1 -0
- package/dist/search/opensearch/advanced.d.ts +4 -0
- package/dist/search/opensearch/advanced.js +28 -0
- package/dist/search/opensearch/advanced.js.map +1 -0
- package/dist/search/opensearch/opensearch.d.ts +16 -0
- package/dist/search/opensearch/opensearch.js +187 -0
- package/dist/search/opensearch/opensearch.js.map +1 -0
- package/dist/search/opensearch/visibility.d.ts +3 -0
- package/dist/search/opensearch/visibility.js +27 -0
- package/dist/search/opensearch/visibility.js.map +1 -0
- package/dist/search/postgres/advanced.d.ts +7 -0
- package/dist/search/postgres/advanced.js +54 -0
- package/dist/search/postgres/advanced.js.map +1 -0
- package/dist/search/postgres/facets.d.ts +2 -0
- package/dist/search/postgres/facets.js +27 -0
- package/dist/search/postgres/facets.js.map +1 -0
- package/dist/search/postgres/geo.d.ts +6 -0
- package/dist/search/postgres/geo.js +42 -0
- package/dist/search/postgres/geo.js.map +1 -0
- package/dist/search/postgres/postgres.d.ts +19 -0
- package/dist/search/postgres/postgres.js +157 -0
- package/dist/search/postgres/postgres.js.map +1 -0
- package/dist/search/postgres/values.d.ts +8 -0
- package/dist/search/postgres/values.js +20 -0
- package/dist/search/postgres/values.js.map +1 -0
- package/dist/search/postgres/visibility.d.ts +4 -0
- package/dist/search/postgres/visibility.js +38 -0
- package/dist/search/postgres/visibility.js.map +1 -0
- package/dist/search/requestFilters.d.ts +39 -0
- package/dist/search/requestFilters.js +125 -0
- package/dist/search/requestFilters.js.map +1 -0
- package/dist/search/visibility.d.ts +51 -0
- package/dist/search/visibility.js +100 -0
- package/dist/search/visibility.js.map +1 -0
- package/dist/storage/backend.d.ts +58 -0
- package/dist/storage/backend.js +2 -0
- package/dist/storage/backend.js.map +1 -0
- package/dist/storage/deliver.d.ts +12 -0
- package/dist/storage/deliver.js +34 -0
- package/dist/storage/deliver.js.map +1 -0
- package/dist/storage/directory/directory.d.ts +6 -0
- package/dist/storage/directory/directory.js +24 -0
- package/dist/storage/directory/directory.js.map +1 -0
- package/dist/storage/entity-meta/entity-meta.d.ts +5 -0
- package/dist/storage/entity-meta/entity-meta.js +14 -0
- package/dist/storage/entity-meta/entity-meta.js.map +1 -0
- package/dist/storage/location.d.ts +20 -0
- package/dist/storage/location.js +40 -0
- package/dist/storage/location.js.map +1 -0
- package/dist/storage/ocfl/ocfl.d.ts +7 -0
- package/dist/storage/ocfl/ocfl.js +79 -0
- package/dist/storage/ocfl/ocfl.js.map +1 -0
- package/dist/storage/ocfl/ocflFs.d.ts +7 -0
- package/dist/storage/ocfl/ocflFs.js +33 -0
- package/dist/storage/ocfl/ocflFs.js.map +1 -0
- package/dist/storage/results.d.ts +7 -0
- package/dist/storage/results.js +22 -0
- package/dist/storage/results.js.map +1 -0
- package/dist/storage/s3/s3.d.ts +10 -0
- package/dist/storage/s3/s3.js +47 -0
- package/dist/storage/s3/s3.js.map +1 -0
- package/dist/types/visibility.d.ts +3 -2
- package/dist/utils/visibility.js +1 -1
- package/dist/utils/visibility.js.map +1 -1
- package/package.json +66 -26
- package/prisma/models/entity.prisma +9 -8
- package/prisma/models/entitySearch.prisma +21 -0
- package/prisma/models/file.prisma +3 -3
- package/src/app.ts +85 -48
- package/src/routes/capabilities.ts +4 -4
- package/src/routes/entities.ts +10 -9
- package/src/routes/file.ts +23 -99
- package/src/routes/metadata.ts +24 -86
- package/src/routes/search.ts +104 -118
- package/src/search/advanced.ts +258 -0
- package/src/search/backend.ts +91 -0
- package/src/search/fields.ts +320 -0
- package/src/search/opensearch/advanced.ts +36 -0
- package/src/search/opensearch/opensearch.ts +290 -0
- package/src/search/opensearch/visibility.ts +38 -0
- package/src/search/postgres/advanced.ts +76 -0
- package/src/search/postgres/facets.ts +34 -0
- package/src/search/postgres/geo.ts +58 -0
- package/src/search/postgres/postgres.ts +232 -0
- package/src/search/postgres/values.ts +33 -0
- package/src/search/postgres/visibility.ts +54 -0
- package/src/search/requestFilters.ts +178 -0
- package/src/search/visibility.ts +193 -0
- package/src/storage/backend.ts +75 -0
- package/src/storage/deliver.ts +65 -0
- package/src/storage/directory/directory.ts +39 -0
- package/src/storage/entity-meta/entity-meta.ts +25 -0
- package/src/storage/location.ts +85 -0
- package/src/storage/ocfl/ocfl.ts +129 -0
- package/src/storage/ocfl/ocflFs.ts +67 -0
- package/src/storage/results.ts +32 -0
- package/src/storage/s3/s3.ts +79 -0
- package/src/types/visibility.ts +6 -3
- package/src/utils/visibility.ts +1 -1
- package/dist/app.test.d.ts +0 -1
- package/dist/app.test.js +0 -67
- package/dist/app.test.js.map +0 -1
- package/dist/errorHandling.test.d.ts +0 -1
- package/dist/errorHandling.test.js +0 -222
- package/dist/errorHandling.test.js.map +0 -1
- package/dist/index.dev.d.ts +0 -1
- package/dist/index.dev.js +0 -157
- package/dist/index.dev.js.map +0 -1
- package/dist/routes/capabilities.test.d.ts +0 -1
- package/dist/routes/capabilities.test.js +0 -81
- package/dist/routes/capabilities.test.js.map +0 -1
- package/dist/routes/crate.test.d.ts +0 -1
- package/dist/routes/crate.test.js +0 -390
- package/dist/routes/crate.test.js.map +0 -1
- package/dist/routes/entities.test.d.ts +0 -1
- package/dist/routes/entities.test.js +0 -277
- package/dist/routes/entities.test.js.map +0 -1
- package/dist/routes/entity.test.d.ts +0 -1
- package/dist/routes/entity.test.js +0 -136
- package/dist/routes/entity.test.js.map +0 -1
- package/dist/routes/file.test.d.ts +0 -1
- package/dist/routes/file.test.js +0 -435
- package/dist/routes/file.test.js.map +0 -1
- package/dist/routes/files.test.d.ts +0 -1
- package/dist/routes/files.test.js +0 -245
- package/dist/routes/files.test.js.map +0 -1
- package/dist/routes/search.test.d.ts +0 -1
- package/dist/routes/search.test.js +0 -833
- package/dist/routes/search.test.js.map +0 -1
- package/dist/test/helpers/fastify.d.ts +0 -9
- package/dist/test/helpers/fastify.js +0 -17
- package/dist/test/helpers/fastify.js.map +0 -1
- package/dist/test/integration.setup.d.ts +0 -47
- package/dist/test/integration.setup.js +0 -195
- package/dist/test/integration.setup.js.map +0 -1
- package/dist/test/integration.test.d.ts +0 -1
- package/dist/test/integration.test.js +0 -762
- package/dist/test/integration.test.js.map +0 -1
- package/dist/transformers/default.test.d.ts +0 -1
- package/dist/transformers/default.test.js +0 -225
- package/dist/transformers/default.test.js.map +0 -1
- package/dist/transformers/transformer.test.d.ts +0 -1
- package/dist/transformers/transformer.test.js +0 -165
- package/dist/transformers/transformer.test.js.map +0 -1
- package/dist/types/fileHandlers.d.ts +0 -37
- package/dist/types/fileHandlers.js +0 -2
- package/dist/types/fileHandlers.js.map +0 -1
- package/dist/utils/errors.test.d.ts +0 -1
- package/dist/utils/errors.test.js +0 -79
- package/dist/utils/errors.test.js.map +0 -1
- package/dist/utils/queryBuilder.d.ts +0 -47
- package/dist/utils/queryBuilder.js +0 -107
- package/dist/utils/queryBuilder.js.map +0 -1
- package/prisma.config.ts +0 -9
- package/src/app.test.ts +0 -91
- package/src/errorHandling.test.ts +0 -288
- package/src/index.dev.ts +0 -202
- package/src/reset.d.ts +0 -1
- package/src/routes/__snapshots__/capabilities.test.ts.snap +0 -34
- package/src/routes/__snapshots__/entities.test.ts.snap +0 -96
- package/src/routes/__snapshots__/entity.test.ts.snap +0 -74
- package/src/routes/__snapshots__/search.test.ts.snap +0 -165
- package/src/routes/capabilities.test.ts +0 -102
- package/src/routes/crate.test.ts +0 -484
- package/src/routes/entities.test.ts +0 -324
- package/src/routes/entity.test.ts +0 -166
- package/src/routes/file.test.ts +0 -538
- package/src/routes/files.test.ts +0 -304
- package/src/routes/search.test.ts +0 -959
- package/src/test/__snapshots__/integration.test.ts.snap +0 -18
- package/src/test/helpers/fastify.ts +0 -26
- package/src/test/integration.setup.ts +0 -220
- package/src/test/integration.test.ts +0 -953
- package/src/transformers/default.test.ts +0 -276
- package/src/transformers/transformer.test.ts +0 -226
- package/src/types/fileHandlers.ts +0 -57
- package/src/utils/errors.test.ts +0 -90
- package/src/utils/queryBuilder.ts +0 -157
package/LICENSE.md
CHANGED
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@ You need Node.js 22.18 or later, pnpm, and Docker with Docker Compose.
|
|
|
29
29
|
|
|
30
30
|
```sh
|
|
31
31
|
pnpm install
|
|
32
|
-
docker compose up -d #
|
|
32
|
+
docker compose up -d # Postgres, OpenSearch and the Oni UI
|
|
33
33
|
pnpm generate # generate the Prisma client
|
|
34
34
|
pnpm db:migrate # apply migrations
|
|
35
35
|
pnpm seed # load the sample data in example/data
|
|
@@ -45,7 +45,7 @@ pnpm dev # build and serve src/index.dev.ts on http://localhost:90
|
|
|
45
45
|
| `pnpm test src/app.test.ts` | Run one test file |
|
|
46
46
|
| `pnpm test:watch` | Run the tests in watch mode |
|
|
47
47
|
| `pnpm test:coverage` | Run the tests with an HTML coverage report |
|
|
48
|
-
| `pnpm dbconsole` | Open a
|
|
48
|
+
| `pnpm dbconsole` | Open a psql console on the development database |
|
|
49
49
|
| `pnpm --filter website dev` | Run the documentation site locally |
|
|
50
50
|
| `pnpm --filter website build` | Build the documentation site, checking its diagrams and every link |
|
|
51
51
|
|
package/dist/app.d.ts
CHANGED
|
@@ -1,17 +1,21 @@
|
|
|
1
|
-
import type { Client } from '@opensearch-project/opensearch';
|
|
2
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
3
|
-
import type {
|
|
2
|
+
import type { SearchBackend } from './search/backend.js';
|
|
3
|
+
import type { SearchVisibilityWhere } from './search/visibility.js';
|
|
4
|
+
import type { StorageBackend } from './storage/backend.js';
|
|
4
5
|
import type { AccessFunction } from './types/access.js';
|
|
5
|
-
import type { IsAuthenticated } from './types/context.js';
|
|
6
|
-
import type { FileHandler, RoCrateHandler } from './types/fileHandlers.js';
|
|
6
|
+
import type { IsAuthenticated, RequestContext } from './types/context.js';
|
|
7
7
|
import type { EntityTransformer, FileTransformer } from './types/transformers.js';
|
|
8
|
-
import type { EntityVisibilityFilter
|
|
9
|
-
|
|
10
|
-
|
|
8
|
+
import type { EntityVisibilityFilter } from './types/visibility.js';
|
|
9
|
+
export type { AdvancedQuery, BackendSearchCapability, BoundingBox, FacetBucket, RangeBound, RangeFilter, SearchBackend, SearchExtra, SearchRequest, SearchResult, } from './search/backend.js';
|
|
10
|
+
export { SearchQueryError } from './search/backend.js';
|
|
11
|
+
export type { FieldDeclaration, FieldDeclarations, FieldType, GeoPoint, SearchDocument, } from './search/fields.js';
|
|
12
|
+
export { capabilitiesFromFields } from './search/fields.js';
|
|
13
|
+
export type { SearchVisibilityWhere, VisibilityCondition } from './search/visibility.js';
|
|
14
|
+
export { checkSearchVisibility } from './search/visibility.js';
|
|
15
|
+
export type { ContentContext, ContentDelivery, ContentSource, DeliveryHeaders, DirectoryStorageMeta, JsonDelivery, MetadataDelivery, MetadataSource, OcflLocation, OcflStorageMeta, PathDelivery, RedirectDelivery, S3StorageMeta, StorageBackend, StorageLocate, StreamDelivery, } from './storage/backend.js';
|
|
11
16
|
export type { AuthorisedEntity, AuthorisedFile, BaseEntity, StandardEntity, StandardFile, } from './transformers/default.js';
|
|
12
17
|
export type { AccessFunction, AccessInfo } from './types/access.js';
|
|
13
18
|
export type { IsAuthenticated, RequestContext } from './types/context.js';
|
|
14
|
-
export type { FileHandler, FileMetadata, FilePathResult, FileRedirectResult, FileResult, FileStreamResult, GetFileHandler, GetRoCrateHandler, HeadFileHandler, HeadRoCrateHandler, RoCrateHandler, } from './types/fileHandlers.js';
|
|
15
19
|
export type { EntityTransformer, FileTransformer } from './types/transformers.js';
|
|
16
20
|
export type { EntityVisibilityFilter, SearchVisibilityFilter } from './types/visibility.js';
|
|
17
21
|
export type { LicenceAccessOptions } from './utils/access.js';
|
|
@@ -19,20 +23,21 @@ export { AllPublicAccess, LicenceAccess } from './utils/access.js';
|
|
|
19
23
|
export type { ErrorCode, StandardErrorResponse } from './utils/errors.js';
|
|
20
24
|
export { createAuthenticationRequiredError, createError, createForbiddenError, createInternalError, createNotFoundError, createValidationError, ERROR_CODES, errorHandler, notFoundHandler, } from './utils/errors.js';
|
|
21
25
|
export { AllVisibleEntityFilter, AllVisibleSearchFilter } from './utils/visibility.js';
|
|
22
|
-
|
|
23
|
-
|
|
26
|
+
type PrismaMethod = (args: never) => PromiseLike<unknown>;
|
|
27
|
+
type PrismaDelegate = Record<'findMany' | 'findFirst' | 'count', PrismaMethod>;
|
|
28
|
+
export type ArocapiPrismaClient = {
|
|
29
|
+
entity: PrismaDelegate;
|
|
30
|
+
file: PrismaDelegate;
|
|
31
|
+
};
|
|
24
32
|
export type Options = {
|
|
25
|
-
prisma:
|
|
26
|
-
|
|
27
|
-
queryBuilderClass?: typeof OpensearchQueryBuilder;
|
|
28
|
-
queryBuilderOptions?: QueryBuilderOptions;
|
|
33
|
+
prisma: ArocapiPrismaClient;
|
|
34
|
+
search: SearchBackend;
|
|
29
35
|
access: AccessFunction;
|
|
30
36
|
entityTransformers?: EntityTransformer[];
|
|
31
37
|
fileTransformers?: FileTransformer[];
|
|
32
|
-
|
|
33
|
-
roCrateHandler: RoCrateHandler;
|
|
38
|
+
storage: StorageBackend;
|
|
34
39
|
entityVisibilityFilter: EntityVisibilityFilter;
|
|
35
|
-
searchVisibilityFilter:
|
|
40
|
+
searchVisibilityFilter: (context: RequestContext) => Promise<SearchVisibilityWhere> | SearchVisibilityWhere;
|
|
36
41
|
isAuthenticated?: IsAuthenticated;
|
|
37
42
|
promptLoginForHidden?: boolean;
|
|
38
43
|
};
|
package/dist/app.js
CHANGED
|
@@ -7,12 +7,13 @@ import files from './routes/files.js';
|
|
|
7
7
|
import metadata from './routes/metadata.js';
|
|
8
8
|
import search from './routes/search.js';
|
|
9
9
|
import { notFoundHandler } from './utils/errors.js';
|
|
10
|
-
import { OpensearchQueryBuilder } from './utils/queryBuilder.js';
|
|
11
10
|
import { setupValidation } from './utils/validation.js';
|
|
11
|
+
export { SearchQueryError } from './search/backend.js';
|
|
12
|
+
export { capabilitiesFromFields } from './search/fields.js';
|
|
13
|
+
export { checkSearchVisibility } from './search/visibility.js';
|
|
12
14
|
export { AllPublicAccess, LicenceAccess } from './utils/access.js';
|
|
13
15
|
export { createAuthenticationRequiredError, createError, createForbiddenError, createInternalError, createNotFoundError, createValidationError, ERROR_CODES, errorHandler, notFoundHandler, } from './utils/errors.js';
|
|
14
16
|
export { AllVisibleEntityFilter, AllVisibleSearchFilter } from './utils/visibility.js';
|
|
15
|
-
export { OpensearchQueryBuilder };
|
|
16
17
|
const DOCS_URL = 'https://arocapi.crate-works.org';
|
|
17
18
|
const REMOVED_OPTIONS = {
|
|
18
19
|
accessTransformer: { replacement: 'access', docs: `${DOCS_URL}/configuration/access/` },
|
|
@@ -23,12 +24,16 @@ const REMOVED_OPTIONS = {
|
|
|
23
24
|
},
|
|
24
25
|
};
|
|
25
26
|
const app = async (fastify, options) => {
|
|
26
|
-
const {
|
|
27
|
-
if (!prisma) {
|
|
27
|
+
const { search: searchBackend, access, entityTransformers, fileTransformers, storage, entityVisibilityFilter, searchVisibilityFilter, isAuthenticated, promptLoginForHidden = false, } = options;
|
|
28
|
+
if (!options.prisma) {
|
|
28
29
|
throw new Error('Prisma client is required');
|
|
29
30
|
}
|
|
30
|
-
if (
|
|
31
|
-
throw new Error('
|
|
31
|
+
if (typeof options.prisma.entity?.findMany !== 'function' || typeof options.prisma.file?.findMany !== 'function') {
|
|
32
|
+
throw new Error('prisma must be a Prisma 7 client generated from a schema that includes the arocapi models');
|
|
33
|
+
}
|
|
34
|
+
const prisma = options.prisma;
|
|
35
|
+
if (!searchBackend) {
|
|
36
|
+
throw new Error('search is required');
|
|
32
37
|
}
|
|
33
38
|
for (const [removed, { replacement, docs }] of Object.entries(REMOVED_OPTIONS)) {
|
|
34
39
|
if (options[removed] !== undefined) {
|
|
@@ -38,11 +43,14 @@ const app = async (fastify, options) => {
|
|
|
38
43
|
if (!access) {
|
|
39
44
|
throw new Error('access is required');
|
|
40
45
|
}
|
|
41
|
-
if (!
|
|
42
|
-
throw new Error('
|
|
46
|
+
if (!storage) {
|
|
47
|
+
throw new Error('storage is required');
|
|
48
|
+
}
|
|
49
|
+
if (!storage.metadata) {
|
|
50
|
+
throw new Error('storage.metadata is required');
|
|
43
51
|
}
|
|
44
|
-
if (!
|
|
45
|
-
throw new Error('
|
|
52
|
+
if (!storage.content) {
|
|
53
|
+
throw new Error('storage.content is required');
|
|
46
54
|
}
|
|
47
55
|
if (!entityVisibilityFilter) {
|
|
48
56
|
throw new Error('entityVisibilityFilter is required');
|
|
@@ -60,19 +68,17 @@ const app = async (fastify, options) => {
|
|
|
60
68
|
if (prefix && prefix !== '/') {
|
|
61
69
|
fastify.setNotFoundHandler(notFoundHandler);
|
|
62
70
|
}
|
|
63
|
-
|
|
64
|
-
fastify.register(capabilities, { queryBuilder });
|
|
71
|
+
fastify.register(capabilities, { search: searchBackend });
|
|
65
72
|
fastify.register(entities, { prisma, access, entityTransformers, entityVisibilityFilter });
|
|
66
73
|
fastify.register(entity, { prisma, access, entityTransformers, entityVisibilityFilter, refusal });
|
|
67
74
|
fastify.register(files, { prisma, access, fileTransformers, entityVisibilityFilter });
|
|
68
|
-
fastify.register(file, { prisma,
|
|
69
|
-
fastify.register(metadata, { prisma,
|
|
75
|
+
fastify.register(file, { prisma, content: storage.content, access, entityVisibilityFilter, refusal });
|
|
76
|
+
fastify.register(metadata, { prisma, metadata: storage.metadata, access, entityVisibilityFilter, refusal });
|
|
70
77
|
fastify.register(search, {
|
|
71
78
|
prisma,
|
|
72
|
-
|
|
79
|
+
search: searchBackend,
|
|
73
80
|
access,
|
|
74
81
|
entityTransformers,
|
|
75
|
-
queryBuilder,
|
|
76
82
|
entityVisibilityFilter,
|
|
77
83
|
searchVisibilityFilter,
|
|
78
84
|
});
|
package/dist/app.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAGzC,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,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAcxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAQvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AA+B/D,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEnE,OAAO,EACL,iCAAiC,EACjC,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,WAAW,EACX,YAAY,EACZ,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEvF,MAAM,QAAQ,GAAG,iCAAiC,CAAC;AAEnD,MAAM,eAAe,GAA0D;IAC7E,iBAAiB,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,QAAQ,wBAAwB,EAAE;IACvF,qBAAqB,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,QAAQ,wBAAwB,EAAE;IAC3F,cAAc,EAAE;QACd,WAAW,EAAE,0CAA0C;QACvD,IAAI,EAAE,GAAG,QAAQ,iDAAiD;KACnE;CACF,CAAC;AAyBF,MAAM,GAAG,GAAgC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;IAClE,MAAM,EACJ,MAAM,EAAE,aAAa,EACrB,MAAM,EACN,kBAAkB,EAClB,gBAAgB,EAChB,OAAO,EACP,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,oBAAoB,GAAG,KAAK,GAC7B,GAAG,OAAO,CAAC;IAEZ,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,KAAK,UAAU,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,KAAK,UAAU,EAAE,CAAC;QACjH,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAC;IAC/G,CAAC;IAGD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAsB,CAAC;IAE9C,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,MAAM,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;QAC/E,IAAK,OAAmC,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,yBAAyB,WAAW,SAAS,IAAI,EAAE,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,oBAAoB,IAAI,CAAC,eAAe,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,OAAO,GAAG,EAAE,eAAe,EAAE,oBAAoB,EAAE,CAAC;IAE1D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC3B,eAAe,CAAC,OAAO,CAAC,CAAC;IAGzB,MAAM,EAAE,MAAM,EAAE,GAAG,OAA8B,CAAC;IAClD,IAAI,MAAM,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QAC7B,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,CAAC,CAAC;IAC3F,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,CAAC;IAClG,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,CAAC,CAAC;IACtF,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,CAAC;IACtG,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5G,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE;QACvB,MAAM;QACN,MAAM,EAAE,aAAa;QACrB,MAAM;QACN,kBAAkB;QAClB,sBAAsB;QACtB,sBAAsB;KACvB,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,GAAG,CAAC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
|
-
import type {
|
|
2
|
+
import type { SearchBackend } from '../search/backend.js';
|
|
3
3
|
type CapabilitiesRouteOptions = {
|
|
4
|
-
|
|
4
|
+
search: SearchBackend;
|
|
5
5
|
};
|
|
6
6
|
declare const capabilities: FastifyPluginAsync<CapabilitiesRouteOptions>;
|
|
7
7
|
export default capabilities;
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
const SPEC_VERSION = '0.
|
|
1
|
+
const SPEC_VERSION = '0.5.0';
|
|
2
2
|
const capabilities = async (fastify, opts) => {
|
|
3
3
|
const document = {
|
|
4
4
|
apiVersion: SPEC_VERSION,
|
|
5
5
|
deposit: { supported: false },
|
|
6
6
|
tombstonePolicy: '404',
|
|
7
7
|
extensions: {},
|
|
8
|
-
search: opts.
|
|
8
|
+
search: opts.search.capabilities,
|
|
9
9
|
};
|
|
10
10
|
fastify.get('/capabilities', async () => document);
|
|
11
11
|
};
|
|
@@ -1 +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,
|
|
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,MAAM,CAAC,YAAY;KACjC,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,eAAe,YAAY,CAAC"}
|
package/dist/routes/entities.js
CHANGED
|
@@ -3,14 +3,13 @@ import { applyTransformers, authoriseEntities } from '../transformers/default.js
|
|
|
3
3
|
const querySchema = z.object({
|
|
4
4
|
memberOf: z.url().optional(),
|
|
5
5
|
entityType: z
|
|
6
|
-
.string()
|
|
7
|
-
.
|
|
8
|
-
.transform((val) =>
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
.pipe(z.array(z.string()).optional()),
|
|
6
|
+
.union([z.string(), z.array(z.string())])
|
|
7
|
+
.default([])
|
|
8
|
+
.transform((val) => [val]
|
|
9
|
+
.flat()
|
|
10
|
+
.map((value) => value.trim())
|
|
11
|
+
.filter(Boolean))
|
|
12
|
+
.pipe(z.array(z.url())),
|
|
14
13
|
limit: z.coerce.number().int().min(1).max(1000).default(100),
|
|
15
14
|
offset: z.coerce.number().int().min(0).default(0),
|
|
16
15
|
sort: z.enum(['id', 'name', 'createdAt', 'updatedAt']).default('id'),
|
|
@@ -28,7 +27,7 @@ const entities = async (fastify, opts) => {
|
|
|
28
27
|
if (memberOf) {
|
|
29
28
|
where.memberOf = memberOf;
|
|
30
29
|
}
|
|
31
|
-
if (entityType
|
|
30
|
+
if (entityType.length > 0) {
|
|
32
31
|
where.entityType = {
|
|
33
32
|
in: entityType,
|
|
34
33
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../src/routes/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAKlF,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3B,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,CAAC;SACV,MAAM,EAAE
|
|
1
|
+
{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../src/routes/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAKlF,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3B,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;SACxC,OAAO,CAAC,EAAE,CAAC;SACX,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CACjB,CAAC,GAAG,CAAC;SACF,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;SAC5B,MAAM,CAAC,OAAO,CAAC,CACnB;SACA,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IACzB,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;IAC5D,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACpE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;CAC9C,CAAC,CAAC;AASH,MAAM,QAAQ,GAA6C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IACjF,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,EAAE,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC;IACjF,OAAO,CAAC,gBAAgB,EAAmB,CAAC,GAAG,CAC7C,WAAW,EACX;QACE,MAAM,EAAE;YACN,WAAW,EAAE,WAAW;SACzB;KACF,EACD,KAAK,EAAE,OAAO,EAAE,EAAE;QAChB,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;QAE3E,MAAM,KAAK,GAAuE,EAAE,CAAC;QAErF,IAAI,QAAQ,EAAE,CAAC;YACb,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC5B,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,KAAK,CAAC,UAAU,GAAG;gBACjB,EAAE,EAAE,UAAU;aACf,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QACrC,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,YAAY,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,EAAE,CAAC;QAEvD,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACrB,KAAK,EAAE,YAAY;gBACnB,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;gBAC3C,OAAO,EAAE;oBACP,CAAC,IAAI,CAAC,EAAE,KAAK;iBACd;gBACD,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,KAAK;aACZ,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;SAC7C,CAAC,CAAC;QAEH,MAAM,kBAAkB,GAAG,MAAM,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACxF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,kBAAkB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC,CAC3F,CAAC;QAEF,OAAO;YACL,KAAK;YACL,QAAQ;SACT,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,QAAQ,CAAC"}
|
package/dist/routes/file.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
2
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
3
|
+
import type { ContentSource } from '../storage/backend.js';
|
|
3
4
|
import type { AccessFunction } from '../types/access.js';
|
|
4
|
-
import type { FileHandler } from '../types/fileHandlers.js';
|
|
5
5
|
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
6
6
|
import { type RefusalOptions } from '../utils/visibility.js';
|
|
7
7
|
type FileRouteOptions = {
|
|
8
8
|
prisma: PrismaClient;
|
|
9
|
-
|
|
9
|
+
content: ContentSource;
|
|
10
10
|
access: AccessFunction;
|
|
11
11
|
entityVisibilityFilter: EntityVisibilityFilter;
|
|
12
12
|
refusal: RefusalOptions;
|
package/dist/routes/file.js
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
import { createReadStream } from 'node:fs';
|
|
2
1
|
import { create as contentDisposition } from 'content-disposition';
|
|
3
2
|
import { z } from 'zod';
|
|
3
|
+
import { sendDelivery } from '../storage/deliver.js';
|
|
4
4
|
import { createAccessGuard } from '../utils/access.js';
|
|
5
5
|
import { createNotFoundError } from '../utils/errors.js';
|
|
6
|
-
import { setFileHeaders } from '../utils/headers.js';
|
|
7
6
|
import { createNotVisibleResponder } from '../utils/visibility.js';
|
|
8
7
|
const paramsSchema = z.object({
|
|
9
8
|
id: z.url(),
|
|
@@ -18,88 +17,42 @@ const querySchema = z.object({
|
|
|
18
17
|
.transform((value) => value === 'true'),
|
|
19
18
|
});
|
|
20
19
|
const file = async (fastify, opts) => {
|
|
21
|
-
const { prisma,
|
|
22
|
-
const findVisibleFile = async (id, context) => {
|
|
23
|
-
const found = await prisma.file.findFirst({
|
|
24
|
-
where: { id, entity: await entityVisibilityFilter(context) },
|
|
25
|
-
include: { entity: { omit: { meta: true } } },
|
|
26
|
-
});
|
|
27
|
-
if (!found) {
|
|
28
|
-
return null;
|
|
29
|
-
}
|
|
30
|
-
const { entity, ...file } = found;
|
|
31
|
-
return { file, entity };
|
|
32
|
-
};
|
|
20
|
+
const { prisma, content, access, entityVisibilityFilter, refusal } = opts;
|
|
33
21
|
const denyContent = createAccessGuard({ access, isAuthenticated: refusal.isAuthenticated, level: 'content' });
|
|
34
22
|
const sendFileNotVisible = createNotVisibleResponder({
|
|
35
23
|
...refusal,
|
|
36
24
|
notFoundMessage: 'The requested file was not found',
|
|
37
25
|
exists: async (id) => (await prisma.file.count({ where: { id } })) > 0,
|
|
38
26
|
});
|
|
39
|
-
fastify.withTypeProvider().
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
},
|
|
43
|
-
}, async (request, reply) => {
|
|
44
|
-
const { id } = request.params;
|
|
45
|
-
const context = { request, fastify };
|
|
46
|
-
const visible = await findVisibleFile(id, context);
|
|
47
|
-
if (!visible) {
|
|
48
|
-
return sendFileNotVisible(reply, id, context);
|
|
49
|
-
}
|
|
50
|
-
const { file, entity } = visible;
|
|
51
|
-
if (await denyContent(reply, entity, context)) {
|
|
52
|
-
return reply;
|
|
53
|
-
}
|
|
54
|
-
const metadata = await fileHandler.head(file, context);
|
|
55
|
-
if (!metadata) {
|
|
56
|
-
return reply.code(404).send(createNotFoundError('The requested file metadata was not found', id));
|
|
57
|
-
}
|
|
58
|
-
setFileHeaders(reply, metadata);
|
|
59
|
-
return reply.code(200).send();
|
|
60
|
-
});
|
|
61
|
-
fastify.withTypeProvider().get('/file/:id', {
|
|
27
|
+
fastify.withTypeProvider().route({
|
|
28
|
+
method: ['GET', 'HEAD'],
|
|
29
|
+
url: '/file/:id',
|
|
62
30
|
schema: {
|
|
63
31
|
params: paramsSchema,
|
|
64
32
|
querystring: querySchema,
|
|
65
33
|
},
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
return reply.code(404).send(createNotFoundError('The requested file could not be retrieved', id));
|
|
80
|
-
}
|
|
81
|
-
if (result.type === 'redirect') {
|
|
82
|
-
if (request.query.noRedirect) {
|
|
83
|
-
return reply.code(200).send({ location: result.url });
|
|
34
|
+
handler: async (request, reply) => {
|
|
35
|
+
const { id } = request.params;
|
|
36
|
+
const context = { request, fastify };
|
|
37
|
+
const found = await prisma.file.findFirst({
|
|
38
|
+
where: { id, entity: await entityVisibilityFilter(context) },
|
|
39
|
+
include: { entity: true },
|
|
40
|
+
});
|
|
41
|
+
if (!found) {
|
|
42
|
+
return sendFileNotVisible(reply, id, context);
|
|
43
|
+
}
|
|
44
|
+
const { entity, ...file } = found;
|
|
45
|
+
if (await denyContent(reply, entity, context)) {
|
|
46
|
+
return reply;
|
|
84
47
|
}
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
if (result.type === 'stream') {
|
|
91
|
-
return reply.code(200).send(result.stream);
|
|
92
|
-
}
|
|
93
|
-
if (result.type === 'file') {
|
|
94
|
-
if (result.accelPath) {
|
|
95
|
-
reply.header('X-Accel-Redirect', result.accelPath);
|
|
96
|
-
return reply.code(200).send();
|
|
48
|
+
const { disposition, filename, noRedirect } = request.query;
|
|
49
|
+
const disposed = contentDisposition(filename || file.filename, { type: disposition });
|
|
50
|
+
const delivery = await content(file, entity, { ...context, contentDisposition: disposed });
|
|
51
|
+
if (!delivery) {
|
|
52
|
+
return reply.code(404).send(createNotFoundError('The requested file could not be retrieved', id));
|
|
97
53
|
}
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
}
|
|
101
|
-
reply.removeHeader('Content-Disposition');
|
|
102
|
-
throw new Error(`Unexpected file result type: ${result.type}`);
|
|
54
|
+
return sendDelivery(request, reply, delivery, { contentDisposition: disposed, noRedirect });
|
|
55
|
+
},
|
|
103
56
|
});
|
|
104
57
|
};
|
|
105
58
|
export default file;
|
package/dist/routes/file.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/routes/file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/routes/file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAGnE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAuB,MAAM,wBAAwB,CAAC;AAExF,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE;CACZ,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC1E,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC;SACV,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACvB,QAAQ,EAAE;SACV,OAAO,CAAC,OAAO,CAAC;SAChB,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC;CAC1C,CAAC,CAAC;AAUH,MAAM,IAAI,GAAyC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IACzE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAE1E,MAAM,WAAW,GAAG,iBAAiB,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAE9G,MAAM,kBAAkB,GAAG,yBAAyB,CAAC;QACnD,GAAG,OAAO;QACV,eAAe,EAAE,kCAAkC;QACnD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC;KACvE,CAAC,CAAC;IAEH,OAAO,CAAC,gBAAgB,EAAmB,CAAC,KAAK,CAAC;QAChD,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,GAAG,EAAE,WAAW;QAChB,MAAM,EAAE;YACN,MAAM,EAAE,YAAY;YACpB,WAAW,EAAE,WAAW;SACzB;QACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAChC,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;YAE9B,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;YACrC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBACxC,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC,OAAO,CAAC,EAAE;gBAC5D,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;aAC1B,CAAC,CAAC;YAEH,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,kBAAkB,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;YAClC,IAAI,MAAM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC9C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;YAC5D,MAAM,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;YACtF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC,CAAC;YAE3F,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,2CAA2C,EAAE,EAAE,CAAC,CAAC,CAAC;YACpG,CAAC;YAED,OAAO,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,kBAAkB,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QAC9F,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
2
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
3
|
+
import type { MetadataSource } from '../storage/backend.js';
|
|
3
4
|
import type { AccessFunction } from '../types/access.js';
|
|
4
|
-
import type { RoCrateHandler } from '../types/fileHandlers.js';
|
|
5
5
|
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
6
6
|
import { type RefusalOptions } from '../utils/visibility.js';
|
|
7
|
-
type
|
|
7
|
+
type MetadataRouteOptions = {
|
|
8
8
|
prisma: PrismaClient;
|
|
9
|
-
|
|
9
|
+
metadata: MetadataSource;
|
|
10
10
|
access: AccessFunction;
|
|
11
11
|
entityVisibilityFilter: EntityVisibilityFilter;
|
|
12
12
|
refusal: RefusalOptions;
|
|
13
13
|
};
|
|
14
|
-
declare const
|
|
15
|
-
export default
|
|
14
|
+
declare const metadataRoute: FastifyPluginAsync<MetadataRouteOptions>;
|
|
15
|
+
export default metadataRoute;
|
package/dist/routes/metadata.js
CHANGED
|
@@ -1,77 +1,38 @@
|
|
|
1
|
-
import { createReadStream } from 'node:fs';
|
|
2
1
|
import { z } from 'zod';
|
|
2
|
+
import { sendDelivery } from '../storage/deliver.js';
|
|
3
3
|
import { createAccessGuard } from '../utils/access.js';
|
|
4
4
|
import { createNotFoundError } from '../utils/errors.js';
|
|
5
|
-
import { setFileHeaders } from '../utils/headers.js';
|
|
6
5
|
import { createEntityNotVisibleResponder } from '../utils/visibility.js';
|
|
7
6
|
const paramsSchema = z.object({
|
|
8
7
|
id: z.url(),
|
|
9
8
|
});
|
|
10
|
-
const
|
|
11
|
-
const { prisma,
|
|
12
|
-
const findVisibleEntity = async (id, context) => prisma.entity.findFirst({ where: { AND: [{ id }, await entityVisibilityFilter(context)] } });
|
|
9
|
+
const metadataRoute = async (fastify, opts) => {
|
|
10
|
+
const { prisma, metadata, access, entityVisibilityFilter, refusal } = opts;
|
|
13
11
|
const sendEntityNotVisible = createEntityNotVisibleResponder(prisma, refusal);
|
|
14
12
|
const denyMetadata = createAccessGuard({ access, isAuthenticated: refusal.isAuthenticated, level: 'metadata' });
|
|
15
|
-
fastify.withTypeProvider().
|
|
13
|
+
fastify.withTypeProvider().route({
|
|
14
|
+
method: ['GET', 'HEAD'],
|
|
15
|
+
url: '/entity/:id/metadata',
|
|
16
16
|
schema: {
|
|
17
17
|
params: paramsSchema,
|
|
18
18
|
},
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
}
|
|
26
|
-
if (await denyMetadata(reply, entity, context)) {
|
|
27
|
-
return reply;
|
|
28
|
-
}
|
|
29
|
-
const metadata = await roCrateHandler.head(entity, context);
|
|
30
|
-
if (!metadata) {
|
|
31
|
-
return reply.code(404).send(createNotFoundError('The requested RO-Crate metadata was not found', id));
|
|
32
|
-
}
|
|
33
|
-
setFileHeaders(reply, metadata);
|
|
34
|
-
return reply.code(200).send();
|
|
35
|
-
});
|
|
36
|
-
fastify.withTypeProvider().get('/entity/:id/metadata', {
|
|
37
|
-
schema: {
|
|
38
|
-
params: paramsSchema,
|
|
39
|
-
},
|
|
40
|
-
}, async (request, reply) => {
|
|
41
|
-
const { id } = request.params;
|
|
42
|
-
const context = { request, fastify };
|
|
43
|
-
const entity = await findVisibleEntity(id, context);
|
|
44
|
-
if (!entity) {
|
|
45
|
-
return sendEntityNotVisible(reply, id, context);
|
|
46
|
-
}
|
|
47
|
-
if (await denyMetadata(reply, entity, context)) {
|
|
48
|
-
return reply;
|
|
49
|
-
}
|
|
50
|
-
const result = await roCrateHandler.get(entity, context);
|
|
51
|
-
if (!result) {
|
|
52
|
-
return reply.code(404).send(createNotFoundError('The requested RO-Crate could not be retrieved', id));
|
|
53
|
-
}
|
|
54
|
-
if (result.type === 'redirect') {
|
|
55
|
-
return reply.code(302).redirect(result.url);
|
|
56
|
-
}
|
|
57
|
-
const metadata = {
|
|
58
|
-
...result.metadata,
|
|
59
|
-
contentType: 'application/ld+json',
|
|
60
|
-
};
|
|
61
|
-
setFileHeaders(reply, metadata);
|
|
62
|
-
if (result.type === 'stream') {
|
|
63
|
-
return reply.code(200).send(result.stream);
|
|
64
|
-
}
|
|
65
|
-
if (result.type === 'file') {
|
|
66
|
-
if (result.accelPath) {
|
|
67
|
-
reply.header('X-Accel-Redirect', result.accelPath);
|
|
68
|
-
return reply.code(200).send();
|
|
19
|
+
handler: async (request, reply) => {
|
|
20
|
+
const { id } = request.params;
|
|
21
|
+
const context = { request, fastify };
|
|
22
|
+
const entity = await prisma.entity.findFirst({ where: { AND: [{ id }, await entityVisibilityFilter(context)] } });
|
|
23
|
+
if (!entity) {
|
|
24
|
+
return sendEntityNotVisible(reply, id, context);
|
|
69
25
|
}
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
26
|
+
if (await denyMetadata(reply, entity, context)) {
|
|
27
|
+
return reply;
|
|
28
|
+
}
|
|
29
|
+
const delivery = await metadata(entity, context);
|
|
30
|
+
if (!delivery) {
|
|
31
|
+
return reply.code(404).send(createNotFoundError('The requested Metadata was not found', id));
|
|
32
|
+
}
|
|
33
|
+
return sendDelivery(request, reply, delivery.type === 'redirect' ? delivery : { ...delivery, contentType: 'application/ld+json' }, { json: true });
|
|
34
|
+
},
|
|
74
35
|
});
|
|
75
36
|
};
|
|
76
|
-
export default
|
|
37
|
+
export default metadataRoute;
|
|
77
38
|
//# sourceMappingURL=metadata.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/routes/metadata.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/routes/metadata.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,+BAA+B,EAAuB,MAAM,wBAAwB,CAAC;AAE9F,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE;CACZ,CAAC,CAAC;AAUH,MAAM,aAAa,GAA6C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IACtF,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAE3E,MAAM,oBAAoB,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9E,MAAM,YAAY,GAAG,iBAAiB,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;IAEhH,OAAO,CAAC,gBAAgB,EAAmB,CAAC,KAAK,CAAC;QAChD,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,GAAG,EAAE,sBAAsB;QAC3B,MAAM,EAAE;YACN,MAAM,EAAE,YAAY;SACrB;QACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAChC,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;YAE9B,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAElH,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,oBAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YAClD,CAAC;YAED,IAAI,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC/C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEjD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,sCAAsC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC/F,CAAC;YAED,OAAO,YAAY,CACjB,OAAO,EACP,KAAK,EACL,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,WAAW,EAAE,qBAAqB,EAAE,EAC7F,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC"}
|
package/dist/routes/search.d.ts
CHANGED
|
@@ -1,16 +1,14 @@
|
|
|
1
|
-
import type { Client } from '@opensearch-project/opensearch';
|
|
2
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
3
2
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
3
|
+
import { type SearchBackend } from '../search/backend.js';
|
|
4
4
|
import type { AccessFunction } from '../types/access.js';
|
|
5
5
|
import type { EntityTransformer } from '../types/transformers.js';
|
|
6
6
|
import type { EntityVisibilityFilter, SearchVisibilityFilter } from '../types/visibility.js';
|
|
7
|
-
import type { OpensearchQueryBuilder } from '../utils/queryBuilder.js';
|
|
8
7
|
type SearchRouteOptions = {
|
|
9
8
|
prisma: PrismaClient;
|
|
10
|
-
|
|
9
|
+
search: SearchBackend;
|
|
11
10
|
access: AccessFunction;
|
|
12
11
|
entityTransformers?: EntityTransformer[];
|
|
13
|
-
queryBuilder: OpensearchQueryBuilder;
|
|
14
12
|
entityVisibilityFilter: EntityVisibilityFilter;
|
|
15
13
|
searchVisibilityFilter: SearchVisibilityFilter;
|
|
16
14
|
};
|