arocapi 5.0.0-beta.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 -802
- package/dist/app.d.ts +38 -20
- package/dist/app.js +62 -40
- 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 +37 -57
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/entity.d.ts +7 -2
- package/dist/routes/entity.js +13 -29
- package/dist/routes/entity.js.map +1 -1
- package/dist/routes/file.d.ts +8 -2
- package/dist/routes/file.js +37 -72
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/files.d.ts +5 -2
- package/dist/routes/files.js +24 -39
- package/dist/routes/files.js.map +1 -1
- package/dist/routes/metadata.d.ts +11 -5
- package/dist/routes/metadata.js +24 -68
- package/dist/routes/metadata.js.map +1 -1
- package/dist/routes/search.d.ts +8 -7
- package/dist/routes/search.js +90 -119
- 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 +82 -40
- 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 +168 -95
- package/src/routes/capabilities.ts +22 -0
- package/src/routes/entities.ts +48 -67
- package/src/routes/entity.ts +21 -35
- package/src/routes/file.ts +53 -103
- package/src/routes/files.ts +31 -47
- package/src/routes/metadata.ts +42 -98
- package/src/routes/search.ts +131 -151
- 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 -82
- package/dist/app.test.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.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 -187
- 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 -112
- 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/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 -209
- 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/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.10",
|
|
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",
|
|
@@ -14,50 +20,66 @@
|
|
|
14
20
|
"author": "John Ferlito <johnf@inodes.org>",
|
|
15
21
|
"license": "ISC",
|
|
16
22
|
"dependencies": {
|
|
17
|
-
"@fastify/sensible": "^6.0.
|
|
18
|
-
"
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
"fastify": "^5.8.4",
|
|
22
|
-
"fastify-type-provider-zod": "^6.1.0",
|
|
23
|
-
"zod": "^4.3.6"
|
|
23
|
+
"@fastify/sensible": "^6.0.7",
|
|
24
|
+
"content-disposition": "^3.0.0",
|
|
25
|
+
"fastify-type-provider-zod": "^7.0.0",
|
|
26
|
+
"zod": "^4.6.7"
|
|
24
27
|
},
|
|
25
28
|
"devDependencies": {
|
|
26
|
-
"@
|
|
27
|
-
"@
|
|
28
|
-
"@
|
|
29
|
-
"@
|
|
30
|
-
"@
|
|
31
|
-
"@
|
|
32
|
-
"@
|
|
29
|
+
"@aws-sdk/client-s3": "^3.1157.0",
|
|
30
|
+
"@aws-sdk/s3-request-presigner": "^3.1157.0",
|
|
31
|
+
"@biomejs/biome": "^2.6.3",
|
|
32
|
+
"@commitlint/cli": "^21.2.4",
|
|
33
|
+
"@commitlint/config-conventional": "^21.2.4",
|
|
34
|
+
"@ocfl/ocfl-fs": "^1.0.0-beta.59",
|
|
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",
|
|
39
|
+
"@semantic-release/changelog": "^7.0.0",
|
|
40
|
+
"@semantic-release/git": "^11.0.1",
|
|
33
41
|
"@total-typescript/ts-reset": "^0.6.1",
|
|
34
|
-
"@types/node": "^
|
|
35
|
-
"@vitest/coverage-v8": "^
|
|
36
|
-
"@vitest/ui": "^
|
|
37
|
-
"concurrently": "^
|
|
38
|
-
"conventional-changelog-conventionalcommits": "^9.3.
|
|
42
|
+
"@types/node": "^26.6.5",
|
|
43
|
+
"@vitest/coverage-v8": "^5.0.5",
|
|
44
|
+
"@vitest/ui": "^5.0.5",
|
|
45
|
+
"concurrently": "^10.0.6",
|
|
46
|
+
"conventional-changelog-conventionalcommits": "^9.3.1",
|
|
47
|
+
"dotenv": "^18.0.9",
|
|
48
|
+
"fastify": "^5.12.7",
|
|
39
49
|
"fastify-tsconfig": "^3.0.0",
|
|
40
|
-
"knip": "^6.0
|
|
41
|
-
"lefthook": "^2.
|
|
42
|
-
"prisma": "^7.
|
|
43
|
-
"
|
|
44
|
-
"
|
|
45
|
-
"
|
|
46
|
-
"
|
|
47
|
-
"vitest": "^
|
|
48
|
-
"vitest-mock-extended": "^3.1.0"
|
|
50
|
+
"knip": "^6.43.0",
|
|
51
|
+
"lefthook": "^2.2.2",
|
|
52
|
+
"prisma": "^7.10.1",
|
|
53
|
+
"semantic-release": "^25.0.9",
|
|
54
|
+
"tsx": "^4.23.15",
|
|
55
|
+
"typescript": "^7.0.2",
|
|
56
|
+
"vitest": "^5.0.5",
|
|
57
|
+
"vitest-mock-extended": "^5.1.1"
|
|
49
58
|
},
|
|
50
59
|
"peerDependencies": {
|
|
51
|
-
"@
|
|
60
|
+
"@aws-sdk/client-s3": "^3",
|
|
61
|
+
"@aws-sdk/s3-request-presigner": "^3",
|
|
62
|
+
"@ocfl/ocfl-fs": "^1.0.0-beta.59",
|
|
63
|
+
"@opensearch-project/opensearch": "^3.9.0",
|
|
64
|
+
"@prisma/client": "^7.10.0",
|
|
65
|
+
"fastify": "^5.12.7"
|
|
52
66
|
},
|
|
53
67
|
"files": [
|
|
54
68
|
"src",
|
|
55
69
|
"!src/generated",
|
|
70
|
+
"!src/index.dev.ts",
|
|
71
|
+
"!src/reset.d.ts",
|
|
72
|
+
"!src/**/*.test.ts",
|
|
73
|
+
"!src/test/**",
|
|
74
|
+
"!src/**/__snapshots__/**",
|
|
56
75
|
"dist",
|
|
57
|
-
"!dist/generated",
|
|
76
|
+
"!dist/generated/**/*.js",
|
|
77
|
+
"!dist/generated/**/*.js.map",
|
|
78
|
+
"!dist/index.dev.*",
|
|
79
|
+
"!dist/**/*.test.*",
|
|
80
|
+
"!dist/test/**",
|
|
58
81
|
"README.md",
|
|
59
|
-
"prisma/models"
|
|
60
|
-
"prisma.config.ts"
|
|
82
|
+
"prisma/models"
|
|
61
83
|
],
|
|
62
84
|
"scripts": {
|
|
63
85
|
"build": "tsc",
|
|
@@ -65,29 +87,49 @@
|
|
|
65
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\" ",
|
|
66
88
|
"dev:start": "node --watch --env-file=.env dist/index.dev.js",
|
|
67
89
|
"dev:clean": "rm -rf dist",
|
|
68
|
-
"dbconsole": "docker compose exec db
|
|
69
|
-
"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",
|
|
70
93
|
"lint:biome": "biome check",
|
|
71
94
|
"lint:types": "tsc --noEmit",
|
|
95
|
+
"lint:examples": "tsc --emitDeclarationOnly && tsc -p website/examples",
|
|
96
|
+
"lint:consumer": "./scripts/check-consumer-types.sh",
|
|
72
97
|
"lint:knip": "knip",
|
|
73
|
-
"lint": "concurrently -p \"[{name}]\" -n \"biome,types,knip\" -c \"yellow.bold,cyan.bold,magenta.bold\" \"pnpm:lint:biome\" \"pnpm:lint:types\" \"pnpm:lint:knip\"",
|
|
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\"",
|
|
74
99
|
"test": "./scripts/setup-integration.sh vitest run",
|
|
75
100
|
"test:ci": "vitest run",
|
|
76
101
|
"test:watch": "./scripts/setup-integration.sh && vitest",
|
|
77
102
|
"test:ui": "./scripts/setup-integration.sh && vitest --ui",
|
|
78
103
|
"test:coverage": "./scripts/setup-integration.sh vitest run --coverage",
|
|
79
|
-
"generate": "
|
|
104
|
+
"generate": "prisma generate",
|
|
80
105
|
"db:generate": "prisma generate",
|
|
81
106
|
"db:migrate": "prisma migrate deploy",
|
|
82
107
|
"seed": "rm -rf dist && pnpm run build && node --env-file=.env example/data/seed.ts"
|
|
83
108
|
},
|
|
84
109
|
"repository": {
|
|
85
110
|
"type": "git",
|
|
86
|
-
"url": "https://github.com/
|
|
111
|
+
"url": "https://github.com/crate-works/arocapi"
|
|
87
112
|
},
|
|
88
113
|
"publishConfig": {
|
|
89
114
|
"registry": "https://registry.npmjs.org/",
|
|
90
115
|
"provenance": true
|
|
91
116
|
},
|
|
92
|
-
"packageManager": "pnpm@
|
|
117
|
+
"packageManager": "pnpm@12.15.0",
|
|
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
|
+
}
|
|
93
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,140 +1,213 @@
|
|
|
1
1
|
import sensible from '@fastify/sensible';
|
|
2
|
-
import type {
|
|
3
|
-
import type { FastifyInstance, FastifyPluginAsync } from 'fastify';
|
|
4
|
-
import { hasZodFastifySchemaValidationErrors, serializerCompiler, validatorCompiler } from 'fastify-type-provider-zod';
|
|
2
|
+
import type { FastifyPluginAsync } from 'fastify';
|
|
5
3
|
import type { PrismaClient } from './generated/prisma/client.js';
|
|
4
|
+
import capabilities from './routes/capabilities.js';
|
|
6
5
|
import entities from './routes/entities.js';
|
|
7
6
|
import entity from './routes/entity.js';
|
|
8
7
|
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';
|
|
12
|
-
import type {
|
|
13
|
-
import type {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
} from './types/
|
|
19
|
-
import {
|
|
20
|
-
import
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
export type { AuthorisedEntity, AuthorisedFile, StandardEntity, StandardFile } from './transformers/default.js';
|
|
24
|
-
export { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from './transformers/default.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';
|
|
14
|
+
import type { AccessFunction } from './types/access.js';
|
|
15
|
+
import type { IsAuthenticated, RequestContext } from './types/context.js';
|
|
16
|
+
import type { EntityTransformer, FileTransformer } from './types/transformers.js';
|
|
17
|
+
import type { EntityVisibilityFilter } from './types/visibility.js';
|
|
18
|
+
import { notFoundHandler } from './utils/errors.js';
|
|
19
|
+
import { setupValidation } from './utils/validation.js';
|
|
20
|
+
|
|
25
21
|
export type {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
} from './types/fileHandlers.js';
|
|
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';
|
|
39
34
|
export type {
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
} from './
|
|
46
|
-
export
|
|
47
|
-
export {
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
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';
|
|
62
|
+
export type {
|
|
63
|
+
AuthorisedEntity,
|
|
64
|
+
AuthorisedFile,
|
|
65
|
+
BaseEntity,
|
|
66
|
+
EntityRow,
|
|
67
|
+
FileRow,
|
|
68
|
+
StandardEntity,
|
|
69
|
+
StandardFile,
|
|
70
|
+
} from './transformers/default.js';
|
|
71
|
+
export type { AccessFunction, AccessInfo } from './types/access.js';
|
|
72
|
+
export type { IsAuthenticated, RequestContext } from './types/context.js';
|
|
73
|
+
export type { EntityTransformer, FileTransformer } from './types/transformers.js';
|
|
74
|
+
export type { EntityVisibilityFilter, SearchVisibilityFilter } from './types/visibility.js';
|
|
75
|
+
export type { LicenceAccessOptions } from './utils/access.js';
|
|
76
|
+
export { AllPublicAccess, LicenceAccess } from './utils/access.js';
|
|
77
|
+
export type { ErrorCode, StandardErrorResponse } from './utils/errors.js';
|
|
78
|
+
export {
|
|
79
|
+
createAuthenticationRequiredError,
|
|
80
|
+
createError,
|
|
81
|
+
createForbiddenError,
|
|
82
|
+
createInternalError,
|
|
83
|
+
createNotFoundError,
|
|
84
|
+
createValidationError,
|
|
85
|
+
ERROR_CODES,
|
|
86
|
+
errorHandler,
|
|
87
|
+
notFoundHandler,
|
|
88
|
+
} from './utils/errors.js';
|
|
89
|
+
export { AllVisibleEntityFilter, AllVisibleSearchFilter } from './utils/visibility.js';
|
|
63
90
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
91
|
+
const DOCS_URL = 'https://arocapi.crate-works.org';
|
|
92
|
+
|
|
93
|
+
const REMOVED_OPTIONS: Record<string, { replacement: string; docs: string }> = {
|
|
94
|
+
accessTransformer: { replacement: 'access', docs: `${DOCS_URL}/configuration/access/` },
|
|
95
|
+
fileAccessTransformer: { replacement: 'access', docs: `${DOCS_URL}/configuration/access/` },
|
|
96
|
+
hiddenResponse: {
|
|
97
|
+
replacement: 'promptLoginForHidden and isAuthenticated',
|
|
98
|
+
docs: `${DOCS_URL}/configuration/visibility/#promptloginforhidden`,
|
|
99
|
+
},
|
|
71
100
|
};
|
|
72
101
|
|
|
102
|
+
type PrismaMethod = (args: never) => PromiseLike<unknown>;
|
|
103
|
+
type PrismaDelegate = Record<'findMany' | 'findFirst' | 'count', PrismaMethod>;
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* The Prisma client arocapi needs: any Prisma 7 client generated from a schema that includes the arocapi models,
|
|
107
|
+
* including one with extra models, a `$extends` client or the client inside `$transaction`
|
|
108
|
+
*/
|
|
109
|
+
export type ArocapiPrismaClient = { entity: PrismaDelegate; file: PrismaDelegate };
|
|
110
|
+
|
|
73
111
|
export type Options = {
|
|
74
|
-
prisma:
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
queryBuilderOptions?: QueryBuilderOptions;
|
|
78
|
-
accessTransformer: AccessTransformer;
|
|
112
|
+
prisma: ArocapiPrismaClient;
|
|
113
|
+
search: SearchBackend;
|
|
114
|
+
access: AccessFunction;
|
|
79
115
|
entityTransformers?: EntityTransformer[];
|
|
80
|
-
fileAccessTransformer: FileAccessTransformer;
|
|
81
116
|
fileTransformers?: FileTransformer[];
|
|
82
|
-
|
|
83
|
-
|
|
117
|
+
/** Where Metadata and Content come from */
|
|
118
|
+
storage: StorageBackend;
|
|
119
|
+
entityVisibilityFilter: EntityVisibilityFilter;
|
|
120
|
+
/** A `SearchVisibilityFilter<typeof fields>` for the search backend's declared fields */
|
|
121
|
+
searchVisibilityFilter: (context: RequestContext) => Promise<SearchVisibilityWhere> | SearchVisibilityWhere;
|
|
122
|
+
isAuthenticated?: IsAuthenticated;
|
|
123
|
+
promptLoginForHidden?: boolean;
|
|
84
124
|
};
|
|
85
125
|
const app: FastifyPluginAsync<Options> = async (fastify, options) => {
|
|
86
126
|
const {
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
queryBuilderClass,
|
|
90
|
-
queryBuilderOptions,
|
|
91
|
-
accessTransformer,
|
|
127
|
+
search: searchBackend,
|
|
128
|
+
access,
|
|
92
129
|
entityTransformers,
|
|
93
|
-
fileAccessTransformer,
|
|
94
130
|
fileTransformers,
|
|
95
|
-
|
|
96
|
-
|
|
131
|
+
storage,
|
|
132
|
+
entityVisibilityFilter,
|
|
133
|
+
searchVisibilityFilter,
|
|
134
|
+
isAuthenticated,
|
|
135
|
+
promptLoginForHidden = false,
|
|
97
136
|
} = options;
|
|
98
137
|
|
|
99
|
-
if (!prisma) {
|
|
138
|
+
if (!options.prisma) {
|
|
100
139
|
throw new Error('Prisma client is required');
|
|
101
140
|
}
|
|
102
141
|
|
|
103
|
-
if (
|
|
104
|
-
throw new Error('
|
|
142
|
+
if (typeof options.prisma.entity?.findMany !== 'function' || typeof options.prisma.file?.findMany !== 'function') {
|
|
143
|
+
throw new Error('prisma must be a Prisma 7 client generated from a schema that includes the arocapi models');
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
// Consumers generate their own client, whose delegate generics never match ours; the routes need the full type
|
|
147
|
+
const prisma = options.prisma as PrismaClient;
|
|
148
|
+
|
|
149
|
+
if (!searchBackend) {
|
|
150
|
+
throw new Error('search is required');
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
for (const [removed, { replacement, docs }] of Object.entries(REMOVED_OPTIONS)) {
|
|
154
|
+
if ((options as Record<string, unknown>)[removed] !== undefined) {
|
|
155
|
+
throw new Error(`${removed} has been replaced by ${replacement}, see ${docs}`);
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
if (!access) {
|
|
160
|
+
throw new Error('access is required');
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
if (!storage) {
|
|
164
|
+
throw new Error('storage is required');
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
if (!storage.metadata) {
|
|
168
|
+
throw new Error('storage.metadata is required');
|
|
105
169
|
}
|
|
106
170
|
|
|
107
|
-
if (!
|
|
108
|
-
throw new Error('
|
|
171
|
+
if (!storage.content) {
|
|
172
|
+
throw new Error('storage.content is required');
|
|
109
173
|
}
|
|
110
174
|
|
|
111
|
-
if (!
|
|
112
|
-
throw new Error('
|
|
175
|
+
if (!entityVisibilityFilter) {
|
|
176
|
+
throw new Error('entityVisibilityFilter is required');
|
|
113
177
|
}
|
|
114
178
|
|
|
115
|
-
if (!
|
|
116
|
-
throw new Error('
|
|
179
|
+
if (!searchVisibilityFilter) {
|
|
180
|
+
throw new Error('searchVisibilityFilter is required');
|
|
117
181
|
}
|
|
118
182
|
|
|
119
|
-
if (!
|
|
120
|
-
throw new Error('
|
|
183
|
+
if (promptLoginForHidden && !isAuthenticated) {
|
|
184
|
+
throw new Error('promptLoginForHidden requires isAuthenticated');
|
|
121
185
|
}
|
|
122
186
|
|
|
187
|
+
const refusal = { isAuthenticated, promptLoginForHidden };
|
|
188
|
+
|
|
123
189
|
fastify.register(sensible);
|
|
124
190
|
setupValidation(fastify);
|
|
125
191
|
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
192
|
+
// Fastify only gives a plugin its own not-found handler when registered with its own prefix
|
|
193
|
+
const { prefix } = options as { prefix?: string };
|
|
194
|
+
if (prefix && prefix !== '/') {
|
|
195
|
+
fastify.setNotFoundHandler(notFoundHandler);
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
fastify.register(capabilities, { search: searchBackend });
|
|
199
|
+
fastify.register(entities, { prisma, access, entityTransformers, entityVisibilityFilter });
|
|
200
|
+
fastify.register(entity, { prisma, access, entityTransformers, entityVisibilityFilter, refusal });
|
|
201
|
+
fastify.register(files, { prisma, access, fileTransformers, entityVisibilityFilter });
|
|
202
|
+
fastify.register(file, { prisma, content: storage.content, access, entityVisibilityFilter, refusal });
|
|
203
|
+
fastify.register(metadata, { prisma, metadata: storage.metadata, access, entityVisibilityFilter, refusal });
|
|
131
204
|
fastify.register(search, {
|
|
132
205
|
prisma,
|
|
133
|
-
|
|
134
|
-
|
|
206
|
+
search: searchBackend,
|
|
207
|
+
access,
|
|
135
208
|
entityTransformers,
|
|
136
|
-
|
|
137
|
-
|
|
209
|
+
entityVisibilityFilter,
|
|
210
|
+
searchVisibilityFilter,
|
|
138
211
|
});
|
|
139
212
|
};
|
|
140
213
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { FastifyPluginAsync } from 'fastify';
|
|
2
|
+
import type { SearchBackend } from '../search/backend.js';
|
|
3
|
+
|
|
4
|
+
const SPEC_VERSION = '0.5.0';
|
|
5
|
+
|
|
6
|
+
type CapabilitiesRouteOptions = {
|
|
7
|
+
search: SearchBackend;
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
const capabilities: FastifyPluginAsync<CapabilitiesRouteOptions> = async (fastify, opts) => {
|
|
11
|
+
const document = {
|
|
12
|
+
apiVersion: SPEC_VERSION,
|
|
13
|
+
deposit: { supported: false },
|
|
14
|
+
tombstonePolicy: '404',
|
|
15
|
+
extensions: {},
|
|
16
|
+
search: opts.search.capabilities,
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
fastify.get('/capabilities', async () => document);
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
export default capabilities;
|