arocapi 5.0.0-beta.2 → 5.0.0-beta.3

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.
Files changed (117) hide show
  1. package/README.md +37 -824
  2. package/dist/app.d.ts +20 -7
  3. package/dist/app.js +42 -28
  4. package/dist/app.js.map +1 -1
  5. package/dist/app.test.js +41 -56
  6. package/dist/app.test.js.map +1 -1
  7. package/dist/errorHandling.test.d.ts +1 -0
  8. package/dist/errorHandling.test.js +222 -0
  9. package/dist/errorHandling.test.js.map +1 -0
  10. package/dist/index.dev.js +4 -3
  11. package/dist/index.dev.js.map +1 -1
  12. package/dist/routes/capabilities.test.js +8 -8
  13. package/dist/routes/capabilities.test.js.map +1 -1
  14. package/dist/routes/crate.test.js +67 -19
  15. package/dist/routes/crate.test.js.map +1 -1
  16. package/dist/routes/entities.d.ts +5 -2
  17. package/dist/routes/entities.js +31 -49
  18. package/dist/routes/entities.js.map +1 -1
  19. package/dist/routes/entities.test.js +16 -12
  20. package/dist/routes/entities.test.js.map +1 -1
  21. package/dist/routes/entity.d.ts +7 -2
  22. package/dist/routes/entity.js +14 -29
  23. package/dist/routes/entity.js.map +1 -1
  24. package/dist/routes/entity.test.js +19 -13
  25. package/dist/routes/entity.test.js.map +1 -1
  26. package/dist/routes/file.d.ts +6 -0
  27. package/dist/routes/file.js +67 -59
  28. package/dist/routes/file.js.map +1 -1
  29. package/dist/routes/file.test.js +99 -22
  30. package/dist/routes/file.test.js.map +1 -1
  31. package/dist/routes/files.d.ts +5 -2
  32. package/dist/routes/files.js +24 -39
  33. package/dist/routes/files.js.map +1 -1
  34. package/dist/routes/files.test.js +44 -21
  35. package/dist/routes/files.test.js.map +1 -1
  36. package/dist/routes/metadata.d.ts +6 -0
  37. package/dist/routes/metadata.js +49 -54
  38. package/dist/routes/metadata.js.map +1 -1
  39. package/dist/routes/search.d.ts +6 -2
  40. package/dist/routes/search.js +95 -99
  41. package/dist/routes/search.js.map +1 -1
  42. package/dist/routes/search.test.js +85 -39
  43. package/dist/routes/search.test.js.map +1 -1
  44. package/dist/test/helpers/fastify.js +2 -3
  45. package/dist/test/helpers/fastify.js.map +1 -1
  46. package/dist/test/integration.setup.d.ts +18 -0
  47. package/dist/test/integration.setup.js +15 -7
  48. package/dist/test/integration.setup.js.map +1 -1
  49. package/dist/test/integration.test.js +368 -2
  50. package/dist/test/integration.test.js.map +1 -1
  51. package/dist/transformers/default.d.ts +10 -18
  52. package/dist/transformers/default.js +41 -15
  53. package/dist/transformers/default.js.map +1 -1
  54. package/dist/transformers/default.test.js +109 -47
  55. package/dist/transformers/default.test.js.map +1 -1
  56. package/dist/transformers/transformer.test.js +12 -34
  57. package/dist/transformers/transformer.test.js.map +1 -1
  58. package/dist/types/access.d.ts +9 -0
  59. package/dist/types/access.js +2 -0
  60. package/dist/types/access.js.map +1 -0
  61. package/dist/types/context.d.ts +6 -0
  62. package/dist/types/context.js +2 -0
  63. package/dist/types/context.js.map +1 -0
  64. package/dist/types/fileHandlers.d.ts +5 -9
  65. package/dist/types/transformers.d.ts +4 -10
  66. package/dist/types/visibility.d.ts +5 -0
  67. package/dist/types/visibility.js +2 -0
  68. package/dist/types/visibility.js.map +1 -0
  69. package/dist/utils/access.d.ts +17 -0
  70. package/dist/utils/access.js +41 -0
  71. package/dist/utils/access.js.map +1 -0
  72. package/dist/utils/errors.d.ts +13 -4
  73. package/dist/utils/errors.js +44 -8
  74. package/dist/utils/errors.js.map +1 -1
  75. package/dist/utils/errors.test.js +14 -1
  76. package/dist/utils/errors.test.js.map +1 -1
  77. package/dist/utils/validation.d.ts +2 -0
  78. package/dist/utils/validation.js +8 -0
  79. package/dist/utils/validation.js.map +1 -0
  80. package/dist/utils/visibility.d.ts +18 -0
  81. package/dist/utils/visibility.js +16 -0
  82. package/dist/utils/visibility.js.map +1 -0
  83. package/package.json +5 -4
  84. package/src/app.test.ts +45 -66
  85. package/src/app.ts +85 -54
  86. package/src/errorHandling.test.ts +288 -0
  87. package/src/index.dev.ts +6 -4
  88. package/src/routes/__snapshots__/search.test.ts.snap +2 -2
  89. package/src/routes/capabilities.test.ts +8 -8
  90. package/src/routes/crate.test.ts +80 -19
  91. package/src/routes/entities.test.ts +16 -12
  92. package/src/routes/entities.ts +40 -59
  93. package/src/routes/entity.test.ts +19 -13
  94. package/src/routes/entity.ts +22 -35
  95. package/src/routes/file.test.ts +117 -22
  96. package/src/routes/file.ts +84 -62
  97. package/src/routes/files.test.ts +52 -26
  98. package/src/routes/files.ts +31 -47
  99. package/src/routes/metadata.ts +64 -58
  100. package/src/routes/search.test.ts +88 -39
  101. package/src/routes/search.ts +123 -119
  102. package/src/test/helpers/fastify.ts +2 -3
  103. package/src/test/integration.setup.ts +18 -7
  104. package/src/test/integration.test.ts +472 -1
  105. package/src/transformers/default.test.ts +139 -47
  106. package/src/transformers/default.ts +103 -83
  107. package/src/transformers/transformer.test.ts +18 -44
  108. package/src/types/access.ts +20 -0
  109. package/src/types/context.ts +15 -0
  110. package/src/types/fileHandlers.ts +5 -13
  111. package/src/types/transformers.ts +4 -32
  112. package/src/types/visibility.ts +18 -0
  113. package/src/utils/access.ts +80 -0
  114. package/src/utils/errors.test.ts +16 -1
  115. package/src/utils/errors.ts +67 -10
  116. package/src/utils/validation.ts +11 -0
  117. package/src/utils/visibility.ts +56 -0
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,GAAG;IAClB,gBAAgB,EAAE,kBAAkB;IACpC,SAAS,EAAE,WAAW;IACtB,mBAAmB,EAAE,qBAAqB;IAC1C,cAAc,EAAE,gBAAgB;IAChC,eAAe,EAAE,iBAAiB;IAClC,mBAAmB,EAAE,qBAAqB;CAClC,CAAC;AAgBX,MAAM,mBAAmB,GAAG,CAAC,IAAe,EAAE,OAAe,EAAE,OAAsB,EAAyB,EAAE,CAAC,CAAC;IAChH,KAAK,EAAE;QACL,IAAI;QACJ,OAAO;QACP,OAAO;KACR;CACF,CAAC,CAAC;AAQH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,UAAiC,EAAyB,EAAE,CACjH,mBAAmB,CAAC,WAAW,CAAC,gBAAgB,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAe,EAAE,QAAiB,EAAyB,EAAE,CAC/F,mBAAmB,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAE3F,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,OAAe,EAAyB,EAAE,CAClF,mBAAmB,CAAC,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;AAE5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAO,GAAG,uBAAuB,EAAyB,EAAE;IAC9F,OAAO,mBAAmB,CAAC,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC,CAAC"}
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mCAAmC,EAAE,MAAM,2BAA2B,CAAC;AAEhF,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,gBAAgB,EAAE,kBAAkB;IACpC,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,qBAAqB,EAAE,uBAAuB;IAC9C,mBAAmB,EAAE,qBAAqB;IAC1C,cAAc,EAAE,gBAAgB;IAChC,mBAAmB,EAAE,qBAAqB;CAClC,CAAC;AAgBX,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAe,EAAE,OAAe,EAAE,OAAsB,EAAyB,EAAE,CAAC,CAAC;IAC/G,KAAK,EAAE;QACL,IAAI;QACJ,OAAO;QACP,OAAO;KACR;CACF,CAAC,CAAC;AAQH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,UAAiC,EAAyB,EAAE,CACjH,WAAW,CAAC,WAAW,CAAC,gBAAgB,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;AAErE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAe,EAAE,QAAiB,EAAyB,EAAE,CAC/F,WAAW,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAEnF,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,OAAe,EAAE,QAAgB,EAAyB,EAAE,CAC5G,WAAW,CAAC,WAAW,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAE/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,OAAe,EAAE,QAAgB,EAAyB,EAAE,CAC/F,WAAW,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAE5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAO,GAAG,uBAAuB,EAAyB,EAAE,CAC9F,WAAW,CAAC,WAAW,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AAKnD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAmB,EAAE,SAAkB,EAAE,EAAU,EAAE,EAAE,CACjF,SAAS;IACP,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,oDAAoD,EAAE,EAAE,CAAC,CAAC;IACnH,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,oDAAoD,EAAE,EAAE,CAAC,CAAC,CAAC;AAE3G,MAAM,oBAAoB,GAA8B;IACtD,GAAG,EAAE,WAAW,CAAC,YAAY;IAC7B,GAAG,EAAE,WAAW,CAAC,SAAS;IAC1B,GAAG,EAAE,WAAW,CAAC,SAAS;IAC1B,GAAG,EAAE,WAAW,CAAC,QAAQ;IACzB,GAAG,EAAE,WAAW,CAAC,qBAAqB;IACtC,GAAG,EAAE,WAAW,CAAC,mBAAmB;CACrC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAc,EAAE,OAAuB,EAAE,KAAmB,EAAE,EAAE;IAC3F,IAAI,mCAAmC,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,KAAK,EAAE,CAAC,CAAC,YAAY;YACrB,OAAO,EAAE,CAAC,CAAC,OAAO;SACnB,CAAC,CAAC,CAAC;QAEJ,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,oCAAoC,EAAE,UAAU,CAAC,CAAC,CAAC;IACvG,CAAC;IAED,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE,CAE1E,CAAC;IACF,MAAM,UAAU,GAAG,UAAU,IAAI,MAAM,CAAC;IACxC,MAAM,OAAO,GAAG,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACzF,IAAI,OAAO,IAAI,UAAU,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;QACnE,MAAM,SAAS,GAAG,oBAAoB,CAAC,UAAU,CAAC,IAAI,WAAW,CAAC,gBAAgB,CAAC;QAEnF,OAAO,KAAK;aACT,IAAI,CAAC,UAAU,CAAC;aAChB,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;aACtB,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAElC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAAwB,EAAE,KAAmB,EAAE,EAAE,CAC/E,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,sCAAsC,CAAC,CAAC,CAAC"}
@@ -1,5 +1,5 @@
1
1
  import { describe, expect, it } from 'vitest';
