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/dist/utils/visibility.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { createNotFoundError, sendRefusal } from './errors.js';
|
|
2
2
|
export const AllVisibleEntityFilter = () => ({});
|
|
3
|
-
export const AllVisibleSearchFilter = () => ({
|
|
3
|
+
export const AllVisibleSearchFilter = () => ({});
|
|
4
4
|
export const isAnonymous = async (isAuthenticated, context) => isAuthenticated ? !(await isAuthenticated(context)) : false;
|
|
5
5
|
export const createNotVisibleResponder = ({ promptLoginForHidden, isAuthenticated, notFoundMessage, exists }) => async (reply, id, context) => {
|
|
6
6
|
if (promptLoginForHidden && (await isAnonymous(isAuthenticated, context)) && (await exists(id))) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"visibility.js","sourceRoot":"","sources":["../../src/utils/visibility.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAO/D,MAAM,CAAC,MAAM,sBAAsB,GAA2B,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAOzE,MAAM,CAAC,MAAM,sBAAsB,GAA2B,GAAG,EAAE,CAAC,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"visibility.js","sourceRoot":"","sources":["../../src/utils/visibility.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAO/D,MAAM,CAAC,MAAM,sBAAsB,GAA2B,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAOzE,MAAM,CAAC,MAAM,sBAAsB,GAA2B,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAKzE,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,eAA4C,EAAE,OAAuB,EAAE,EAAE,CACzG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAgB9D,MAAM,CAAC,MAAM,yBAAyB,GACpC,CAAC,EAAE,oBAAoB,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,EAA8B,EAAE,EAAE,CACnG,KAAK,EAAE,KAAmB,EAAE,EAAU,EAAE,OAAuB,EAAE,EAAE;IACjE,IAAI,oBAAoB,IAAI,CAAC,MAAM,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAChG,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC;AACxE,CAAC,CAAC;AAEJ,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,MAAoB,EAAE,OAAuB,EAAE,EAAE,CAC/F,yBAAyB,CAAC;IACxB,GAAG,OAAO;IACV,eAAe,EAAE,oCAAoC;IACrD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC;CACzE,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"type": "module",
|
|
3
3
|
"name": "arocapi",
|
|
4
|
-
"version": "5.0.0-beta.
|
|
4
|
+
"version": "5.0.0-beta.7",
|
|
5
5
|
"description": "An RO-Crate API",
|
|
6
6
|
"main": "dist/app.js",
|
|
7
7
|
"exports": {
|
|
8
|
-
".": "./dist/app.js"
|
|
8
|
+
".": "./dist/app.js",
|
|
9
|
+
"./search/opensearch": "./dist/search/opensearch/opensearch.js",
|
|
10
|
+
"./search/postgres": "./dist/search/postgres/postgres.js",
|
|
11
|
+
"./storage/directory": "./dist/storage/directory/directory.js",
|
|
12
|
+
"./storage/entity-meta": "./dist/storage/entity-meta/entity-meta.js",
|
|
13
|
+
"./storage/s3": "./dist/storage/s3/s3.js",
|
|
14
|
+
"./storage/ocfl": "./dist/storage/ocfl/ocfl.js"
|
|
9
15
|
},
|
|
10
16
|
"keywords": [
|
|
11
17
|
"rocrate",
|
|
@@ -15,50 +21,65 @@
|
|
|
15
21
|
"license": "ISC",
|
|
16
22
|
"dependencies": {
|
|
17
23
|
"@fastify/sensible": "^6.0.7",
|
|
18
|
-
"@opensearch-project/opensearch": "^3.9.0",
|
|
19
|
-
"@prisma/config": "^7.10.0",
|
|
20
24
|
"content-disposition": "^3.0.0",
|
|
21
|
-
"dotenv": "^18.0.7",
|
|
22
|
-
"fastify": "^5.12.5",
|
|
23
25
|
"fastify-type-provider-zod": "^7.0.0",
|
|
24
|
-
"zod": "^4.6.
|
|
26
|
+
"zod": "^4.6.7"
|
|
25
27
|
},
|
|
26
28
|
"devDependencies": {
|
|
29
|
+
"@aws-sdk/client-s3": "^3.1153.0",
|
|
30
|
+
"@aws-sdk/s3-request-presigner": "^3.1153.0",
|
|
27
31
|
"@biomejs/biome": "^2.5.15",
|
|
28
|
-
"@commitlint/cli": "^21.2.
|
|
29
|
-
"@commitlint/config-conventional": "^21.2.
|
|
30
|
-
"@
|
|
31
|
-
"@
|
|
32
|
+
"@commitlint/cli": "^21.2.4",
|
|
33
|
+
"@commitlint/config-conventional": "^21.2.4",
|
|
34
|
+
"@ocfl/ocfl-fs": "^0.4.0",
|
|
35
|
+
"@opensearch-project/opensearch": "^3.9.0",
|
|
36
|
+
"@prisma/adapter-pg": "^7.10.1",
|
|
37
|
+
"@prisma/client": "^7.10.1",
|
|
38
|
+
"@prisma/config": "^7.10.1",
|
|
32
39
|
"@semantic-release/changelog": "^7.0.0",
|
|
33
40
|
"@semantic-release/git": "^11.0.1",
|
|
34
41
|
"@total-typescript/ts-reset": "^0.6.1",
|
|
35
42
|
"@types/node": "^26.6.5",
|
|
36
|
-
"@vitest/coverage-v8": "^5.0.
|
|
37
|
-
"@vitest/ui": "^5.0.
|
|
43
|
+
"@vitest/coverage-v8": "^5.0.5",
|
|
44
|
+
"@vitest/ui": "^5.0.5",
|
|
38
45
|
"concurrently": "^10.0.6",
|
|
39
46
|
"conventional-changelog-conventionalcommits": "^9.3.1",
|
|
47
|
+
"dotenv": "^18.0.8",
|
|
48
|
+
"fastify": "^5.12.7",
|
|
40
49
|
"fastify-tsconfig": "^3.0.0",
|
|
41
|
-
"knip": "^6.
|
|
42
|
-
"lefthook": "^2.2.
|
|
43
|
-
"prisma": "^7.10.
|
|
44
|
-
"prisma-json-types-generator": "^5.1.1",
|
|
50
|
+
"knip": "^6.42.0",
|
|
51
|
+
"lefthook": "^2.2.2",
|
|
52
|
+
"prisma": "^7.10.1",
|
|
45
53
|
"semantic-release": "^25.0.9",
|
|
46
54
|
"tsx": "^4.23.15",
|
|
47
55
|
"typescript": "^7.0.2",
|
|
48
|
-
"vitest": "^5.0.
|
|
56
|
+
"vitest": "^5.0.5",
|
|
49
57
|
"vitest-mock-extended": "^5.1.1"
|
|
50
58
|
},
|
|
51
59
|
"peerDependencies": {
|
|
52
|
-
"@
|
|
60
|
+
"@aws-sdk/client-s3": "^3",
|
|
61
|
+
"@aws-sdk/s3-request-presigner": "^3",
|
|
62
|
+
"@ocfl/ocfl-fs": "^0.4.0",
|
|
63
|
+
"@opensearch-project/opensearch": "^3.9.0",
|
|
64
|
+
"@prisma/client": "^7.10.0",
|
|
65
|
+
"fastify": "^5.12.7"
|
|
53
66
|
},
|
|
54
67
|
"files": [
|
|
55
68
|
"src",
|
|
56
69
|
"!src/generated",
|
|
70
|
+
"!src/index.dev.ts",
|
|
71
|
+
"!src/reset.d.ts",
|
|
72
|
+
"!src/**/*.test.ts",
|
|
73
|
+
"!src/test/**",
|
|
74
|
+
"!src/**/__snapshots__/**",
|
|
57
75
|
"dist",
|
|
58
|
-
"!dist/generated",
|
|
76
|
+
"!dist/generated/**/*.js",
|
|
77
|
+
"!dist/generated/**/*.js.map",
|
|
78
|
+
"!dist/index.dev.*",
|
|
79
|
+
"!dist/**/*.test.*",
|
|
80
|
+
"!dist/test/**",
|
|
59
81
|
"README.md",
|
|
60
|
-
"prisma/models"
|
|
61
|
-
"prisma.config.ts"
|
|
82
|
+
"prisma/models"
|
|
62
83
|
],
|
|
63
84
|
"scripts": {
|
|
64
85
|
"build": "tsc",
|
|
@@ -66,13 +87,15 @@
|
|
|
66
87
|
"dev": "pnpm run dev:clean && pnpm run build && concurrently -k -p \"[{name}]\" -n \"TypeScript,App\" -c \"yellow.bold,cyan.bold\" \"pnpm:dev:start\" \"pnpm:watch\" ",
|
|
67
88
|
"dev:start": "node --watch --env-file=.env dist/index.dev.js",
|
|
68
89
|
"dev:clean": "rm -rf dist",
|
|
69
|
-
"dbconsole": "docker compose exec db
|
|
70
|
-
"load-test-data": "tsx
|
|
90
|
+
"dbconsole": "docker compose exec db psql -U postgres catalog",
|
|
91
|
+
"load-test-data": "tsx scripts/loadEntities.ts",
|
|
92
|
+
"fixtures:ocfl": "node scripts/buildOcflFixtures.ts",
|
|
71
93
|
"lint:biome": "biome check",
|
|
72
94
|
"lint:types": "tsc --noEmit",
|
|
73
95
|
"lint:examples": "tsc --emitDeclarationOnly && tsc -p website/examples",
|
|
96
|
+
"lint:consumer": "./scripts/check-consumer-types.sh",
|
|
74
97
|
"lint:knip": "knip",
|
|
75
|
-
"lint": "prisma generate >/dev/null && concurrently -p \"[{name}]\" -n \"biome,types,knip,examples\" -c \"yellow.bold,cyan.bold,magenta.bold,green.bold\" \"pnpm:lint:biome\" \"pnpm:lint:types\" \"pnpm:lint:knip\" \"pnpm:lint:examples\"",
|
|
98
|
+
"lint": "prisma generate >/dev/null && concurrently -p \"[{name}]\" -n \"biome,types,knip,examples,consumer\" -c \"yellow.bold,cyan.bold,magenta.bold,green.bold,blue.bold\" \"pnpm:lint:biome\" \"pnpm:lint:types\" \"pnpm:lint:knip\" \"pnpm:lint:examples\" \"pnpm:lint:consumer\"",
|
|
76
99
|
"test": "./scripts/setup-integration.sh vitest run",
|
|
77
100
|
"test:ci": "vitest run",
|
|
78
101
|
"test:watch": "./scripts/setup-integration.sh && vitest",
|
|
@@ -91,5 +114,22 @@
|
|
|
91
114
|
"registry": "https://registry.npmjs.org/",
|
|
92
115
|
"provenance": true
|
|
93
116
|
},
|
|
94
|
-
"packageManager": "pnpm@12.11.2"
|
|
117
|
+
"packageManager": "pnpm@12.11.2",
|
|
118
|
+
"peerDependenciesMeta": {
|
|
119
|
+
"@aws-sdk/client-s3": {
|
|
120
|
+
"optional": true
|
|
121
|
+
},
|
|
122
|
+
"@aws-sdk/s3-request-presigner": {
|
|
123
|
+
"optional": true
|
|
124
|
+
},
|
|
125
|
+
"@ocfl/ocfl-fs": {
|
|
126
|
+
"optional": true
|
|
127
|
+
},
|
|
128
|
+
"@opensearch-project/opensearch": {
|
|
129
|
+
"optional": true
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
"engines": {
|
|
133
|
+
"node": ">=22.18"
|
|
134
|
+
}
|
|
95
135
|
}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
model Entity {
|
|
2
|
-
id String @id
|
|
2
|
+
id String @id
|
|
3
3
|
|
|
4
|
-
name String
|
|
5
|
-
description String
|
|
4
|
+
name String
|
|
5
|
+
description String
|
|
6
6
|
|
|
7
|
-
entityType String
|
|
8
|
-
memberOf String?
|
|
9
|
-
rootCollection String?
|
|
10
|
-
metadataLicenseId String
|
|
11
|
-
contentLicenseId String
|
|
7
|
+
entityType String
|
|
8
|
+
memberOf String?
|
|
9
|
+
rootCollection String?
|
|
10
|
+
metadataLicenseId String
|
|
11
|
+
contentLicenseId String
|
|
12
12
|
|
|
13
13
|
meta Json?
|
|
14
14
|
|
|
@@ -16,6 +16,7 @@ model Entity {
|
|
|
16
16
|
updatedAt DateTime @updatedAt
|
|
17
17
|
|
|
18
18
|
file File?
|
|
19
|
+
search EntitySearch?
|
|
19
20
|
|
|
20
21
|
@@index([memberOf])
|
|
21
22
|
@@index([rootCollection])
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/// One entity's search document, written by PostgresBackend through raw SQL
|
|
2
|
+
model EntitySearch {
|
|
3
|
+
id String @id
|
|
4
|
+
|
|
5
|
+
/// The document's declared values by field name, with dates as UTC ISO strings and without the geo field
|
|
6
|
+
values Json @default("{}")
|
|
7
|
+
/// Basic search text, weighted A–D from field weights 4–1
|
|
8
|
+
basic Unsupported("tsvector")
|
|
9
|
+
/// Every text field's lexemes, each prefixed with `<field>.`
|
|
10
|
+
text Unsupported("tsvector")
|
|
11
|
+
point Unsupported("point")?
|
|
12
|
+
geohash String?
|
|
13
|
+
|
|
14
|
+
entity Entity @relation(fields: [id], references: [id], onDelete: Cascade)
|
|
15
|
+
|
|
16
|
+
@@index([values(ops: JsonbPathOps)], type: Gin)
|
|
17
|
+
@@index([basic], type: Gin)
|
|
18
|
+
@@index([text], type: Gin)
|
|
19
|
+
@@index([point], type: Gist)
|
|
20
|
+
@@map("entity_search")
|
|
21
|
+
}
|
package/src/app.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import sensible from '@fastify/sensible';
|
|
2
|
-
import type { Client } from '@opensearch-project/opensearch';
|
|
3
2
|
import type { FastifyPluginAsync } from 'fastify';
|
|
4
3
|
import type { PrismaClient } from './generated/prisma/client.js';
|
|
5
4
|
import capabilities from './routes/capabilities.js';
|
|
@@ -9,16 +8,57 @@ import file from './routes/file.js';
|
|
|
9
8
|
import files from './routes/files.js';
|
|
10
9
|
import metadata from './routes/metadata.js';
|
|
11
10
|
import search from './routes/search.js';
|
|
11
|
+
import type { SearchBackend } from './search/backend.js';
|
|
12
|
+
import type { SearchVisibilityWhere } from './search/visibility.js';
|
|
13
|
+
import type { StorageBackend } from './storage/backend.js';
|
|
12
14
|
import type { AccessFunction } from './types/access.js';
|
|
13
|
-
import type { IsAuthenticated } from './types/context.js';
|
|
14
|
-
import type { FileHandler, RoCrateHandler } from './types/fileHandlers.js';
|
|
15
|
+
import type { IsAuthenticated, RequestContext } from './types/context.js';
|
|
15
16
|
import type { EntityTransformer, FileTransformer } from './types/transformers.js';
|
|
16
|
-
import type { EntityVisibilityFilter
|
|
17
|
+
import type { EntityVisibilityFilter } from './types/visibility.js';
|
|
17
18
|
import { notFoundHandler } from './utils/errors.js';
|
|
18
|
-
import type { FacetCapability, FilterCapability, QueryBuilderOptions, SearchCapability } from './utils/queryBuilder.js';
|
|
19
|
-
import { OpensearchQueryBuilder } from './utils/queryBuilder.js';
|
|
20
19
|
import { setupValidation } from './utils/validation.js';
|
|
21
20
|
|
|
21
|
+
export type {
|
|
22
|
+
AdvancedQuery,
|
|
23
|
+
BackendSearchCapability,
|
|
24
|
+
BoundingBox,
|
|
25
|
+
FacetBucket,
|
|
26
|
+
RangeBound,
|
|
27
|
+
RangeFilter,
|
|
28
|
+
SearchBackend,
|
|
29
|
+
SearchExtra,
|
|
30
|
+
SearchRequest,
|
|
31
|
+
SearchResult,
|
|
32
|
+
} from './search/backend.js';
|
|
33
|
+
export { SearchQueryError } from './search/backend.js';
|
|
34
|
+
export type {
|
|
35
|
+
FieldDeclaration,
|
|
36
|
+
FieldDeclarations,
|
|
37
|
+
FieldType,
|
|
38
|
+
GeoPoint,
|
|
39
|
+
SearchDocument,
|
|
40
|
+
} from './search/fields.js';
|
|
41
|
+
export { capabilitiesFromFields } from './search/fields.js';
|
|
42
|
+
export type { SearchVisibilityWhere, VisibilityCondition } from './search/visibility.js';
|
|
43
|
+
export { checkSearchVisibility } from './search/visibility.js';
|
|
44
|
+
export type {
|
|
45
|
+
ContentContext,
|
|
46
|
+
ContentDelivery,
|
|
47
|
+
ContentSource,
|
|
48
|
+
DeliveryHeaders,
|
|
49
|
+
DirectoryStorageMeta,
|
|
50
|
+
JsonDelivery,
|
|
51
|
+
MetadataDelivery,
|
|
52
|
+
MetadataSource,
|
|
53
|
+
OcflLocation,
|
|
54
|
+
OcflStorageMeta,
|
|
55
|
+
PathDelivery,
|
|
56
|
+
RedirectDelivery,
|
|
57
|
+
S3StorageMeta,
|
|
58
|
+
StorageBackend,
|
|
59
|
+
StorageLocate,
|
|
60
|
+
StreamDelivery,
|
|
61
|
+
} from './storage/backend.js';
|
|
22
62
|
export type {
|
|
23
63
|
AuthorisedEntity,
|
|
24
64
|
AuthorisedFile,
|
|
@@ -28,19 +68,6 @@ export type {
|
|
|
28
68
|
} from './transformers/default.js';
|
|
29
69
|
export type { AccessFunction, AccessInfo } from './types/access.js';
|
|
30
70
|
export type { IsAuthenticated, RequestContext } from './types/context.js';
|
|
31
|
-
export type {
|
|
32
|
-
FileHandler,
|
|
33
|
-
FileMetadata,
|
|
34
|
-
FilePathResult,
|
|
35
|
-
FileRedirectResult,
|
|
36
|
-
FileResult,
|
|
37
|
-
FileStreamResult,
|
|
38
|
-
GetFileHandler,
|
|
39
|
-
GetRoCrateHandler,
|
|
40
|
-
HeadFileHandler,
|
|
41
|
-
HeadRoCrateHandler,
|
|
42
|
-
RoCrateHandler,
|
|
43
|
-
} from './types/fileHandlers.js';
|
|
44
71
|
export type { EntityTransformer, FileTransformer } from './types/transformers.js';
|
|
45
72
|
export type { EntityVisibilityFilter, SearchVisibilityFilter } from './types/visibility.js';
|
|
46
73
|
export type { LicenceAccessOptions } from './utils/access.js';
|
|
@@ -58,8 +85,6 @@ export {
|
|
|
58
85
|
notFoundHandler,
|
|
59
86
|
} from './utils/errors.js';
|
|
60
87
|
export { AllVisibleEntityFilter, AllVisibleSearchFilter } from './utils/visibility.js';
|
|
61
|
-
export type { FacetCapability, FilterCapability, QueryBuilderOptions, SearchCapability };
|
|
62
|
-
export { OpensearchQueryBuilder };
|
|
63
88
|
|
|
64
89
|
const DOCS_URL = 'https://arocapi.crate-works.org';
|
|
65
90
|
|
|
@@ -72,44 +97,55 @@ const REMOVED_OPTIONS: Record<string, { replacement: string; docs: string }> = {
|
|
|
72
97
|
},
|
|
73
98
|
};
|
|
74
99
|
|
|
100
|
+
type PrismaMethod = (args: never) => PromiseLike<unknown>;
|
|
101
|
+
type PrismaDelegate = Record<'findMany' | 'findFirst' | 'count', PrismaMethod>;
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* The Prisma client arocapi needs: any Prisma 7 client generated from a schema that includes the arocapi models,
|
|
105
|
+
* including one with extra models, a `$extends` client or the client inside `$transaction`
|
|
106
|
+
*/
|
|
107
|
+
export type ArocapiPrismaClient = { entity: PrismaDelegate; file: PrismaDelegate };
|
|
108
|
+
|
|
75
109
|
export type Options = {
|
|
76
|
-
prisma:
|
|
77
|
-
|
|
78
|
-
queryBuilderClass?: typeof OpensearchQueryBuilder;
|
|
79
|
-
queryBuilderOptions?: QueryBuilderOptions;
|
|
110
|
+
prisma: ArocapiPrismaClient;
|
|
111
|
+
search: SearchBackend;
|
|
80
112
|
access: AccessFunction;
|
|
81
113
|
entityTransformers?: EntityTransformer[];
|
|
82
114
|
fileTransformers?: FileTransformer[];
|
|
83
|
-
|
|
84
|
-
|
|
115
|
+
/** Where Metadata and Content come from */
|
|
116
|
+
storage: StorageBackend;
|
|
85
117
|
entityVisibilityFilter: EntityVisibilityFilter;
|
|
86
|
-
|
|
118
|
+
/** A `SearchVisibilityFilter<typeof fields>` for the search backend's declared fields */
|
|
119
|
+
searchVisibilityFilter: (context: RequestContext) => Promise<SearchVisibilityWhere> | SearchVisibilityWhere;
|
|
87
120
|
isAuthenticated?: IsAuthenticated;
|
|
88
121
|
promptLoginForHidden?: boolean;
|
|
89
122
|
};
|
|
90
123
|
const app: FastifyPluginAsync<Options> = async (fastify, options) => {
|
|
91
124
|
const {
|
|
92
|
-
|
|
93
|
-
opensearch,
|
|
94
|
-
queryBuilderClass,
|
|
95
|
-
queryBuilderOptions,
|
|
125
|
+
search: searchBackend,
|
|
96
126
|
access,
|
|
97
127
|
entityTransformers,
|
|
98
128
|
fileTransformers,
|
|
99
|
-
|
|
100
|
-
roCrateHandler,
|
|
129
|
+
storage,
|
|
101
130
|
entityVisibilityFilter,
|
|
102
131
|
searchVisibilityFilter,
|
|
103
132
|
isAuthenticated,
|
|
104
133
|
promptLoginForHidden = false,
|
|
105
134
|
} = options;
|
|
106
135
|
|
|
107
|
-
if (!prisma) {
|
|
136
|
+
if (!options.prisma) {
|
|
108
137
|
throw new Error('Prisma client is required');
|
|
109
138
|
}
|
|
110
139
|
|
|
111
|
-
if (
|
|
112
|
-
throw new Error('
|
|
140
|
+
if (typeof options.prisma.entity?.findMany !== 'function' || typeof options.prisma.file?.findMany !== 'function') {
|
|
141
|
+
throw new Error('prisma must be a Prisma 7 client generated from a schema that includes the arocapi models');
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
// Consumers generate their own client, whose delegate generics never match ours; the routes need the full type
|
|
145
|
+
const prisma = options.prisma as PrismaClient;
|
|
146
|
+
|
|
147
|
+
if (!searchBackend) {
|
|
148
|
+
throw new Error('search is required');
|
|
113
149
|
}
|
|
114
150
|
|
|
115
151
|
for (const [removed, { replacement, docs }] of Object.entries(REMOVED_OPTIONS)) {
|
|
@@ -122,12 +158,16 @@ const app: FastifyPluginAsync<Options> = async (fastify, options) => {
|
|
|
122
158
|
throw new Error('access is required');
|
|
123
159
|
}
|
|
124
160
|
|
|
125
|
-
if (!
|
|
126
|
-
throw new Error('
|
|
161
|
+
if (!storage) {
|
|
162
|
+
throw new Error('storage is required');
|
|
127
163
|
}
|
|
128
164
|
|
|
129
|
-
if (!
|
|
130
|
-
throw new Error('
|
|
165
|
+
if (!storage.metadata) {
|
|
166
|
+
throw new Error('storage.metadata is required');
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
if (!storage.content) {
|
|
170
|
+
throw new Error('storage.content is required');
|
|
131
171
|
}
|
|
132
172
|
|
|
133
173
|
if (!entityVisibilityFilter) {
|
|
@@ -153,20 +193,17 @@ const app: FastifyPluginAsync<Options> = async (fastify, options) => {
|
|
|
153
193
|
fastify.setNotFoundHandler(notFoundHandler);
|
|
154
194
|
}
|
|
155
195
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
fastify.register(capabilities, { queryBuilder });
|
|
196
|
+
fastify.register(capabilities, { search: searchBackend });
|
|
159
197
|
fastify.register(entities, { prisma, access, entityTransformers, entityVisibilityFilter });
|
|
160
198
|
fastify.register(entity, { prisma, access, entityTransformers, entityVisibilityFilter, refusal });
|
|
161
199
|
fastify.register(files, { prisma, access, fileTransformers, entityVisibilityFilter });
|
|
162
|
-
fastify.register(file, { prisma,
|
|
163
|
-
fastify.register(metadata, { prisma,
|
|
200
|
+
fastify.register(file, { prisma, content: storage.content, access, entityVisibilityFilter, refusal });
|
|
201
|
+
fastify.register(metadata, { prisma, metadata: storage.metadata, access, entityVisibilityFilter, refusal });
|
|
164
202
|
fastify.register(search, {
|
|
165
203
|
prisma,
|
|
166
|
-
|
|
204
|
+
search: searchBackend,
|
|
167
205
|
access,
|
|
168
206
|
entityTransformers,
|
|
169
|
-
queryBuilder,
|
|
170
207
|
entityVisibilityFilter,
|
|
171
208
|
searchVisibilityFilter,
|
|
172
209
|
});
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { FastifyPluginAsync } from 'fastify';
|
|
2
|
-
import type {
|
|
2
|
+
import type { SearchBackend } from '../search/backend.js';
|
|
3
3
|
|
|
4
|
-
const SPEC_VERSION = '0.
|
|
4
|
+
const SPEC_VERSION = '0.5.0';
|
|
5
5
|
|
|
6
6
|
type CapabilitiesRouteOptions = {
|
|
7
|
-
|
|
7
|
+
search: SearchBackend;
|
|
8
8
|
};
|
|
9
9
|
|
|
10
10
|
const capabilities: FastifyPluginAsync<CapabilitiesRouteOptions> = async (fastify, opts) => {
|
|
@@ -13,7 +13,7 @@ const capabilities: FastifyPluginAsync<CapabilitiesRouteOptions> = async (fastif
|
|
|
13
13
|
deposit: { supported: false },
|
|
14
14
|
tombstonePolicy: '404',
|
|
15
15
|
extensions: {},
|
|
16
|
-
search: opts.
|
|
16
|
+
search: opts.search.capabilities,
|
|
17
17
|
};
|
|
18
18
|
|
|
19
19
|
fastify.get('/capabilities', async () => document);
|
package/src/routes/entities.ts
CHANGED
|
@@ -10,14 +10,15 @@ import type { EntityVisibilityFilter } from '../types/visibility.js';
|
|
|
10
10
|
const querySchema = z.object({
|
|
11
11
|
memberOf: z.url().optional(),
|
|
12
12
|
entityType: z
|
|
13
|
-
.string()
|
|
14
|
-
.
|
|
15
|
-
.transform((val) =>
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
13
|
+
.union([z.string(), z.array(z.string())])
|
|
14
|
+
.default([])
|
|
15
|
+
.transform((val) =>
|
|
16
|
+
[val]
|
|
17
|
+
.flat()
|
|
18
|
+
.map((value) => value.trim())
|
|
19
|
+
.filter(Boolean),
|
|
20
|
+
)
|
|
21
|
+
.pipe(z.array(z.url())),
|
|
21
22
|
limit: z.coerce.number().int().min(1).max(1000).default(100),
|
|
22
23
|
offset: z.coerce.number().int().min(0).default(0),
|
|
23
24
|
sort: z.enum(['id', 'name', 'createdAt', 'updatedAt']).default('id'),
|
|
@@ -49,7 +50,7 @@ const entities: FastifyPluginAsync<EntitiesRouteOptions> = async (fastify, opts)
|
|
|
49
50
|
where.memberOf = memberOf;
|
|
50
51
|
}
|
|
51
52
|
|
|
52
|
-
if (entityType
|
|
53
|
+
if (entityType.length > 0) {
|
|
53
54
|
where.entityType = {
|
|
54
55
|
in: entityType,
|
|
55
56
|
};
|