arocapi 5.0.0-beta.2 → 5.0.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -824
- package/dist/app.d.ts +20 -7
- package/dist/app.js +42 -28
- package/dist/app.js.map +1 -1
- package/dist/app.test.js +41 -56
- package/dist/app.test.js.map +1 -1
- package/dist/errorHandling.test.d.ts +1 -0
- package/dist/errorHandling.test.js +222 -0
- package/dist/errorHandling.test.js.map +1 -0
- package/dist/index.dev.js +4 -3
- package/dist/index.dev.js.map +1 -1
- package/dist/routes/capabilities.test.js +8 -8
- package/dist/routes/capabilities.test.js.map +1 -1
- package/dist/routes/crate.test.js +67 -19
- package/dist/routes/crate.test.js.map +1 -1
- package/dist/routes/entities.d.ts +5 -2
- package/dist/routes/entities.js +31 -49
- package/dist/routes/entities.js.map +1 -1
- package/dist/routes/entities.test.js +16 -12
- package/dist/routes/entities.test.js.map +1 -1
- package/dist/routes/entity.d.ts +7 -2
- package/dist/routes/entity.js +14 -29
- package/dist/routes/entity.js.map +1 -1
- package/dist/routes/entity.test.js +19 -13
- package/dist/routes/entity.test.js.map +1 -1
- package/dist/routes/file.d.ts +6 -0
- package/dist/routes/file.js +67 -59
- package/dist/routes/file.js.map +1 -1
- package/dist/routes/file.test.js +135 -25
- package/dist/routes/file.test.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/files.test.js +44 -21
- package/dist/routes/files.test.js.map +1 -1
- package/dist/routes/metadata.d.ts +6 -0
- package/dist/routes/metadata.js +49 -54
- package/dist/routes/metadata.js.map +1 -1
- package/dist/routes/search.d.ts +6 -2
- package/dist/routes/search.js +95 -99
- package/dist/routes/search.js.map +1 -1
- package/dist/routes/search.test.js +85 -39
- package/dist/routes/search.test.js.map +1 -1
- package/dist/test/helpers/fastify.js +2 -3
- package/dist/test/helpers/fastify.js.map +1 -1
- package/dist/test/integration.setup.d.ts +18 -0
- package/dist/test/integration.setup.js +15 -7
- package/dist/test/integration.setup.js.map +1 -1
- package/dist/test/integration.test.js +368 -2
- package/dist/test/integration.test.js.map +1 -1
- package/dist/transformers/default.d.ts +10 -18
- package/dist/transformers/default.js +41 -15
- package/dist/transformers/default.js.map +1 -1
- package/dist/transformers/default.test.js +109 -47
- package/dist/transformers/default.test.js.map +1 -1
- package/dist/transformers/transformer.test.js +12 -34
- package/dist/transformers/transformer.test.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/fileHandlers.d.ts +5 -9
- package/dist/types/transformers.d.ts +4 -10
- package/dist/types/visibility.d.ts +5 -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 +13 -4
- package/dist/utils/errors.js +44 -8
- package/dist/utils/errors.js.map +1 -1
- package/dist/utils/errors.test.js +14 -1
- package/dist/utils/errors.test.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 +6 -4
- package/src/app.test.ts +45 -66
- package/src/app.ts +85 -54
- package/src/errorHandling.test.ts +288 -0
- package/src/index.dev.ts +6 -4
- package/src/routes/__snapshots__/search.test.ts.snap +2 -2
- package/src/routes/capabilities.test.ts +8 -8
- package/src/routes/crate.test.ts +80 -19
- package/src/routes/entities.test.ts +16 -12
- package/src/routes/entities.ts +40 -59
- package/src/routes/entity.test.ts +19 -13
- package/src/routes/entity.ts +22 -35
- package/src/routes/file.test.ts +156 -25
- package/src/routes/file.ts +84 -62
- package/src/routes/files.test.ts +52 -26
- package/src/routes/files.ts +31 -47
- package/src/routes/metadata.ts +64 -58
- package/src/routes/search.test.ts +88 -39
- package/src/routes/search.ts +123 -119
- package/src/test/helpers/fastify.ts +2 -3
- package/src/test/integration.setup.ts +18 -7
- package/src/test/integration.test.ts +472 -1
- package/src/transformers/default.test.ts +139 -47
- package/src/transformers/default.ts +103 -83
- package/src/transformers/transformer.test.ts +18 -44
- package/src/types/access.ts +20 -0
- package/src/types/context.ts +15 -0
- package/src/types/fileHandlers.ts +5 -13
- package/src/types/transformers.ts +4 -32
- package/src/types/visibility.ts +18 -0
- package/src/utils/access.ts +80 -0
- package/src/utils/errors.test.ts +16 -1
- package/src/utils/errors.ts +67 -10
- package/src/utils/validation.ts +11 -0
- package/src/utils/visibility.ts +56 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"default.js","sourceRoot":"","sources":["../../src/transformers/default.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"default.js","sourceRoot":"","sources":["../../src/transformers/default.ts"],"names":[],"mappings":"AA4EA,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAsB,EAAc,EAAE;IAC1E,MAAM,IAAI,GAAe;QACvB,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;QAC3C,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;KAC1C,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAMF,MAAM,mBAAmB,GAAG,CAAC,IAAU,EAAgB,EAAE,CAAC,CAAC;IACzD,EAAE,EAAE,IAAI,CAAC,EAAE;IACX,QAAQ,EAAE,IAAI,CAAC,QAAQ;IACvB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;CACxB,CAAC,CAAC;AAUH,MAAM,uBAAuB,GAAG,KAAK,EACnC,QAA2E,EAC3E,MAAoB,EACmB,EAAE;IACzC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IAEjC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACrB,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,CAAC,cAAc,EAAE,CAAC;YACrB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACxC,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,EAAE;QAClC,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;KACjC,CAAC,CAAC;IAEH,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC;AAKF,MAAM,kBAAkB,GAAG,KAAK,EAAE,QAA0B,EAAE,MAAoB,EAA6B,EAAE;IAC/G,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE/D,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE3C,OAAO;YACL,GAAG,IAAI;YACP,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;YACpE,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;SACvF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,EAClB,QAAQ,EACR,OAAO,EACP,wBAAwB,EACxB,uBAAuB,GACZ,EAAc,EAAE,CAAC,CAAC;IAC7B,QAAQ;IACR,OAAO;IACP,GAAG,CAAC,wBAAwB,IAAI,EAAE,wBAAwB,EAAE,CAAC;IAC7D,GAAG,CAAC,uBAAuB,IAAI,EAAE,uBAAuB,EAAE,CAAC;CAC5D,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,QAA0B,EAC1B,MAAsB,EACtB,OAAuB,EACA,EAAE,CACzB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAKhH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EACpC,QAA0B,EAC1B,MAAoB,EACpB,MAAsB,EACtB,OAAuB,EACM,EAAE;IAC/B,MAAM,CAAC,gBAAgB,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACzD,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC;QACpC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC;KACxC,CAAC,CAAC;IAEH,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACvF,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EACjC,KAA+C,EAC/C,MAAsB,EACtB,OAAuB,EACI,EAAE;IAC7B,MAAM,gBAAgB,GAAG,MAAM,YAAY,CACzC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAChC,MAAM,EACN,OAAO,CACR,CAAC;IAEF,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QAC3B,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,wBAAwB,EAAE,YAAY,EAAE,GAAG,UAAU,EAAE,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAE3G,OAAO,EAAE,GAAG,mBAAmB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EACpC,IAAO,EACP,YAAyE,EACzE,OAAuB,EACX,EAAE;IACd,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
|
|
@@ -1,5 +1,12 @@
|
|
|
1
|
-
import { describe, expect, it } from 'vitest';
|
|
2
|
-
import {
|
|
1
|
+
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
2
|
+
import { mockReset } from 'vitest-mock-extended';
|
|
3
|
+
import { prisma } from '../test/helpers/fastify.js';
|
|
4
|
+
import { AllPublicAccess } from '../utils/access.js';
|
|
5
|
+
import { applyTransformers, authoriseEntities, authoriseFiles, baseEntityTransformer } from './default.js';
|
|
6
|
+
const context = {
|
|
7
|
+
request: {},
|
|
8
|
+
fastify: {},
|
|
9
|
+
};
|
|
3
10
|
describe('baseEntityTransformer', () => {
|
|
4
11
|
it('should transform entity to standard entity shape', () => {
|
|
5
12
|
const entity = {
|
|
@@ -103,61 +110,116 @@ describe('baseEntityTransformer', () => {
|
|
|
103
110
|
});
|
|
104
111
|
});
|
|
105
112
|
});
|
|
106
|
-
describe('
|
|
107
|
-
it('should grant
|
|
108
|
-
const
|
|
113
|
+
describe('AllPublicAccess', () => {
|
|
114
|
+
it('should grant access to metadata and content without authorisation URLs', () => {
|
|
115
|
+
const baseEntity = {
|
|
109
116
|
id: 'http://example.com/entity/123',
|
|
110
117
|
name: 'Test Entity',
|
|
111
118
|
description: 'A test entity',
|
|
112
119
|
entityType: 'http://schema.org/MediaObject',
|
|
113
|
-
memberOf:
|
|
114
|
-
rootCollection:
|
|
120
|
+
memberOf: 'http://example.com/parent',
|
|
121
|
+
rootCollection: 'http://example.com/root',
|
|
115
122
|
metadataLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
|
|
116
123
|
contentLicenseId: 'https://creativecommons.org/licenses/by/4.0/',
|
|
117
124
|
};
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
+
expect(AllPublicAccess(baseEntity, context)).toEqual({ metadata: true, content: true });
|
|
126
|
+
});
|
|
127
|
+
});
|
|
128
|
+
const dbEntity = (id, overrides = {}) => ({
|
|
129
|
+
id,
|
|
130
|
+
name: `Name of ${id}`,
|
|
131
|
+
description: '',
|
|
132
|
+
entityType: 'http://schema.org/MediaObject',
|
|
133
|
+
memberOf: null,
|
|
134
|
+
rootCollection: null,
|
|
135
|
+
metadataLicenseId: 'https://example.com/licence/metadata',
|
|
136
|
+
contentLicenseId: 'https://example.com/licence/content',
|
|
137
|
+
createdAt: new Date(),
|
|
138
|
+
updatedAt: new Date(),
|
|
139
|
+
meta: null,
|
|
140
|
+
...overrides,
|
|
141
|
+
});
|
|
142
|
+
describe('authoriseEntities', () => {
|
|
143
|
+
beforeEach(() => {
|
|
144
|
+
mockReset(prisma);
|
|
145
|
+
});
|
|
146
|
+
it('should pass the access function parent ids but return the Record with parent names', async () => {
|
|
147
|
+
prisma.entity.findMany.mockResolvedValue([dbEntity('http://example.com/collection')]);
|
|
148
|
+
const access = vi.fn(AllPublicAccess);
|
|
149
|
+
const [entity] = await authoriseEntities([dbEntity('http://example.com/item', { memberOf: 'http://example.com/collection' })], prisma, access, context);
|
|
150
|
+
expect(access).toHaveBeenCalledWith(expect.objectContaining({ memberOf: 'http://example.com/collection' }), context);
|
|
151
|
+
expect(entity.memberOf).toEqual({
|
|
152
|
+
id: 'http://example.com/collection',
|
|
153
|
+
name: 'Name of http://example.com/collection',
|
|
125
154
|
});
|
|
155
|
+
expect(entity.access).toEqual({ metadata: true, content: true });
|
|
126
156
|
});
|
|
127
|
-
it('should
|
|
128
|
-
const
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
expect(result.entityType).toBe(standardEntity.entityType);
|
|
143
|
-
expect(result.memberOf).toBe(standardEntity.memberOf);
|
|
144
|
-
expect(result.rootCollection).toBe(standardEntity.rootCollection);
|
|
145
|
-
expect(result.metadataLicenseId).toBe(standardEntity.metadataLicenseId);
|
|
146
|
-
expect(result.contentLicenseId).toBe(standardEntity.contentLicenseId);
|
|
157
|
+
it('should keep only the access keys the library defines', async () => {
|
|
158
|
+
const access = vi.fn(async () => ({
|
|
159
|
+
metadata: false,
|
|
160
|
+
content: false,
|
|
161
|
+
metadataAuthorizationUrl: 'https://example.com/request-metadata',
|
|
162
|
+
contentAuthorizationUrl: 'https://example.com/request-content',
|
|
163
|
+
licence: 'secret',
|
|
164
|
+
}));
|
|
165
|
+
const [entity] = await authoriseEntities([dbEntity('http://example.com/item')], prisma, access, context);
|
|
166
|
+
expect(entity.access).toEqual({
|
|
167
|
+
metadata: false,
|
|
168
|
+
content: false,
|
|
169
|
+
metadataAuthorizationUrl: 'https://example.com/request-metadata',
|
|
170
|
+
contentAuthorizationUrl: 'https://example.com/request-content',
|
|
171
|
+
});
|
|
147
172
|
});
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
173
|
+
});
|
|
174
|
+
describe('authoriseFiles', () => {
|
|
175
|
+
beforeEach(() => {
|
|
176
|
+
mockReset(prisma);
|
|
177
|
+
});
|
|
178
|
+
const dbFile = (id) => ({
|
|
179
|
+
id,
|
|
180
|
+
filename: 'audio.wav',
|
|
181
|
+
mediaType: 'audio/wav',
|
|
182
|
+
size: BigInt(2048),
|
|
183
|
+
meta: null,
|
|
184
|
+
createdAt: new Date(),
|
|
185
|
+
updatedAt: new Date(),
|
|
186
|
+
entity: dbEntity(id),
|
|
187
|
+
});
|
|
188
|
+
it("should attach only the Content access of each file's entity", async () => {
|
|
189
|
+
const access = (entity) => entity.id === 'http://example.com/restricted.wav'
|
|
190
|
+
? {
|
|
191
|
+
metadata: false,
|
|
192
|
+
content: false,
|
|
193
|
+
metadataAuthorizationUrl: 'https://example.com/request-metadata',
|
|
194
|
+
contentAuthorizationUrl: 'https://example.com/request-content',
|
|
195
|
+
}
|
|
196
|
+
: { metadata: false, content: true };
|
|
197
|
+
const files = await authoriseFiles([dbFile('http://example.com/restricted.wav'), dbFile('http://example.com/open.wav')], access, context);
|
|
198
|
+
expect(files).toEqual([
|
|
199
|
+
{
|
|
200
|
+
id: 'http://example.com/restricted.wav',
|
|
201
|
+
filename: 'audio.wav',
|
|
202
|
+
mediaType: 'audio/wav',
|
|
203
|
+
size: 2048,
|
|
204
|
+
access: { content: false, contentAuthorizationUrl: 'https://example.com/request-content' },
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
id: 'http://example.com/open.wav',
|
|
208
|
+
filename: 'audio.wav',
|
|
209
|
+
mediaType: 'audio/wav',
|
|
210
|
+
size: 2048,
|
|
211
|
+
access: { content: true },
|
|
212
|
+
},
|
|
213
|
+
]);
|
|
214
|
+
});
|
|
215
|
+
});
|
|
216
|
+
describe('applyTransformers', () => {
|
|
217
|
+
it('should chain transformers in order', async () => {
|
|
218
|
+
const result = await applyTransformers('a', [(item) => `${item}b`, async (item, { request }) => `${item}c${request.url}`], { ...context, request: { url: '/d' } });
|
|
219
|
+
expect(result).toBe('abc/d');
|
|
220
|
+
});
|
|
221
|
+
it('should return the item unchanged without transformers', async () => {
|
|
222
|
+
expect(await applyTransformers('a', [], context)).toBe('a');
|
|
161
223
|
});
|
|
162
224
|
});
|
|
163
225
|
//# sourceMappingURL=default.test.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"default.test.js","sourceRoot":"","sources":["../../src/transformers/default.test.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"default.test.js","sourceRoot":"","sources":["../../src/transformers/default.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAGpD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE3G,MAAM,OAAO,GAAmB;IAC9B,OAAO,EAAE,EAAoB;IAC7B,OAAO,EAAE,EAAqB;CAC/B,CAAC;AAEF,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,MAAM,GAA8C;YACxD,EAAE,EAAE,+BAA+B;YACnC,IAAI,EAAE,aAAa;YACnB,WAAW,EAAE,2BAA2B;YACxC,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,2BAA2B;YACrC,cAAc,EAAE,yBAAyB;YACzC,iBAAiB,EAAE,8CAA8C;YACjE,gBAAgB,EAAE,iDAAiD;YACnE,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;YACjC,SAAS,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;YACjC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;SACvB,CAAC;QAEF,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,EAAE,EAAE,+BAA+B;YACnC,IAAI,EAAE,aAAa;YACnB,WAAW,EAAE,2BAA2B;YACxC,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,2BAA2B;YACrC,cAAc,EAAE,yBAAyB;YACzC,iBAAiB,EAAE,8CAA8C;YACjE,gBAAgB,EAAE,iDAAiD;SACpE,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,MAAM,GAA8C;YACxD,EAAE,EAAE,+BAA+B;YACnC,IAAI,EAAE,gBAAgB;YACtB,WAAW,EAAE,wBAAwB;YACrC,UAAU,EAAE,mCAAmC;YAC/C,QAAQ,EAAE,IAAI;YACd,cAAc,EAAE,IAAI;YACpB,iBAAiB,EAAE,8CAA8C;YACjE,gBAAgB,EAAE,8CAA8C;YAChE,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,IAAI,EAAE,IAAI;SACX,CAAC;QAEF,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,MAAM,GAA8C;YACxD,EAAE,EAAE,+BAA+B;YACnC,IAAI,EAAE,MAAM;YACZ,WAAW,EAAE,MAAM;YACnB,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,IAAI;YACd,cAAc,EAAE,IAAI;YACpB,iBAAiB,EAAE,8CAA8C;YACjE,gBAAgB,EAAE,8CAA8C;YAChE,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE;SAC1B,CAAC;QAEF,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YAClC,IAAI;YACJ,MAAM;YACN,aAAa;YACb,YAAY;YACZ,UAAU;YACV,gBAAgB;YAChB,mBAAmB;YACnB,kBAAkB;SACnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,MAAM,GAA8C;YACxD,EAAE,EAAE,mCAAmC;YACvC,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,oBAAoB;YACjC,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,+BAA+B;YACzC,cAAc,EAAE,+BAA+B;YAC/C,iBAAiB,EAAE,8CAA8C;YACjE,gBAAgB,EAAE,8CAA8C;YAChE,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,EAAE,EAAE,EAAE,oCAAoC,EAAE;SACnD,CAAC;QAEF,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,EAAE,EAAE,mCAAmC;YACvC,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,oBAAoB;YACjC,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,+BAA+B;YACzC,cAAc,EAAE,+BAA+B;YAC/C,iBAAiB,EAAE,8CAA8C;YACjE,gBAAgB,EAAE,8CAA8C;SACjE,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,UAAU,GAAG;YACjB,EAAE,EAAE,+BAA+B;YACnC,IAAI,EAAE,aAAa;YACnB,WAAW,EAAE,eAAe;YAC5B,UAAU,EAAE,+BAA+B;YAC3C,QAAQ,EAAE,2BAA2B;YACrC,cAAc,EAAE,yBAAyB;YACzC,iBAAiB,EAAE,8CAA8C;YACjE,gBAAgB,EAAE,8CAA8C;SACjE,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1F,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,SAAS,GAAoB,EAAE,EAAU,EAAE,CAAC,CAAC;IACzE,EAAE;IACF,IAAI,EAAE,WAAW,EAAE,EAAE;IACrB,WAAW,EAAE,EAAE;IACf,UAAU,EAAE,+BAA+B;IAC3C,QAAQ,EAAE,IAAI;IACd,cAAc,EAAE,IAAI;IACpB,iBAAiB,EAAE,sCAAsC;IACzD,gBAAgB,EAAE,qCAAqC;IACvD,SAAS,EAAE,IAAI,IAAI,EAAE;IACrB,SAAS,EAAE,IAAI,IAAI,EAAE;IACrB,IAAI,EAAE,IAAI;IACV,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,UAAU,CAAC,GAAG,EAAE;QACd,SAAS,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oFAAoF,EAAE,KAAK,IAAI,EAAE;QAClG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC;QACtF,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,CAAiB,eAAe,CAAC,CAAC;QAEtD,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,iBAAiB,CACtC,CAAC,QAAQ,CAAC,yBAAyB,EAAE,EAAE,QAAQ,EAAE,+BAA+B,EAAE,CAAC,CAAC,EACpF,MAAM,EACN,MAAM,EACN,OAAO,CACR,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CACjC,MAAM,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,+BAA+B,EAAE,CAAC,EACtE,OAAO,CACR,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;YAC9B,EAAE,EAAE,+BAA+B;YACnC,IAAI,EAAE,uCAAuC;SAC9C,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;YAChC,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;YACd,wBAAwB,EAAE,sCAAsC;YAChE,uBAAuB,EAAE,qCAAqC;YAC9D,OAAO,EAAE,QAAQ;SAClB,CAAC,CAAC,CAAC;QAEJ,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,iBAAiB,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YAC5B,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;YACd,wBAAwB,EAAE,sCAAsC;YAChE,uBAAuB,EAAE,qCAAqC;SAC/D,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,UAAU,CAAC,GAAG,EAAE;QACd,SAAS,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,CAAC;QAC9B,EAAE;QACF,QAAQ,EAAE,WAAW;QACrB,SAAS,EAAE,WAAW;QACtB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAClB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,IAAI,IAAI,EAAE;QACrB,SAAS,EAAE,IAAI,IAAI,EAAE;QACrB,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;KACrB,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,MAAM,GAAmB,CAAC,MAAM,EAAE,EAAE,CACxC,MAAM,CAAC,EAAE,KAAK,mCAAmC;YAC/C,CAAC,CAAC;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,wBAAwB,EAAE,sCAAsC;gBAChE,uBAAuB,EAAE,qCAAqC;aAC/D;YACH,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAEzC,MAAM,KAAK,GAAG,MAAM,cAAc,CAChC,CAAC,MAAM,CAAC,mCAAmC,CAAC,EAAE,MAAM,CAAC,6BAA6B,CAAC,CAAC,EACpF,MAAM,EACN,OAAO,CACR,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;YACpB;gBACE,EAAE,EAAE,mCAAmC;gBACvC,QAAQ,EAAE,WAAW;gBACrB,SAAS,EAAE,WAAW;gBACtB,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,uBAAuB,EAAE,qCAAqC,EAAE;aAC3F;YACD;gBACE,EAAE,EAAE,6BAA6B;gBACjC,QAAQ,EAAE,WAAW;gBACrB,SAAS,EAAE,WAAW;gBACtB,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;aAC1B;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,MAAM,GAAG,MAAM,iBAAiB,CACpC,GAAG,EACH,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,EAC7E,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,IAAI,EAAoB,EAAE,CACzD,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,CAAC,MAAM,iBAAiB,CAAC,GAAG,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { describe, expect, it } from 'vitest';
|
|
2
|
-
import {
|
|
2
|
+
import { prisma } from '../test/helpers/fastify.js';
|
|
3
|
+
import { applyTransformers, authoriseEntities, baseEntityTransformer, } from './default.js';
|
|
3
4
|
describe('Entity Transformers', () => {
|
|
4
5
|
const mockContext = {
|
|
5
6
|
request: {},
|
|
@@ -51,24 +52,6 @@ describe('Entity Transformers', () => {
|
|
|
51
52
|
expect(result).toEqual(expectedBaseEntity);
|
|
52
53
|
});
|
|
53
54
|
});
|
|
54
|
-
describe('AllPublicAccessTransformer', () => {
|
|
55
|
-
it('should add full access to standard entity', () => {
|
|
56
|
-
const result = AllPublicAccessTransformer(mockStandardEntity);
|
|
57
|
-
expect(result).toEqual({
|
|
58
|
-
...mockStandardEntity,
|
|
59
|
-
access: {
|
|
60
|
-
metadata: true,
|
|
61
|
-
content: true,
|
|
62
|
-
},
|
|
63
|
-
});
|
|
64
|
-
});
|
|
65
|
-
it('should grant metadata and content access', () => {
|
|
66
|
-
const result = AllPublicAccessTransformer(mockStandardEntity);
|
|
67
|
-
expect(result.access.metadata).toBe(true);
|
|
68
|
-
expect(result.access.content).toBe(true);
|
|
69
|
-
expect(result.access.contentAuthorizationUrl).toBeUndefined();
|
|
70
|
-
});
|
|
71
|
-
});
|
|
72
55
|
describe('Custom transformers', () => {
|
|
73
56
|
it('should allow custom transformer to add computed fields', () => {
|
|
74
57
|
const customTransformer = (entity) => ({
|
|
@@ -149,26 +132,21 @@ describe('Entity Transformers', () => {
|
|
|
149
132
|
createdAt: new Date(),
|
|
150
133
|
updatedAt: new Date(),
|
|
151
134
|
};
|
|
152
|
-
const
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
content: false,
|
|
157
|
-
contentAuthorizationUrl: 'https://example.com/auth',
|
|
158
|
-
},
|
|
135
|
+
const access = () => ({
|
|
136
|
+
metadata: true,
|
|
137
|
+
content: false,
|
|
138
|
+
contentAuthorizationUrl: 'https://example.com/auth',
|
|
159
139
|
});
|
|
160
140
|
const addMetadata = (entity) => ({
|
|
161
141
|
...entity,
|
|
162
142
|
processed: true,
|
|
163
143
|
});
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
...
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
const authorised = await customAccessTransformer(standard, mockContext);
|
|
171
|
-
const final = await addMetadata(authorised, mockContext);
|
|
144
|
+
prisma.entity.findMany.mockResolvedValue([
|
|
145
|
+
{ ...rawEntity, id: 'http://example.com/collection', name: 'Parent Collection' },
|
|
146
|
+
{ ...rawEntity, id: 'http://example.com/root', name: 'Root Collection' },
|
|
147
|
+
]);
|
|
148
|
+
const [authorised] = await authoriseEntities([rawEntity], prisma, access, mockContext);
|
|
149
|
+
const final = await applyTransformers(authorised, [addMetadata], mockContext);
|
|
172
150
|
expect(final).toMatchObject({
|
|
173
151
|
id: 'http://example.com/entity/123',
|
|
174
152
|
name: 'Test Entity',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transformer.test.js","sourceRoot":"","sources":["../../src/transformers/transformer.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"transformer.test.js","sourceRoot":"","sources":["../../src/transformers/transformer.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAIpD,OAAO,EAEL,iBAAiB,EACjB,iBAAiB,EAEjB,qBAAqB,GAEtB,MAAM,cAAc,CAAC;AAEtB,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,MAAM,WAAW,GAAmB;QAClC,OAAO,EAAE,EAAoB;QAC7B,OAAO,EAAE,EAAqB;KAC/B,CAAC;IAEF,MAAM,kBAAkB,GAAmB;QACzC,EAAE,EAAE,+BAA+B;QACnC,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,eAAe;QAC5B,UAAU,EAAE,0BAA0B;QACtC,QAAQ,EAAE,EAAE,EAAE,EAAE,+BAA+B,EAAE,IAAI,EAAE,iBAAiB,EAAE;QAC1E,cAAc,EAAE,EAAE,EAAE,EAAE,yBAAyB,EAAE,IAAI,EAAE,iBAAiB,EAAE;QAC1E,iBAAiB,EAAE,8CAA8C;QACjE,gBAAgB,EAAE,8CAA8C;KACjE,CAAC;IAEF,MAAM,oBAAoB,GAAqB;QAC7C,GAAG,kBAAkB;QACrB,MAAM,EAAE;YACN,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,IAAI;SACd;KACF,CAAC;IAEF,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;YAC9E,MAAM,SAAS,GAAG;gBAChB,EAAE,EAAE,+BAA+B;gBACnC,IAAI,EAAE,aAAa;gBACnB,WAAW,EAAE,eAAe;gBAC5B,UAAU,EAAE,0BAA0B;gBAEtC,QAAQ,EAAE,+BAA+B;gBACzC,cAAc,EAAE,yBAAyB;gBACzC,iBAAiB,EAAE,8CAA8C;gBACjE,gBAAgB,EAAE,8CAA8C;gBAChE,IAAI,EAAE,EAAE;gBACR,SAAS,EAAE,IAAI,IAAI,EAAE;gBACrB,SAAS,EAAE,IAAI,IAAI,EAAE;aACtB,CAAC;YAEF,MAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;YAGhD,MAAM,kBAAkB,GAAe;gBACrC,EAAE,EAAE,+BAA+B;gBACnC,IAAI,EAAE,aAAa;gBACnB,WAAW,EAAE,eAAe;gBAC5B,UAAU,EAAE,0BAA0B;gBACtC,QAAQ,EAAE,+BAA+B;gBACzC,cAAc,EAAE,yBAAyB;gBACzC,iBAAiB,EAAE,8CAA8C;gBACjE,gBAAgB,EAAE,8CAA8C;aACjE,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,MAAM,iBAAiB,GAA0F,CAC/G,MAAM,EACN,EAAE,CAAC,CAAC;gBACJ,EAAE,EAAE,MAAM,CAAC,EAAE;gBACb,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;gBACtC,GAAG,EAAE,MAAM,CAAC,EAAE;aACf,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,iBAAiB,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;YAEpE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,EAAE,EAAE,+BAA+B;gBACnC,WAAW,EAAE,aAAa;gBAC1B,GAAG,EAAE,+BAA+B;aACrC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;YAC3E,MAAM,gBAAgB,GAGlB,KAAK,EAAE,MAAM,EAAE,EAAE;gBAEnB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;gBAEvD,OAAO;oBACL,EAAE,EAAE,MAAM,CAAC,EAAE;oBACb,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,WAAW,EAAE,cAAc;iBAC5B,CAAC;YACJ,CAAC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;YAEzE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,EAAE,EAAE,+BAA+B;gBACnC,IAAI,EAAE,aAAa;gBACnB,WAAW,EAAE,cAAc;aAC5B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YAC1D,MAAM,uBAAuB,GAOzB,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;gBAC9B,EAAE,EAAE,MAAM,CAAC,EAAE;gBACb,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,SAAS;aAC7C,CAAC,CAAC;YAEH,MAAM,cAAc,GAAmB;gBACrC,OAAO,EAAE,EAAE,GAAG,EAAE,WAAW,EAAoB;gBAC/C,OAAO,EAAE,EAAqB;aAC/B,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC;YAEnF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,EAAE,EAAE,+BAA+B;gBACnC,IAAI,EAAE,aAAa;gBACnB,UAAU,EAAE,WAAW;aACxB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,cAAc,GAAoF,CACtG,MAAM,EACN,EAAE,CAAC,CAAC;gBACJ,GAAG,MAAM;gBACT,WAAW,EAAE,GAAG,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG;aACtE,CAAC,CAAC;YAEH,MAAM,YAAY,GAGd,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACf,GAAG,MAAM;gBACT,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE;aACrC,CAAC,CAAC;YAIH,IAAI,MAAM,GAAQ,oBAAoB,CAAC;YACvC,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACnD,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;gBAC3B,EAAE,EAAE,+BAA+B;gBACnC,IAAI,EAAE,aAAa;gBACnB,WAAW,EAAE,sBAAsB;gBACnC,SAAS,EAAE,aAAa;aACzB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;YACrF,MAAM,SAAS,GAAG;gBAChB,EAAE,EAAE,+BAA+B;gBACnC,IAAI,EAAE,aAAa;gBACnB,WAAW,EAAE,eAAe;gBAC5B,UAAU,EAAE,0BAA0B;gBAEtC,QAAQ,EAAE,+BAA+B;gBACzC,cAAc,EAAE,yBAAyB;gBACzC,iBAAiB,EAAE,8CAA8C;gBACjE,gBAAgB,EAAE,8CAA8C;gBAChE,IAAI,EAAE,EAAE;gBACR,SAAS,EAAE,IAAI,IAAI,EAAE;gBACrB,SAAS,EAAE,IAAI,IAAI,EAAE;aACtB,CAAC;YAEF,MAAM,MAAM,GAAmB,GAAG,EAAE,CAAC,CAAC;gBACpC,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,KAAK;gBACd,uBAAuB,EAAE,0BAA0B;aACpD,CAAC,CAAC;YAEH,MAAM,WAAW,GAAmF,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAC/G,GAAG,MAAM;gBACT,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC;gBACvC,EAAE,GAAG,SAAS,EAAE,EAAE,EAAE,+BAA+B,EAAE,IAAI,EAAE,mBAAmB,EAAE;gBAChF,EAAE,GAAG,SAAS,EAAE,EAAE,EAAE,yBAAyB,EAAE,IAAI,EAAE,iBAAiB,EAAE;aACzE,CAAC,CAAC;YAEH,MAAM,CAAC,UAAU,CAAC,GAAG,MAAM,iBAAiB,CAAC,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;YACvF,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC,UAAU,EAAE,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC;YAE9E,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC;gBAC1B,EAAE,EAAE,+BAA+B;gBACnC,IAAI,EAAE,aAAa;gBACnB,QAAQ,EAAE,EAAE,EAAE,EAAE,+BAA+B,EAAE,IAAI,EAAE,mBAAmB,EAAE;gBAC5E,cAAc,EAAE,EAAE,EAAE,EAAE,yBAAyB,EAAE,IAAI,EAAE,iBAAiB,EAAE;gBAC1E,MAAM,EAAE;oBACN,QAAQ,EAAE,IAAI;oBACd,OAAO,EAAE,KAAK;oBACd,uBAAuB,EAAE,0BAA0B;iBACpD;gBACD,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { BaseEntity } from '../transformers/default.js';
|
|
2
|
+
import type { RequestContext } from './context.js';
|
|
3
|
+
export type AccessInfo = {
|
|
4
|
+
metadata: boolean;
|
|
5
|
+
content: boolean;
|
|
6
|
+
metadataAuthorizationUrl?: string;
|
|
7
|
+
contentAuthorizationUrl?: string;
|
|
8
|
+
};
|
|
9
|
+
export type AccessFunction = (entity: BaseEntity, context: RequestContext) => Promise<AccessInfo> | AccessInfo;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"access.js","sourceRoot":"","sources":["../../src/types/access.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/types/context.ts"],"names":[],"mappings":""}
|
|
@@ -1,10 +1,6 @@
|
|
|
1
1
|
import type { Readable } from 'node:stream';
|
|
2
|
-
import type { FastifyInstance, FastifyRequest } from 'fastify';
|
|
3
2
|
import type { Entity, File } from '../generated/prisma/client.js';
|
|
4
|
-
|
|
5
|
-
request: FastifyRequest;
|
|
6
|
-
fastify: FastifyInstance;
|
|
7
|
-
};
|
|
3
|
+
import type { RequestContext } from './context.js';
|
|
8
4
|
export type FileMetadata = {
|
|
9
5
|
contentType: string;
|
|
10
6
|
contentLength: number;
|
|
@@ -27,14 +23,14 @@ export type FilePathResult = {
|
|
|
27
23
|
accelPath?: string;
|
|
28
24
|
};
|
|
29
25
|
export type FileResult = FileRedirectResult | FileStreamResult | FilePathResult;
|
|
30
|
-
export type GetFileHandler = (file: File, context:
|
|
31
|
-
export type HeadFileHandler = (file: File, context:
|
|
26
|
+
export type GetFileHandler = (file: File, context: RequestContext) => Promise<FileResult | false> | FileResult | false;
|
|
27
|
+
export type HeadFileHandler = (file: File, context: RequestContext) => Promise<FileMetadata | false> | FileMetadata | false;
|
|
32
28
|
export type FileHandler = {
|
|
33
29
|
get: GetFileHandler;
|
|
34
30
|
head: HeadFileHandler;
|
|
35
31
|
};
|
|
36
|
-
export type GetRoCrateHandler = (entity: Entity, context:
|
|
37
|
-
export type HeadRoCrateHandler = (entity: Entity, context:
|
|
32
|
+
export type GetRoCrateHandler = (entity: Entity, context: RequestContext) => Promise<FileResult | false> | FileResult | false;
|
|
33
|
+
export type HeadRoCrateHandler = (entity: Entity, context: RequestContext) => Promise<FileMetadata | false> | FileMetadata | false;
|
|
38
34
|
export type RoCrateHandler = {
|
|
39
35
|
get: GetRoCrateHandler;
|
|
40
36
|
head: HeadRoCrateHandler;
|
|
@@ -1,10 +1,4 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
3
|
-
export type
|
|
4
|
-
|
|
5
|
-
fastify: FastifyInstance;
|
|
6
|
-
};
|
|
7
|
-
export type AccessTransformer = (entity: StandardEntity, context: TransformerContext) => Promise<AuthorisedEntity> | AuthorisedEntity;
|
|
8
|
-
export type EntityTransformer<TInput = AuthorisedEntity, TOutput = TInput> = (entity: TInput, context: TransformerContext) => Promise<TOutput> | TOutput;
|
|
9
|
-
export type FileAccessTransformer = (file: StandardFile, context: TransformerContext) => Promise<AuthorisedFile> | AuthorisedFile;
|
|
10
|
-
export type FileTransformer<TInput = AuthorisedFile, TOutput = TInput> = (file: TInput, context: TransformerContext) => Promise<TOutput> | TOutput;
|
|
1
|
+
import type { AuthorisedEntity, AuthorisedFile } from '../transformers/default.js';
|
|
2
|
+
import type { RequestContext } from './context.js';
|
|
3
|
+
export type EntityTransformer<TInput = AuthorisedEntity, TOutput = TInput> = (entity: TInput, context: RequestContext) => Promise<TOutput> | TOutput;
|
|
4
|
+
export type FileTransformer<TInput = AuthorisedFile, TOutput = TInput> = (file: TInput, context: RequestContext) => Promise<TOutput> | TOutput;
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { QueryContainer } from '@opensearch-project/opensearch/api/_types/_common.query_dsl.js';
|
|
2
|
+
import type { Prisma } from '../generated/prisma/client.js';
|
|
3
|
+
import type { RequestContext } from './context.js';
|
|
4
|
+
export type EntityVisibilityFilter = (context: RequestContext) => Promise<Prisma.EntityWhereInput> | Prisma.EntityWhereInput;
|
|
5
|
+
export type SearchVisibilityFilter = (context: RequestContext) => Promise<QueryContainer> | QueryContainer;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"visibility.js","sourceRoot":"","sources":["../../src/types/visibility.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { FastifyReply } from 'fastify';
|
|
2
|
+
import { type EntityWithFile } from '../transformers/default.js';
|
|
3
|
+
import type { AccessFunction } from '../types/access.js';
|
|
4
|
+
import type { IsAuthenticated, RequestContext } from '../types/context.js';
|
|
5
|
+
export declare const AllPublicAccess: AccessFunction;
|
|
6
|
+
export type LicenceAccessOptions = {
|
|
7
|
+
hasLicence: (licenceId: string, context: RequestContext) => Promise<boolean> | boolean;
|
|
8
|
+
authorisationUrl?: (licenceId: string) => string;
|
|
9
|
+
};
|
|
10
|
+
export declare const LicenceAccess: ({ hasLicence, authorisationUrl }: LicenceAccessOptions) => AccessFunction;
|
|
11
|
+
type AccessGuardOptions = {
|
|
12
|
+
access: AccessFunction;
|
|
13
|
+
isAuthenticated?: IsAuthenticated;
|
|
14
|
+
level: 'metadata' | 'content';
|
|
15
|
+
};
|
|
16
|
+
export declare const createAccessGuard: ({ access, isAuthenticated, level }: AccessGuardOptions) => (reply: FastifyReply, entity: EntityWithFile, context: RequestContext) => Promise<boolean>;
|
|
17
|
+
export {};
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { decideAccess } from '../transformers/default.js';
|
|
2
|
+
import { sendRefusal } from './errors.js';
|
|
3
|
+
import { isAnonymous } from './visibility.js';
|
|
4
|
+
export const AllPublicAccess = () => ({ metadata: true, content: true });
|
|
5
|
+
export const LicenceAccess = ({ hasLicence, authorisationUrl }) => {
|
|
6
|
+
const checksByRequest = new WeakMap();
|
|
7
|
+
const check = (licenceId, context) => {
|
|
8
|
+
let checks = checksByRequest.get(context.request);
|
|
9
|
+
if (!checks) {
|
|
10
|
+
checks = new Map();
|
|
11
|
+
checksByRequest.set(context.request, checks);
|
|
12
|
+
}
|
|
13
|
+
let held = checks.get(licenceId);
|
|
14
|
+
if (!held) {
|
|
15
|
+
held = Promise.resolve(hasLicence(licenceId, context));
|
|
16
|
+
checks.set(licenceId, held);
|
|
17
|
+
}
|
|
18
|
+
return held;
|
|
19
|
+
};
|
|
20
|
+
return async ({ metadataLicenseId, contentLicenseId }, context) => {
|
|
21
|
+
const [metadata, content] = await Promise.all([
|
|
22
|
+
check(metadataLicenseId, context),
|
|
23
|
+
check(contentLicenseId, context),
|
|
24
|
+
]);
|
|
25
|
+
return {
|
|
26
|
+
metadata,
|
|
27
|
+
content,
|
|
28
|
+
...(!metadata && authorisationUrl && { metadataAuthorizationUrl: authorisationUrl(metadataLicenseId) }),
|
|
29
|
+
...(!content && authorisationUrl && { contentAuthorizationUrl: authorisationUrl(contentLicenseId) }),
|
|
30
|
+
};
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
export const createAccessGuard = ({ access, isAuthenticated, level }) => async (reply, entity, context) => {
|
|
34
|
+
const [entityAccess] = await decideAccess([entity], access, context);
|
|
35
|
+
if (entityAccess[level]) {
|
|
36
|
+
return false;
|
|
37
|
+
}
|
|
38
|
+
sendRefusal(reply, await isAnonymous(isAuthenticated, context), entity.id);
|
|
39
|
+
return true;
|
|
40
|
+
};
|
|
41
|
+
//# sourceMappingURL=access.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"access.js","sourceRoot":"","sources":["../../src/utils/access.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAuB,MAAM,4BAA4B,CAAC;AAG/E,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAO9C,MAAM,CAAC,MAAM,eAAe,GAAmB,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AAYzF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAAE,UAAU,EAAE,gBAAgB,EAAwB,EAAkB,EAAE;IACtG,MAAM,eAAe,GAAG,IAAI,OAAO,EAAiD,CAAC;IAErF,MAAM,KAAK,GAAG,CAAC,SAAiB,EAAE,OAAuB,EAAE,EAAE;QAC3D,IAAI,MAAM,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;YACnB,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;YACvD,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,EAAE,OAAO,EAAE,EAAE;QAChE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC5C,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC;YACjC,KAAK,CAAC,gBAAgB,EAAE,OAAO,CAAC;SACjC,CAAC,CAAC;QAEH,OAAO;YACL,QAAQ;YACR,OAAO;YACP,GAAG,CAAC,CAAC,QAAQ,IAAI,gBAAgB,IAAI,EAAE,wBAAwB,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACvG,GAAG,CAAC,CAAC,OAAO,IAAI,gBAAgB,IAAI,EAAE,uBAAuB,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,CAAC;SACrG,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAYF,MAAM,CAAC,MAAM,iBAAiB,GAC5B,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,KAAK,EAAsB,EAAE,EAAE,CAC3D,KAAK,EAAE,KAAmB,EAAE,MAAsB,EAAE,OAAuB,EAAE,EAAE;IAC7E,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,YAAY,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACrE,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,WAAW,CAAC,KAAK,EAAE,MAAM,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAE3E,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}
|
package/dist/utils/errors.d.ts
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
import type { FastifyReply, FastifyRequest } from 'fastify';
|
|
2
|
+
export declare const ERROR_CODES: {
|
|
2
3
|
readonly VALIDATION_ERROR: 'VALIDATION_ERROR';
|
|
3
4
|
readonly NOT_FOUND: 'NOT_FOUND';
|
|
5
|
+
readonly UNAUTHORIZED: 'UNAUTHORIZED';
|
|
6
|
+
readonly FORBIDDEN: 'FORBIDDEN';
|
|
7
|
+
readonly CONFLICT: 'CONFLICT';
|
|
8
|
+
readonly RANGE_NOT_SATISFIABLE: 'RANGE_NOT_SATISFIABLE';
|
|
4
9
|
readonly RATE_LIMIT_EXCEEDED: 'RATE_LIMIT_EXCEEDED';
|
|
5
10
|
readonly INTERNAL_ERROR: 'INTERNAL_ERROR';
|
|
6
|
-
readonly INVALID_REQUEST: 'INVALID_REQUEST';
|
|
7
11
|
readonly INVALID_ENTITY_TYPE: 'INVALID_ENTITY_TYPE';
|
|
8
12
|
};
|
|
9
|
-
type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
|
|
13
|
+
export type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
|
|
10
14
|
type ErrorDetails = {
|
|
11
15
|
[key: string]: unknown;
|
|
12
16
|
};
|
|
@@ -17,6 +21,7 @@ export type StandardErrorResponse = {
|
|
|
17
21
|
details?: ErrorDetails;
|
|
18
22
|
};
|
|
19
23
|
};
|
|
24
|
+
export declare const createError: (code: ErrorCode, message: string, details?: ErrorDetails) => StandardErrorResponse;
|
|
20
25
|
type ValidationViolation = {
|
|
21
26
|
field: string;
|
|
22
27
|
message?: string;
|
|
@@ -24,6 +29,10 @@ type ValidationViolation = {
|
|
|
24
29
|
};
|
|
25
30
|
export declare const createValidationError: (message: string, violations: ValidationViolation[]) => StandardErrorResponse;
|
|
26
31
|
export declare const createNotFoundError: (message: string, entityId?: string) => StandardErrorResponse;
|
|
27
|
-
export declare const
|
|
32
|
+
export declare const createAuthenticationRequiredError: (message: string, entityId: string) => StandardErrorResponse;
|
|
33
|
+
export declare const createForbiddenError: (message: string, entityId: string) => StandardErrorResponse;
|
|
28
34
|
export declare const createInternalError: (message?: string) => StandardErrorResponse;
|
|
35
|
+
export declare const sendRefusal: (reply: FastifyReply, anonymous: boolean, id: string) => FastifyReply<import("fastify").RouteGenericInterface, import("fastify").RawServerDefault, import("node:http").IncomingMessage, import("node:http").ServerResponse<import("node:http").IncomingMessage>, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
|
|
36
|
+
export declare const errorHandler: (error: unknown, request: FastifyRequest, reply: FastifyReply) => FastifyReply<import("fastify").RouteGenericInterface, import("fastify").RawServerDefault, import("node:http").IncomingMessage, import("node:http").ServerResponse<import("node:http").IncomingMessage>, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
|
|
37
|
+
export declare const notFoundHandler: (_request: FastifyRequest, reply: FastifyReply) => FastifyReply<import("fastify").RouteGenericInterface, import("fastify").RawServerDefault, import("node:http").IncomingMessage, import("node:http").ServerResponse<import("node:http").IncomingMessage>, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
|
|
29
38
|
export {};
|
package/dist/utils/errors.js
CHANGED
|
@@ -1,22 +1,58 @@
|
|
|
1
|
-
|
|
1
|
+
import { hasZodFastifySchemaValidationErrors } from 'fastify-type-provider-zod';
|
|
2
|
+
export const ERROR_CODES = {
|
|
2
3
|
VALIDATION_ERROR: 'VALIDATION_ERROR',
|
|
3
4
|
NOT_FOUND: 'NOT_FOUND',
|
|
5
|
+
UNAUTHORIZED: 'UNAUTHORIZED',
|
|
6
|
+
FORBIDDEN: 'FORBIDDEN',
|
|
7
|
+
CONFLICT: 'CONFLICT',
|
|
8
|
+
RANGE_NOT_SATISFIABLE: 'RANGE_NOT_SATISFIABLE',
|
|
4
9
|
RATE_LIMIT_EXCEEDED: 'RATE_LIMIT_EXCEEDED',
|
|
5
10
|
INTERNAL_ERROR: 'INTERNAL_ERROR',
|
|
6
|
-
INVALID_REQUEST: 'INVALID_REQUEST',
|
|
7
11
|
INVALID_ENTITY_TYPE: 'INVALID_ENTITY_TYPE',
|
|
8
12
|
};
|
|
9
|
-
const
|
|
13
|
+
export const createError = (code, message, details) => ({
|
|
10
14
|
error: {
|
|
11
15
|
code,
|
|
12
16
|
message,
|
|
13
17
|
details,
|
|
14
18
|
},
|
|
15
19
|
});
|
|
16
|
-
export const createValidationError = (message, violations) =>
|
|
17
|
-
export const createNotFoundError = (message, entityId) =>
|
|
18
|
-
export const
|
|
19
|
-
export const
|
|
20
|
-
|
|
20
|
+
export const createValidationError = (message, violations) => createError(ERROR_CODES.VALIDATION_ERROR, message, { violations });
|
|
21
|
+
export const createNotFoundError = (message, entityId) => createError(ERROR_CODES.NOT_FOUND, message, entityId ? { entityId } : undefined);
|
|
22
|
+
export const createAuthenticationRequiredError = (message, entityId) => createError(ERROR_CODES.UNAUTHORIZED, message, { entityId });
|
|
23
|
+
export const createForbiddenError = (message, entityId) => createError(ERROR_CODES.FORBIDDEN, message, { entityId });
|
|
24
|
+
export const createInternalError = (message = 'Internal server error') => createError(ERROR_CODES.INTERNAL_ERROR, message);
|
|
25
|
+
export const sendRefusal = (reply, anonymous, id) => anonymous
|
|
26
|
+
? reply.code(401).send(createAuthenticationRequiredError('Authentication is required to access this resource', id))
|
|
27
|
+
: reply.code(403).send(createForbiddenError('You do not have permission to access this resource', id));
|
|
28
|
+
const ERROR_CODE_BY_STATUS = {
|
|
29
|
+
401: ERROR_CODES.UNAUTHORIZED,
|
|
30
|
+
403: ERROR_CODES.FORBIDDEN,
|
|
31
|
+
404: ERROR_CODES.NOT_FOUND,
|
|
32
|
+
409: ERROR_CODES.CONFLICT,
|
|
33
|
+
416: ERROR_CODES.RANGE_NOT_SATISFIABLE,
|
|
34
|
+
429: ERROR_CODES.RATE_LIMIT_EXCEEDED,
|
|
21
35
|
};
|
|
36
|
+
export const errorHandler = (error, request, reply) => {
|
|
37
|
+
if (hasZodFastifySchemaValidationErrors(error)) {
|
|
38
|
+
const violations = error.validation.map((v) => ({
|
|
39
|
+
field: v.instancePath,
|
|
40
|
+
message: v.message,
|
|
41
|
+
}));
|
|
42
|
+
return reply.code(400).send(createValidationError('The request parameters are invalid', violations));
|
|
43
|
+
}
|
|
44
|
+
const { statusCode, status, message, headers, expose, code } = (error ?? {});
|
|
45
|
+
const httpStatus = statusCode ?? status;
|
|
46
|
+
const trusted = expose === true || (typeof code === 'string' && code.startsWith('FST_'));
|
|
47
|
+
if (trusted && httpStatus && httpStatus >= 400 && httpStatus < 500) {
|
|
48
|
+
const errorCode = ERROR_CODE_BY_STATUS[httpStatus] ?? ERROR_CODES.VALIDATION_ERROR;
|
|
49
|
+
return reply
|
|
50
|
+
.code(httpStatus)
|
|
51
|
+
.headers(headers ?? {})
|
|
52
|
+
.send(createError(errorCode, message ?? ''));
|
|
53
|
+
}
|
|
54
|
+
request.log.error({ err: error });
|
|
55
|
+
return reply.code(500).send(createInternalError());
|
|
56
|
+
};
|
|
57
|
+
export const notFoundHandler = (_request, reply) => reply.code(404).send(createNotFoundError('The requested resource was not found'));
|
|
22
58
|
//# sourceMappingURL=errors.js.map
|