2
- import { createInternalError, createNotFoundError } from './errors.js';
2
+ import { createForbiddenError, createInternalError, createNotFoundError } from './errors.js';
3
3
  describe('Error Utilities', () => {
4
4
  describe('createInternalError', () => {
5
5
  it('should create a default internal error', () => {
@@ -24,6 +24,19 @@ describe('Error Utilities', () => {
24
24
  });
25
25
  });
26
26
  });
27
+ describe('createForbiddenError', () => {
28
+ it('should create a forbidden error with message and entityId', () => {
29
+ const entityId = 'http://example.com/entity/123';
30
+ const error = createForbiddenError('No access', entityId);
31
+ expect(error).toEqual({
32
+ error: {
33
+ code: 'FORBIDDEN',
34
+ message: 'No access',
35
+ details: { entityId },
36
+ },
37
+ });
38
+ });
39
+ });
27
40
  describe('createNotFoundError', () => {
28
41
  it('should create a not found error with message', () => {
29
42
  const message = 'Entity not found';
@@ -1 +1 @@
1
- {"version":3,"file":"errors.test.js","sourceRoot":"","sources":["../../src/utils/errors.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvE,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,KAAK,GAAG,mBAAmB,EAAE,CAAC;YAEpC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,uBAAuB;oBAChC,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,aAAa,GAAG,4BAA4B,CAAC;YACnD,MAAM,KAAK,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;YAEjD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,aAAa;oBACtB,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,OAAO,GAAG,kBAAkB,CAAC;YACnC,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAE3C,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO;oBACP,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,OAAO,GAAG,kBAAkB,CAAC;YACnC,MAAM,QAAQ,GAAG,+BAA+B,CAAC;YACjD,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAErD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO;oBACP,OAAO,EAAE;wBACP,QAAQ;qBACT;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,OAAO,GAAG,kBAAkB,CAAC;YACnC,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAEtD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO;oBACP,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"errors.test.js","sourceRoot":"","sources":["../../src/utils/errors.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAE7F,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,KAAK,GAAG,mBAAmB,EAAE,CAAC;YAEpC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,uBAAuB;oBAChC,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,aAAa,GAAG,4BAA4B,CAAC;YACnD,MAAM,KAAK,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;YAEjD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,aAAa;oBACtB,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,QAAQ,GAAG,+BAA+B,CAAC;YACjD,MAAM,KAAK,GAAG,oBAAoB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAE1D,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,WAAW;oBACpB,OAAO,EAAE,EAAE,QAAQ,EAAE;iBACtB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,OAAO,GAAG,kBAAkB,CAAC;YACnC,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAE3C,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO;oBACP,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,OAAO,GAAG,kBAAkB,CAAC;YACnC,MAAM,QAAQ,GAAG,+BAA+B,CAAC;YACjD,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAErD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO;oBACP,OAAO,EAAE;wBACP,QAAQ;qBACT;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,OAAO,GAAG,kBAAkB,CAAC;YACnC,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAEtD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO;oBACP,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ import type { FastifyInstance } from 'fastify';
2
+ export declare const setupValidation: (fastify: FastifyInstance) => void;
@@ -0,0 +1,8 @@
1
+ import { serializerCompiler, validatorCompiler } from 'fastify-type-provider-zod';
2
+ import { errorHandler } from './errors.js';
3
+ export const setupValidation = (fastify) => {
4
+ fastify.setValidatorCompiler(validatorCompiler);
5
+ fastify.setSerializerCompiler(serializerCompiler);
6
+ fastify.setErrorHandler(errorHandler);
7
+ };
8
+ //# sourceMappingURL=validation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAElF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAwB,EAAE,EAAE;IAC1D,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAChD,OAAO,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAElD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;AACxC,CAAC,CAAC"}
@@ -0,0 +1,18 @@
1
+ import type { FastifyReply } from 'fastify';
2
+ import type { PrismaClient } from '../generated/prisma/client.js';
3
+ import type { IsAuthenticated, RequestContext } from '../types/context.js';
4
+ import type { EntityVisibilityFilter, SearchVisibilityFilter } from '../types/visibility.js';
5
+ export declare const AllVisibleEntityFilter: EntityVisibilityFilter;
6
+ export declare const AllVisibleSearchFilter: SearchVisibilityFilter;
7
+ export declare const isAnonymous: (isAuthenticated: IsAuthenticated | undefined, context: RequestContext) => Promise<boolean>;
8
+ export type RefusalOptions = {
9
+ promptLoginForHidden: boolean;
10
+ isAuthenticated?: IsAuthenticated;
11
+ };
12
+ type NotVisibleResponderOptions = RefusalOptions & {
13
+ notFoundMessage: string;
14
+ exists: (id: string) => Promise<boolean>;
15
+ };
16
+ export declare const createNotVisibleResponder: ({ promptLoginForHidden, isAuthenticated, notFoundMessage, exists }: NotVisibleResponderOptions) => (reply: FastifyReply, id: string, context: RequestContext) => Promise<never>;
17
+ export declare const createEntityNotVisibleResponder: (prisma: PrismaClient, refusal: RefusalOptions) => (reply: FastifyReply, id: string, context: RequestContext) => Promise<never>;
18
+ export {};
@@ -0,0 +1,16 @@
1
+ import { createNotFoundError, sendRefusal } from './errors.js';
2
+ export const AllVisibleEntityFilter = () => ({});
3
+ export const AllVisibleSearchFilter = () => ({ match_all: {} });
4
+ export const isAnonymous = async (isAuthenticated, context) => isAuthenticated ? !(await isAuthenticated(context)) : false;
5
+ export const createNotVisibleResponder = ({ promptLoginForHidden, isAuthenticated, notFoundMessage, exists }) => async (reply, id, context) => {
6
+ if (promptLoginForHidden && (await isAnonymous(isAuthenticated, context)) && (await exists(id))) {
7
+ return sendRefusal(reply, true, id);
8
+ }
9
+ return reply.code(404).send(createNotFoundError(notFoundMessage, id));
10
+ };
11
+ export const createEntityNotVisibleResponder = (prisma, refusal) => createNotVisibleResponder({
12
+ ...refusal,
13
+ notFoundMessage: 'The requested entity was not found',
14
+ exists: async (id) => (await prisma.entity.count({ where: { id } })) > 0,
15
+ });
16
+ //# sourceMappingURL=visibility.js.map
@@ -0,0 +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,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;AAKxF,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,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "arocapi",
4
- "version": "5.0.0-beta.2",
4
+ "version": "5.0.0-beta.3",
5
5
  "description": "An RO-Crate API",
6
6
  "main": "dist/app.js",
7
7
  "exports": {
@@ -69,21 +69,22 @@
69
69
  "load-test-data": "tsx src/scripts/loadEntities.ts",
70
70
  "lint:biome": "biome check",
71
71
  "lint:types": "tsc --noEmit",
72
+ "lint:examples": "tsc --emitDeclarationOnly && tsc -p website/examples",
72
73
  "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\"",
74
+ "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\"",
74
75
  "test": "./scripts/setup-integration.sh vitest run",
75
76
  "test:ci": "vitest run",
76
77
  "test:watch": "./scripts/setup-integration.sh && vitest",
77
78
  "test:ui": "./scripts/setup-integration.sh && vitest --ui",
78
79
  "test:coverage": "./scripts/setup-integration.sh vitest run --coverage",
79
- "generate": "npx prisma generate",
80
+ "generate": "prisma generate",
80
81
  "db:generate": "prisma generate",
81
82
  "db:migrate": "prisma migrate deploy",
82
83
  "seed": "rm -rf dist && pnpm run build && node --env-file=.env example/data/seed.ts"
83
84
  },
84
85
  "repository": {
85
86
  "type": "git",
86
- "url": "https://github.com/Language-Research-Technology/arocapi"
87
+ "url": "https://github.com/crate-works/arocapi"
87
88
  },
88
89
  "publishConfig": {
89
90
  "registry": "https://registry.npmjs.org/",
package/src/app.test.ts CHANGED
@@ -2,7 +2,8 @@ import Fastify from 'fastify';
2
2
  import { beforeEach, describe, expect, it, vi } from 'vitest';
3
3
  import { mockReset } from 'vitest-mock-extended';
4
4
 
5
- import app, { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from './app.js';
5
+ import type { Options } from './app.js';
6
+ import app, { AllPublicAccess, AllVisibleEntityFilter, AllVisibleSearchFilter } from './app.js';
6
7
 
7
8
  import { opensearch, prisma } from './test/helpers/fastify.js';
8
9
 
@@ -12,97 +13,75 @@ describe('Entity Route', () => {
12
13
  mockReset(opensearch);
13
14
  });
14
15
 
15
- describe('App Registration', () => {
16
- it('should handle missing prisma', async () => {
17
- const fastify = Fastify({ logger: false });
18
-
19
- // @ts-expect-error we are testing missing options
20
- fastify.register(app, {
21
- opensearch,
22
- });
23
-
24
- await expect(() => fastify.ready()).rejects.toThrowError('Prisma client is required');
25
- });
16
+ const requiredOptions = (): Options => ({
17
+ prisma,
18
+ opensearch,
19
+ access: AllPublicAccess,
20
+ fileHandler: { get: vi.fn(), head: vi.fn() },
21
+ roCrateHandler: { get: vi.fn(), head: vi.fn() },
22
+ entityVisibilityFilter: AllVisibleEntityFilter,
23
+ searchVisibilityFilter: AllVisibleSearchFilter,
24
+ });
26
25
 
27
- it('should handle missing opensearch', async () => {
26
+ describe('App Registration', () => {
27
+ it.each([
28
+ ['prisma', 'Prisma client is required'],
29
+ ['opensearch', 'OpenSearch client is required'],
30
+ ['access', 'access is required'],
31
+ ['fileHandler', 'fileHandler is required'],
32
+ ['roCrateHandler', 'roCrateHandler is required'],
33
+ ['entityVisibilityFilter', 'entityVisibilityFilter is required'],
34
+ ['searchVisibilityFilter', 'searchVisibilityFilter is required'],
35
+ ] as const)('should handle missing %s', async (option, message) => {
28
36
  const fastify = Fastify({ logger: false });
37
+ const { [option]: _omitted, ...options } = requiredOptions();
29
38
 
30
39
  // @ts-expect-error we are testing missing options
31
- fastify.register(app, {
32
- prisma,
33
- });
40
+ fastify.register(app, options);
34
41
 
35
- await expect(() => fastify.ready()).rejects.toThrowError('OpenSearch client is required');
42
+ await expect(() => fastify.ready()).rejects.toThrowError(message);
36
43
  });
37
44
 
38
- it('should handle missing accessTransformer', async () => {
45
+ it.each([
46
+ ['accessTransformer', 'access', 'https://arocapi.crate-works.org/configuration/access/'],
47
+ ['fileAccessTransformer', 'access', 'https://arocapi.crate-works.org/configuration/access/'],
48
+ [
49
+ 'hiddenResponse',
50
+ 'promptLoginForHidden and isAuthenticated',
51
+ 'https://arocapi.crate-works.org/configuration/visibility/#promptloginforhidden',
52
+ ],
53
+ ])('should reject the removed %s option', async (option, replacement, docs) => {
39
54
  const fastify = Fastify({ logger: false });
40
55
 
41
- // @ts-expect-error we are testing missing options
42
- fastify.register(app, {
43
- prisma,
44
- opensearch,
45
- });
56
+ fastify.register(app, { ...requiredOptions(), [option]: 'notFound' });
46
57
 
47
- await expect(() => fastify.ready()).rejects.toThrowError('accessTransformer is required');
58
+ await expect(() => fastify.ready()).rejects.toThrowError(
59
+ `${option} has been replaced by ${replacement}, see ${docs}`,
60
+ );
48
61
  });
49
62
 
50
- it('should handle missing fileAccessTransformer', async () => {
63
+ it('should reject promptLoginForHidden without isAuthenticated', async () => {
51
64
  const fastify = Fastify({ logger: false });
52
65
 
53
- // @ts-expect-error we are testing missing options
54
- fastify.register(app, {
55
- prisma,
56
- opensearch,
57
- accessTransformer: AllPublicAccessTransformer,
58
- });
66
+ fastify.register(app, { ...requiredOptions(), promptLoginForHidden: true });
59
67
 
60
- await expect(() => fastify.ready()).rejects.toThrowError('fileAccessTransformer is required');
68
+ await expect(() => fastify.ready()).rejects.toThrowError('promptLoginForHidden requires isAuthenticated');
61
69
  });
62
70
 
63
- it('should handle missing fileHandler', async () => {
71
+ it('should ignore a removed option left undefined', async () => {
64
72
  const fastify = Fastify({ logger: false });
65
73
 
66
- // @ts-expect-error we are testing missing options
67
- fastify.register(app, {
68
- prisma,
69
- opensearch,
70
- accessTransformer: AllPublicAccessTransformer,
71
- fileAccessTransformer: AllPublicFileAccessTransformer,
72
- });
73
-
74
- await expect(() => fastify.ready()).rejects.toThrowError('fileHandler is required');
75
- });
74
+ await fastify.register(app, { ...requiredOptions(), accessTransformer: undefined } as Options);
76
75
 
77
- it('should handle missing roCrateHandler', async () => {
78
- const fastify = Fastify({ logger: false });
76
+ await expect(fastify.ready()).resolves.toBeDefined();
79
77
 
80
- // @ts-expect-error we are testing missing options
81
- fastify.register(app, {
82
- prisma,
83
- opensearch,
84
- accessTransformer: AllPublicAccessTransformer,
85
- fileAccessTransformer: AllPublicFileAccessTransformer,
86
- fileHandler: {
87
- get: vi.fn(),
88
- head: vi.fn(),
89
- },
90
- });
91
-
92
- await expect(() => fastify.ready()).rejects.toThrowError('roCrateHandler is required');
78
+ await fastify.close();
93
79
  });
94
80
 
95
81
  it('should register successfully with all required options', async () => {
96
82
  const fastify = Fastify({ logger: false });
97
83
 
98
- await fastify.register(app, {
99
- prisma,
100
- opensearch,
101
- accessTransformer: AllPublicAccessTransformer,
102
- fileAccessTransformer: AllPublicFileAccessTransformer,
103
- fileHandler: { get: vi.fn(), head: vi.fn() },
104
- roCrateHandler: { get: vi.fn(), head: vi.fn() },
105
- });
84
+ await fastify.register(app, requiredOptions());
106
85
 
107
86
  await expect(fastify.ready()).resolves.toBeDefined();
108
87
 
package/src/app.ts CHANGED
@@ -1,7 +1,6 @@
1
1
  import sensible from '@fastify/sensible';
2
2
  import type { Client } from '@opensearch-project/opensearch';
3
- import type { FastifyInstance, FastifyPluginAsync } from 'fastify';
4
- import { hasZodFastifySchemaValidationErrors, serializerCompiler, validatorCompiler } from 'fastify-type-provider-zod';
3
+ import type { FastifyPluginAsync } from 'fastify';
5
4
  import type { PrismaClient } from './generated/prisma/client.js';
6
5
  import capabilities from './routes/capabilities.js';
7
6
  import entities from './routes/entities.js';
@@ -10,22 +9,27 @@ import file from './routes/file.js';
10
9
  import files from './routes/files.js';
11
10
  import metadata from './routes/metadata.js';
12
11
  import search from './routes/search.js';
12
+ import type { AccessFunction } from './types/access.js';
13
+ import type { IsAuthenticated } from './types/context.js';
13
14
  import type { FileHandler, RoCrateHandler } from './types/fileHandlers.js';
14
- import type {
15
- AccessTransformer,
16
- EntityTransformer,
17
- FileAccessTransformer,
18
- FileTransformer,
19
- } from './types/transformers.js';
20
- import { createValidationError } from './utils/errors.js';
15
+ import type { EntityTransformer, FileTransformer } from './types/transformers.js';
16
+ import type { EntityVisibilityFilter, SearchVisibilityFilter } from './types/visibility.js';
17
+ import { notFoundHandler } from './utils/errors.js';
21
18
  import type { FacetCapability, FilterCapability, QueryBuilderOptions, SearchCapability } from './utils/queryBuilder.js';
22
19
  import { OpensearchQueryBuilder } from './utils/queryBuilder.js';
20
+ import { setupValidation } from './utils/validation.js';
23
21
 
24
- export type { AuthorisedEntity, AuthorisedFile, StandardEntity, StandardFile } from './transformers/default.js';
25
- export { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from './transformers/default.js';
22
+ export type {
23
+ AuthorisedEntity,
24
+ AuthorisedFile,
25
+ BaseEntity,
26
+ StandardEntity,
27
+ StandardFile,
28
+ } from './transformers/default.js';
29
+ export type { AccessFunction, AccessInfo } from './types/access.js';
30
+ export type { IsAuthenticated, RequestContext } from './types/context.js';
26
31
  export type {
27
32
  FileHandler,
28
- FileHandlerContext,
29
33
  FileMetadata,
30
34
  FilePathResult,
31
35
  FileRedirectResult,
@@ -37,38 +41,35 @@ export type {
37
41
  HeadRoCrateHandler,
38
42
  RoCrateHandler,
39
43
  } from './types/fileHandlers.js';
40
- export type {
41
- AccessTransformer,
42
- EntityTransformer,
43
- FileAccessTransformer,
44
- FileTransformer,
45
- TransformerContext,
46
- } from './types/transformers.js';
44
+ export type { EntityTransformer, FileTransformer } from './types/transformers.js';
45
+ export type { EntityVisibilityFilter, SearchVisibilityFilter } from './types/visibility.js';
46
+ export type { LicenceAccessOptions } from './utils/access.js';
47
+ export { AllPublicAccess, LicenceAccess } from './utils/access.js';
48
+ export type { ErrorCode, StandardErrorResponse } from './utils/errors.js';
49
+ export {
50
+ createAuthenticationRequiredError,
51
+ createError,
52
+ createForbiddenError,
53
+ createInternalError,
54
+ createNotFoundError,
55
+ createValidationError,
56
+ ERROR_CODES,
57
+ errorHandler,
58
+ notFoundHandler,
59
+ } from './utils/errors.js';
60
+ export { AllVisibleEntityFilter, AllVisibleSearchFilter } from './utils/visibility.js';
47
61
  export type { FacetCapability, FilterCapability, QueryBuilderOptions, SearchCapability };
48
62
  export { OpensearchQueryBuilder };
49
63
 
50
- const setupValidation = (fastify: FastifyInstance) => {
51
- fastify.setValidatorCompiler(validatorCompiler);
52
- fastify.setSerializerCompiler(serializerCompiler);
53
-
54
- fastify.setErrorHandler((error, _req, reply) => {
55
- /* c8 ignore else -- non-Zod errors are caught by route try/catch in practice -- @preserve */
56
- if (hasZodFastifySchemaValidationErrors(error)) {
57
- const violations = error.validation.map((v) => ({
58
- field: v.instancePath,
59
- message: v.message,
60
- }));
61
-
62
- return reply.code(400).send(createValidationError('The request parameters are invalid', violations));
63
- }
64
+ const DOCS_URL = 'https://arocapi.crate-works.org';
64
65
 
65
- /* v8 ignore start -- defensive fallback for non-Zod errors -- @preserve */
66
- // NOTE: We are exposing the error message here for development purposes.
67
- // In production, consider hiding error details to avoid leaking sensitive information.
68
- const err = error as Error;
69
- return reply.code(500).send({ error: 'Internal Server Error', message: err.message });
70
- /* v8 ignore stop */
71
- });
66
+ const REMOVED_OPTIONS: Record<string, { replacement: string; docs: string }> = {
67
+ accessTransformer: { replacement: 'access', docs: `${DOCS_URL}/configuration/access/` },
68
+ fileAccessTransformer: { replacement: 'access', docs: `${DOCS_URL}/configuration/access/` },
69
+ hiddenResponse: {
70
+ replacement: 'promptLoginForHidden and isAuthenticated',
71
+ docs: `${DOCS_URL}/configuration/visibility/#promptloginforhidden`,
72
+ },
72
73
  };
73
74
 
74
75
  export type Options = {
@@ -76,12 +77,15 @@ export type Options = {
76
77
  opensearch: Client;
77
78
  queryBuilderClass?: typeof OpensearchQueryBuilder;
78
79
  queryBuilderOptions?: QueryBuilderOptions;
79
- accessTransformer: AccessTransformer;
80
+ access: AccessFunction;
80
81
  entityTransformers?: EntityTransformer[];
81
- fileAccessTransformer: FileAccessTransformer;
82
82
  fileTransformers?: FileTransformer[];
83
83
  fileHandler: FileHandler;
84
84
  roCrateHandler: RoCrateHandler;
85
+ entityVisibilityFilter: EntityVisibilityFilter;
86
+ searchVisibilityFilter: SearchVisibilityFilter;
87
+ isAuthenticated?: IsAuthenticated;
88
+ promptLoginForHidden?: boolean;
85
89
  };
86
90
  const app: FastifyPluginAsync<Options> = async (fastify, options) => {
87
91
  const {
@@ -89,12 +93,15 @@ const app: FastifyPluginAsync<Options> = async (fastify, options) => {
89
93
  opensearch,
90
94
  queryBuilderClass,
91
95
  queryBuilderOptions,
92
- accessTransformer,
96
+ access,
93
97
  entityTransformers,
94
- fileAccessTransformer,
95
98
  fileTransformers,
96
99
  fileHandler,
97
100
  roCrateHandler,
101
+ entityVisibilityFilter,
102
+ searchVisibilityFilter,
103
+ isAuthenticated,
104
+ promptLoginForHidden = false,
98
105
  } = options;
99
106
 
100
107
  if (!prisma) {
@@ -105,12 +112,14 @@ const app: FastifyPluginAsync<Options> = async (fastify, options) => {
105
112
  throw new Error('OpenSearch client is required');
106
113
  }
107
114
 
108
- if (!accessTransformer) {
109
- throw new Error('accessTransformer is required');
115
+ for (const [removed, { replacement, docs }] of Object.entries(REMOVED_OPTIONS)) {
116
+ if ((options as Record<string, unknown>)[removed] !== undefined) {
117
+ throw new Error(`${removed} has been replaced by ${replacement}, see ${docs}`);
118
+ }
110
119
  }
111
120
 
112
- if (!fileAccessTransformer) {
113
- throw new Error('fileAccessTransformer is required');
121
+ if (!access) {
122
+ throw new Error('access is required');
114
123
  }
115
124
 
116
125
  if (!fileHandler) {
@@ -121,23 +130,45 @@ const app: FastifyPluginAsync<Options> = async (fastify, options) => {
121
130
  throw new Error('roCrateHandler is required');
122
131
  }
123
132
 
133
+ if (!entityVisibilityFilter) {
134
+ throw new Error('entityVisibilityFilter is required');
135
+ }
136
+
137
+ if (!searchVisibilityFilter) {
138
+ throw new Error('searchVisibilityFilter is required');
139
+ }
140
+
141
+ if (promptLoginForHidden && !isAuthenticated) {
142
+ throw new Error('promptLoginForHidden requires isAuthenticated');
143
+ }
144
+
145
+ const refusal = { isAuthenticated, promptLoginForHidden };
146
+
124
147
  fastify.register(sensible);
125
148
  setupValidation(fastify);
126
149
 
150
+ // Fastify only gives a plugin its own not-found handler when registered with its own prefix
151
+ const { prefix } = options as { prefix?: string };
152
+ if (prefix && prefix !== '/') {
153
+ fastify.setNotFoundHandler(notFoundHandler);
154
+ }
155
+
127
156
  const queryBuilder = new (queryBuilderClass ?? OpensearchQueryBuilder)(queryBuilderOptions);
128
157
 
129
158
  fastify.register(capabilities, { queryBuilder });
130
- fastify.register(entities, { prisma, accessTransformer, entityTransformers });
131
- fastify.register(entity, { prisma, accessTransformer, entityTransformers });
132
- fastify.register(files, { prisma, fileAccessTransformer, fileTransformers });
133
- fastify.register(file, { prisma, fileHandler });
134
- fastify.register(metadata, { prisma, roCrateHandler });
159
+ fastify.register(entities, { prisma, access, entityTransformers, entityVisibilityFilter });
160
+ fastify.register(entity, { prisma, access, entityTransformers, entityVisibilityFilter, refusal });
161
+ fastify.register(files, { prisma, access, fileTransformers, entityVisibilityFilter });
162
+ fastify.register(file, { prisma, fileHandler, access, entityVisibilityFilter, refusal });
163
+ fastify.register(metadata, { prisma, roCrateHandler, access, entityVisibilityFilter, refusal });
135
164
  fastify.register(search, {
136
165
  prisma,
137
166
  opensearch,
138
- accessTransformer,
167
+ access,
139
168
  entityTransformers,
140
169
  queryBuilder,
170
+ entityVisibilityFilter,
171
+ searchVisibilityFilter,
141
172
  });
142
173
  };
143
174