arocapi 4.0.1 → 5.0.0-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +1 -1
- package/README.md +37 -781
- package/dist/app.d.ts +38 -21
- package/dist/app.js +63 -45
- package/dist/app.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/entities.d.ts +5 -2
- package/dist/routes/entities.js +38 -58
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/entity.d.ts +7 -2
- package/dist/routes/entity.js +14 -30
- package/dist/routes/entity.js.map +1 -1
- package/dist/routes/file.d.ts +8 -2
- package/dist/routes/file.js +38 -73
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/files.d.ts +5 -2
- package/dist/routes/files.js +25 -40
- package/dist/routes/files.js.map +1 -1
- package/dist/routes/metadata.d.ts +15 -0
- package/dist/routes/metadata.js +38 -0
- package/dist/routes/metadata.js.map +1 -0
- package/dist/routes/search.d.ts +8 -7
- package/dist/routes/search.js +91 -120
- 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 +19 -0
- package/dist/storage/location.js +36 -0
- package/dist/storage/location.js.map +1 -0
- package/dist/storage/ocfl/ocfl.d.ts +6 -0
- package/dist/storage/ocfl/ocfl.js +45 -0
- package/dist/storage/ocfl/ocfl.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/transformers/default.d.ts +11 -22
- package/dist/transformers/default.js +41 -15
- package/dist/transformers/default.js.map +1 -1
- package/dist/types/access.d.ts +9 -0
- package/dist/types/access.js +2 -0
- package/dist/types/access.js.map +1 -0
- package/dist/types/context.d.ts +6 -0
- package/dist/types/context.js +2 -0
- package/dist/types/context.js.map +1 -0
- package/dist/types/transformers.d.ts +4 -10
- package/dist/types/visibility.d.ts +6 -0
- package/dist/types/visibility.js +2 -0
- package/dist/types/visibility.js.map +1 -0
- package/dist/utils/access.d.ts +17 -0
- package/dist/utils/access.js +41 -0
- package/dist/utils/access.js.map +1 -0
- package/dist/utils/errors.d.ts +19 -10
- package/dist/utils/errors.js +44 -8
- package/dist/utils/errors.js.map +1 -1
- package/dist/utils/headers.d.ts +1 -1
- package/dist/utils/headers.js +10 -1
- package/dist/utils/headers.js.map +1 -1
- package/dist/utils/validation.d.ts +2 -0
- package/dist/utils/validation.js +8 -0
- package/dist/utils/validation.js.map +1 -0
- package/dist/utils/visibility.d.ts +18 -0
- package/dist/utils/visibility.js +16 -0
- package/dist/utils/visibility.js.map +1 -0
- package/package.json +84 -45
- 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 +169 -102
- package/src/routes/capabilities.ts +22 -0
- package/src/routes/entities.ts +49 -68
- package/src/routes/entity.ts +22 -36
- package/src/routes/file.ts +54 -104
- package/src/routes/files.ts +32 -48
- package/src/routes/metadata.ts +67 -0
- package/src/routes/search.ts +132 -152
- 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 +78 -0
- package/src/storage/ocfl/ocfl.ts +71 -0
- package/src/storage/results.ts +32 -0
- package/src/storage/s3/s3.ts +79 -0
- package/src/transformers/default.ts +115 -85
- package/src/types/access.ts +25 -0
- package/src/types/context.ts +15 -0
- package/src/types/transformers.ts +8 -34
- package/src/types/visibility.ts +21 -0
- package/src/utils/access.ts +80 -0
- package/src/utils/errors.ts +68 -11
- package/src/utils/headers.ts +22 -2
- package/src/utils/validation.ts +11 -0
- package/src/utils/visibility.ts +56 -0
- package/dist/app.test.d.ts +0 -1
- package/dist/app.test.js +0 -89
- package/dist/app.test.js.map +0 -1
- package/dist/express.d.ts +0 -4
- package/dist/express.js +0 -14
- package/dist/express.js.map +0 -1
- package/dist/index.dev.d.ts +0 -1
- package/dist/index.dev.js +0 -156
- package/dist/index.dev.js.map +0 -1
- package/dist/routes/crate.d.ts +0 -9
- package/dist/routes/crate.js +0 -82
- package/dist/routes/crate.js.map +0 -1
- package/dist/routes/crate.test.d.ts +0 -1
- package/dist/routes/crate.test.js +0 -342
- 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 -273
- 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 -130
- 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 -315
- 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 -222
- 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 -780
- 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 -18
- package/dist/test/helpers/fastify.js.map +0 -1
- package/dist/test/integration.setup.d.ts +0 -29
- package/dist/test/integration.setup.js +0 -188
- 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 -396
- 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 -163
- 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 -187
- package/dist/transformers/transformer.test.js.map +0 -1
- package/dist/types/fileHandlers.d.ts +0 -41
- 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 -66
- package/dist/utils/errors.test.js.map +0 -1
- package/dist/utils/queryBuilder.d.ts +0 -35
- package/dist/utils/queryBuilder.js +0 -98
- package/dist/utils/queryBuilder.js.map +0 -1
- package/prisma.config.ts +0 -9
- package/src/app.test.ts +0 -119
- package/src/express.ts +0 -21
- package/src/index.dev.ts +0 -200
- package/src/reset.d.ts +0 -1
- 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/crate.test.ts +0 -423
- package/src/routes/crate.ts +0 -123
- package/src/routes/entities.test.ts +0 -320
- package/src/routes/entity.test.ts +0 -160
- package/src/routes/file.test.ts +0 -395
- package/src/routes/files.test.ts +0 -278
- package/src/routes/search.test.ts +0 -903
- package/src/test/__snapshots__/integration.test.ts.snap +0 -18
- package/src/test/helpers/fastify.ts +0 -27
- package/src/test/integration.setup.ts +0 -210
- package/src/test/integration.test.ts +0 -482
- package/src/transformers/default.test.ts +0 -184
- package/src/transformers/transformer.test.ts +0 -252
- package/src/types/fileHandlers.ts +0 -65
- package/src/utils/errors.test.ts +0 -75
- package/src/utils/queryBuilder.ts +0 -132
package/dist/app.d.ts
CHANGED
|
@@ -1,28 +1,45 @@
|
|
|
1
|
-
import type { Client } from '@opensearch-project/opensearch';
|
|
2
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
3
|
-
import type {
|
|
4
|
-
import type {
|
|
5
|
-
import type {
|
|
6
|
-
import type {
|
|
7
|
-
import {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
export type {
|
|
11
|
-
export
|
|
12
|
-
export type {
|
|
13
|
-
export {
|
|
2
|
+
import type { SearchBackend } from './search/backend.js';
|
|
3
|
+
import type { SearchVisibilityWhere } from './search/visibility.js';
|
|
4
|
+
import type { StorageBackend } from './storage/backend.js';
|
|
5
|
+
import type { AccessFunction } from './types/access.js';
|
|
6
|
+
import type { IsAuthenticated, RequestContext } from './types/context.js';
|
|
7
|
+
import type { EntityTransformer, FileTransformer } from './types/transformers.js';
|
|
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';
|
|
16
|
+
export type { AuthorisedEntity, AuthorisedFile, BaseEntity, EntityRow, FileRow, StandardEntity, StandardFile, } from './transformers/default.js';
|
|
17
|
+
export type { AccessFunction, AccessInfo } from './types/access.js';
|
|
18
|
+
export type { IsAuthenticated, RequestContext } from './types/context.js';
|
|
19
|
+
export type { EntityTransformer, FileTransformer } from './types/transformers.js';
|
|
20
|
+
export type { EntityVisibilityFilter, SearchVisibilityFilter } from './types/visibility.js';
|
|
21
|
+
export type { LicenceAccessOptions } from './utils/access.js';
|
|
22
|
+
export { AllPublicAccess, LicenceAccess } from './utils/access.js';
|
|
23
|
+
export type { ErrorCode, StandardErrorResponse } from './utils/errors.js';
|
|
24
|
+
export { createAuthenticationRequiredError, createError, createForbiddenError, createInternalError, createNotFoundError, createValidationError, ERROR_CODES, errorHandler, notFoundHandler, } from './utils/errors.js';
|
|
25
|
+
export { AllVisibleEntityFilter, AllVisibleSearchFilter } from './utils/visibility.js';
|
|
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
|
+
};
|
|
14
32
|
export type Options = {
|
|
15
|
-
prisma:
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
queryBuilderOptions?: QueryBuilderOptions;
|
|
19
|
-
disableCors?: boolean;
|
|
20
|
-
accessTransformer: AccessTransformer;
|
|
33
|
+
prisma: ArocapiPrismaClient;
|
|
34
|
+
search: SearchBackend;
|
|
35
|
+
access: AccessFunction;
|
|
21
36
|
entityTransformers?: EntityTransformer[];
|
|
22
|
-
fileAccessTransformer: FileAccessTransformer;
|
|
23
37
|
fileTransformers?: FileTransformer[];
|
|
24
|
-
|
|
25
|
-
|
|
38
|
+
storage: StorageBackend;
|
|
39
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
40
|
+
searchVisibilityFilter: (context: RequestContext) => Promise<SearchVisibilityWhere> | SearchVisibilityWhere;
|
|
41
|
+
isAuthenticated?: IsAuthenticated;
|
|
42
|
+
promptLoginForHidden?: boolean;
|
|
26
43
|
};
|
|
27
44
|
declare const app: FastifyPluginAsync<Options>;
|
|
28
45
|
export default app;
|
package/dist/app.js
CHANGED
|
@@ -1,68 +1,86 @@
|
|
|
1
|
-
import cors from '@fastify/cors';
|
|
2
1
|
import sensible from '@fastify/sensible';
|
|
3
|
-
import
|
|
4
|
-
import crate from './routes/crate.js';
|
|
2
|
+
import capabilities from './routes/capabilities.js';
|
|
5
3
|
import entities from './routes/entities.js';
|
|
6
4
|
import entity from './routes/entity.js';
|
|
7
5
|
import file from './routes/file.js';
|
|
8
6
|
import files from './routes/files.js';
|
|
7
|
+
import metadata from './routes/metadata.js';
|
|
9
8
|
import search from './routes/search.js';
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
export {
|
|
13
|
-
export {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
return reply.code(500).send({ error: 'Internal Server Error', message: err.message });
|
|
27
|
-
});
|
|
9
|
+
import { notFoundHandler } from './utils/errors.js';
|
|
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';
|
|
14
|
+
export { AllPublicAccess, LicenceAccess } from './utils/access.js';
|
|
15
|
+
export { createAuthenticationRequiredError, createError, createForbiddenError, createInternalError, createNotFoundError, createValidationError, ERROR_CODES, errorHandler, notFoundHandler, } from './utils/errors.js';
|
|
16
|
+
export { AllVisibleEntityFilter, AllVisibleSearchFilter } from './utils/visibility.js';
|
|
17
|
+
const DOCS_URL = 'https://arocapi.crate-works.org';
|
|
18
|
+
const REMOVED_OPTIONS = {
|
|
19
|
+
accessTransformer: { replacement: 'access', docs: `${DOCS_URL}/configuration/access/` },
|
|
20
|
+
fileAccessTransformer: { replacement: 'access', docs: `${DOCS_URL}/configuration/access/` },
|
|
21
|
+
hiddenResponse: {
|
|
22
|
+
replacement: 'promptLoginForHidden and isAuthenticated',
|
|
23
|
+
docs: `${DOCS_URL}/configuration/visibility/#promptloginforhidden`,
|
|
24
|
+
},
|
|
28
25
|
};
|
|
29
26
|
const app = async (fastify, options) => {
|
|
30
|
-
const {
|
|
31
|
-
if (!prisma) {
|
|
27
|
+
const { search: searchBackend, access, entityTransformers, fileTransformers, storage, entityVisibilityFilter, searchVisibilityFilter, isAuthenticated, promptLoginForHidden = false, } = options;
|
|
28
|
+
if (!options.prisma) {
|
|
32
29
|
throw new Error('Prisma client is required');
|
|
33
30
|
}
|
|
34
|
-
if (
|
|
35
|
-
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');
|
|
36
33
|
}
|
|
37
|
-
|
|
38
|
-
|
|
34
|
+
const prisma = options.prisma;
|
|
35
|
+
if (!searchBackend) {
|
|
36
|
+
throw new Error('search is required');
|
|
39
37
|
}
|
|
40
|
-
|
|
41
|
-
|
|
38
|
+
for (const [removed, { replacement, docs }] of Object.entries(REMOVED_OPTIONS)) {
|
|
39
|
+
if (options[removed] !== undefined) {
|
|
40
|
+
throw new Error(`${removed} has been replaced by ${replacement}, see ${docs}`);
|
|
41
|
+
}
|
|
42
42
|
}
|
|
43
|
-
if (!
|
|
44
|
-
throw new Error('
|
|
43
|
+
if (!access) {
|
|
44
|
+
throw new Error('access is required');
|
|
45
45
|
}
|
|
46
|
-
if (!
|
|
47
|
-
throw new Error('
|
|
46
|
+
if (!storage) {
|
|
47
|
+
throw new Error('storage is required');
|
|
48
48
|
}
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
49
|
+
if (!storage.metadata) {
|
|
50
|
+
throw new Error('storage.metadata is required');
|
|
51
|
+
}
|
|
52
|
+
if (!storage.content) {
|
|
53
|
+
throw new Error('storage.content is required');
|
|
52
54
|
}
|
|
55
|
+
if (!entityVisibilityFilter) {
|
|
56
|
+
throw new Error('entityVisibilityFilter is required');
|
|
57
|
+
}
|
|
58
|
+
if (!searchVisibilityFilter) {
|
|
59
|
+
throw new Error('searchVisibilityFilter is required');
|
|
60
|
+
}
|
|
61
|
+
if (promptLoginForHidden && !isAuthenticated) {
|
|
62
|
+
throw new Error('promptLoginForHidden requires isAuthenticated');
|
|
63
|
+
}
|
|
64
|
+
const refusal = { isAuthenticated, promptLoginForHidden };
|
|
65
|
+
fastify.register(sensible);
|
|
53
66
|
setupValidation(fastify);
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
fastify.register(
|
|
67
|
+
const { prefix } = options;
|
|
68
|
+
if (prefix && prefix !== '/') {
|
|
69
|
+
fastify.setNotFoundHandler(notFoundHandler);
|
|
70
|
+
}
|
|
71
|
+
fastify.register(capabilities, { search: searchBackend });
|
|
72
|
+
fastify.register(entities, { prisma, access, entityTransformers, entityVisibilityFilter });
|
|
73
|
+
fastify.register(entity, { prisma, access, entityTransformers, entityVisibilityFilter, refusal });
|
|
74
|
+
fastify.register(files, { prisma, access, fileTransformers, entityVisibilityFilter });
|
|
75
|
+
fastify.register(file, { prisma, content: storage.content, access, entityVisibilityFilter, refusal });
|
|
76
|
+
fastify.register(metadata, { prisma, metadata: storage.metadata, access, entityVisibilityFilter, refusal });
|
|
59
77
|
fastify.register(search, {
|
|
60
78
|
prisma,
|
|
61
|
-
|
|
62
|
-
|
|
79
|
+
search: searchBackend,
|
|
80
|
+
access,
|
|
63
81
|
entityTransformers,
|
|
64
|
-
|
|
65
|
-
|
|
82
|
+
entityVisibilityFilter,
|
|
83
|
+
searchVisibilityFilter,
|
|
66
84
|
});
|
|
67
85
|
};
|
|
68
86
|
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,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;AAiC/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"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { FastifyPluginAsync } from 'fastify';
|
|
2
|
+
import type { SearchBackend } from '../search/backend.js';
|
|
3
|
+
type CapabilitiesRouteOptions = {
|
|
4
|
+
search: SearchBackend;
|
|
5
|
+
};
|
|
6
|
+
declare const capabilities: FastifyPluginAsync<CapabilitiesRouteOptions>;
|
|
7
|
+
export default capabilities;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
const SPEC_VERSION = '0.5.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.search.capabilities,
|
|
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,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"}
|
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
2
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
3
|
-
import type {
|
|
3
|
+
import type { AccessFunction } from '../types/access.js';
|
|
4
|
+
import type { EntityTransformer } from '../types/transformers.js';
|
|
5
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
4
6
|
type EntitiesRouteOptions = {
|
|
5
7
|
prisma: PrismaClient;
|
|
6
|
-
|
|
8
|
+
access: AccessFunction;
|
|
7
9
|
entityTransformers?: EntityTransformer[];
|
|
10
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
8
11
|
};
|
|
9
12
|
declare const entities: FastifyPluginAsync<EntitiesRouteOptions>;
|
|
10
13
|
export default entities;
|
package/dist/routes/entities.js
CHANGED
|
@@ -1,77 +1,57 @@
|
|
|
1
|
-
import { z } from 'zod
|
|
2
|
-
import {
|
|
3
|
-
import { createInternalError } from '../utils/errors.js';
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { applyTransformers, authoriseEntities } from '../transformers/default.js';
|
|
4
3
|
const querySchema = z.object({
|
|
5
4
|
memberOf: z.url().optional(),
|
|
6
5
|
entityType: z
|
|
7
|
-
.string()
|
|
8
|
-
.
|
|
9
|
-
.transform((val) =>
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
.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())),
|
|
15
13
|
limit: z.coerce.number().int().min(1).max(1000).default(100),
|
|
16
14
|
offset: z.coerce.number().int().min(0).default(0),
|
|
17
15
|
sort: z.enum(['id', 'name', 'createdAt', 'updatedAt']).default('id'),
|
|
18
16
|
order: z.enum(['asc', 'desc']).default('asc'),
|
|
19
17
|
});
|
|
20
18
|
const entities = async (fastify, opts) => {
|
|
21
|
-
const { prisma,
|
|
19
|
+
const { prisma, access, entityTransformers = [], entityVisibilityFilter } = opts;
|
|
22
20
|
fastify.withTypeProvider().get('/entities', {
|
|
23
21
|
schema: {
|
|
24
22
|
querystring: querySchema,
|
|
25
23
|
},
|
|
26
|
-
}, async (request
|
|
24
|
+
}, async (request) => {
|
|
27
25
|
const { memberOf, entityType, limit, offset, sort, order } = request.query;
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
where.memberOf = memberOf;
|
|
32
|
-
}
|
|
33
|
-
if (entityType && entityType.length > 0) {
|
|
34
|
-
where.entityType = {
|
|
35
|
-
in: entityType,
|
|
36
|
-
};
|
|
37
|
-
}
|
|
38
|
-
const [dbEntities, total] = await Promise.all([
|
|
39
|
-
prisma.entity.findMany({
|
|
40
|
-
where,
|
|
41
|
-
include: { file: { select: { id: true } } },
|
|
42
|
-
orderBy: {
|
|
43
|
-
[sort]: order,
|
|
44
|
-
},
|
|
45
|
-
skip: offset,
|
|
46
|
-
take: limit,
|
|
47
|
-
}),
|
|
48
|
-
prisma.entity.count({ where }),
|
|
49
|
-
]);
|
|
50
|
-
const refMap = await resolveEntityReferences(dbEntities, prisma);
|
|
51
|
-
const entities = await Promise.all(dbEntities.map(async (dbEntity) => {
|
|
52
|
-
const base = baseEntityTransformer(dbEntity);
|
|
53
|
-
const standardEntity = {
|
|
54
|
-
...base,
|
|
55
|
-
memberOf: base.memberOf ? (refMap.get(base.memberOf) ?? null) : null,
|
|
56
|
-
rootCollection: base.rootCollection ? (refMap.get(base.rootCollection) ?? null) : null,
|
|
57
|
-
};
|
|
58
|
-
const authorisedEntity = await accessTransformer(standardEntity, { request, fastify });
|
|
59
|
-
let result = authorisedEntity;
|
|
60
|
-
for (const transformer of entityTransformers) {
|
|
61
|
-
result = await transformer(result, { request, fastify });
|
|
62
|
-
}
|
|
63
|
-
return result;
|
|
64
|
-
}));
|
|
65
|
-
return {
|
|
66
|
-
total,
|
|
67
|
-
entities,
|
|
68
|
-
};
|
|
26
|
+
const where = {};
|
|
27
|
+
if (memberOf) {
|
|
28
|
+
where.memberOf = memberOf;
|
|
69
29
|
}
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
30
|
+
if (entityType.length > 0) {
|
|
31
|
+
where.entityType = {
|
|
32
|
+
in: entityType,
|
|
33
|
+
};
|
|
74
34
|
}
|
|
35
|
+
const context = { request, fastify };
|
|
36
|
+
const visibilityWhere = await entityVisibilityFilter(context);
|
|
37
|
+
const visibleWhere = { AND: [where, visibilityWhere] };
|
|
38
|
+
const [dbEntities, total] = await Promise.all([
|
|
39
|
+
prisma.entity.findMany({
|
|
40
|
+
where: visibleWhere,
|
|
41
|
+
orderBy: {
|
|
42
|
+
[sort]: order,
|
|
43
|
+
},
|
|
44
|
+
skip: offset,
|
|
45
|
+
take: limit,
|
|
46
|
+
}),
|
|
47
|
+
prisma.entity.count({ where: visibleWhere }),
|
|
48
|
+
]);
|
|
49
|
+
const authorisedEntities = await authoriseEntities(dbEntities, prisma, access, context);
|
|
50
|
+
const entities = await Promise.all(authorisedEntities.map((entity, i) => applyTransformers(entity, entityTransformers, context, dbEntities[i])));
|
|
51
|
+
return {
|
|
52
|
+
total,
|
|
53
|
+
entities,
|
|
54
|
+
};
|
|
75
55
|
});
|
|
76
56
|
};
|
|
77
57
|
export default entities;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../src/routes/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,
|
|
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;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,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAC7G,CAAC;QAEF,OAAO;YACL,KAAK;YACL,QAAQ;SACT,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,QAAQ,CAAC"}
|
package/dist/routes/entity.d.ts
CHANGED
|
@@ -1,10 +1,15 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
2
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
3
|
-
import type {
|
|
3
|
+
import type { AccessFunction } from '../types/access.js';
|
|
4
|
+
import type { EntityTransformer } from '../types/transformers.js';
|
|
5
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
6
|
+
import { type RefusalOptions } from '../utils/visibility.js';
|
|
4
7
|
type EntityRouteOptions = {
|
|
5
8
|
prisma: PrismaClient;
|
|
6
|
-
|
|
9
|
+
access: AccessFunction;
|
|
7
10
|
entityTransformers?: EntityTransformer[];
|
|
11
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
12
|
+
refusal: RefusalOptions;
|
|
8
13
|
};
|
|
9
14
|
declare const entity: FastifyPluginAsync<EntityRouteOptions>;
|
|
10
15
|
export default entity;
|
package/dist/routes/entity.js
CHANGED
|
@@ -1,44 +1,28 @@
|
|
|
1
|
-
import { z } from 'zod
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { applyTransformers, authoriseEntities } from '../transformers/default.js';
|
|
3
|
+
import { createEntityNotVisibleResponder } from '../utils/visibility.js';
|
|
4
4
|
const paramsSchema = z.object({
|
|
5
5
|
id: z.url(),
|
|
6
6
|
});
|
|
7
7
|
const entity = async (fastify, opts) => {
|
|
8
|
-
const { prisma,
|
|
8
|
+
const { prisma, access, entityTransformers = [], entityVisibilityFilter, refusal } = opts;
|
|
9
|
+
const sendEntityNotVisible = createEntityNotVisibleResponder(prisma, refusal);
|
|
9
10
|
fastify.withTypeProvider().get('/entity/:id', {
|
|
10
11
|
schema: {
|
|
11
12
|
params: paramsSchema,
|
|
12
13
|
},
|
|
13
14
|
}, async (request, reply) => {
|
|
14
15
|
const { id } = request.params;
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
}
|
|
23
|
-
const refMap = await resolveEntityReferences([entity], prisma);
|
|
24
|
-
const base = baseEntityTransformer(entity);
|
|
25
|
-
const standardEntity = {
|
|
26
|
-
...base,
|
|
27
|
-
memberOf: base.memberOf ? (refMap.get(base.memberOf) ?? null) : null,
|
|
28
|
-
rootCollection: base.rootCollection ? (refMap.get(base.rootCollection) ?? null) : null,
|
|
29
|
-
};
|
|
30
|
-
const authorisedEntity = await accessTransformer(standardEntity, { request, fastify });
|
|
31
|
-
let result = authorisedEntity;
|
|
32
|
-
for (const transformer of entityTransformers) {
|
|
33
|
-
result = await transformer(result, { request, fastify });
|
|
34
|
-
}
|
|
35
|
-
return result;
|
|
36
|
-
}
|
|
37
|
-
catch (error) {
|
|
38
|
-
const err = error;
|
|
39
|
-
fastify.log.error(`Database error: ${err.message}`);
|
|
40
|
-
return reply.code(500).send(createInternalError());
|
|
16
|
+
const context = { request, fastify };
|
|
17
|
+
const visibilityWhere = await entityVisibilityFilter(context);
|
|
18
|
+
const entity = await prisma.entity.findFirst({
|
|
19
|
+
where: { AND: [{ id }, visibilityWhere] },
|
|
20
|
+
});
|
|
21
|
+
if (!entity) {
|
|
22
|
+
return sendEntityNotVisible(reply, id, context);
|
|
41
23
|
}
|
|
24
|
+
const [authorisedEntity] = await authoriseEntities([entity], prisma, access, context);
|
|
25
|
+
return applyTransformers(authorisedEntity, entityTransformers, context, entity);
|
|
42
26
|
});
|
|
43
27
|
};
|
|
44
28
|
export default entity;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entity.js","sourceRoot":"","sources":["../../src/routes/entity.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"entity.js","sourceRoot":"","sources":["../../src/routes/entity.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAIlF,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,MAAM,GAA2C,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IAC7E,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,EAAE,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAC1F,MAAM,oBAAoB,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9E,OAAO,CAAC,gBAAgB,EAAmB,CAAC,GAAG,CAC7C,aAAa,EACb;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,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QACrC,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;YAC3C,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,eAAe,CAAC,EAAE;SAC1C,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,oBAAoB,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,CAAC,gBAAgB,CAAC,GAAG,MAAM,iBAAiB,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAEtF,OAAO,iBAAiB,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAClF,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,MAAM,CAAC"}
|
package/dist/routes/file.d.ts
CHANGED
|
@@ -1,9 +1,15 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
2
|
import type { PrismaClient } from '../generated/prisma/client.js';
|
|
3
|
-
import type {
|
|
3
|
+
import type { ContentSource } from '../storage/backend.js';
|
|
4
|
+
import type { AccessFunction } from '../types/access.js';
|
|
5
|
+
import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
6
|
+
import { type RefusalOptions } from '../utils/visibility.js';
|
|
4
7
|
type FileRouteOptions = {
|
|
5
8
|
prisma: PrismaClient;
|
|
6
|
-
|
|
9
|
+
content: ContentSource;
|
|
10
|
+
access: AccessFunction;
|
|
11
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
12
|
+
refusal: RefusalOptions;
|
|
7
13
|
};
|
|
8
14
|
declare const file: FastifyPluginAsync<FileRouteOptions>;
|
|
9
15
|
export default file;
|