arocapi 5.0.0-beta.1 → 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 (128) hide show
  1. package/README.md +37 -802
  2. package/dist/app.d.ts +22 -9
  3. package/dist/app.js +46 -30
  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.d.ts +7 -0
  13. package/dist/routes/capabilities.js +13 -0
  14. package/dist/routes/capabilities.js.map +1 -0
  15. package/dist/routes/capabilities.test.d.ts +1 -0
  16. package/dist/routes/capabilities.test.js +81 -0
  17. package/dist/routes/capabilities.test.js.map +1 -0
  18. package/dist/routes/crate.test.js +67 -19
  19. package/dist/routes/crate.test.js.map +1 -1
  20. package/dist/routes/entities.d.ts +5 -2
  21. package/dist/routes/entities.js +31 -49
  22. package/dist/routes/entities.js.map +1 -1
  23. package/dist/routes/entities.test.js +16 -12
  24. package/dist/routes/entities.test.js.map +1 -1
  25. package/dist/routes/entity.d.ts +7 -2
  26. package/dist/routes/entity.js +14 -29
  27. package/dist/routes/entity.js.map +1 -1
  28. package/dist/routes/entity.test.js +19 -13
  29. package/dist/routes/entity.test.js.map +1 -1
  30. package/dist/routes/file.d.ts +6 -0
  31. package/dist/routes/file.js +67 -59
  32. package/dist/routes/file.js.map +1 -1
  33. package/dist/routes/file.test.js +99 -22
  34. package/dist/routes/file.test.js.map +1 -1
  35. package/dist/routes/files.d.ts +5 -2
  36. package/dist/routes/files.js +24 -39
  37. package/dist/routes/files.js.map +1 -1
  38. package/dist/routes/files.test.js +44 -21
  39. package/dist/routes/files.test.js.map +1 -1
  40. package/dist/routes/metadata.d.ts +6 -0
  41. package/dist/routes/metadata.js +49 -54
  42. package/dist/routes/metadata.js.map +1 -1
  43. package/dist/routes/search.d.ts +8 -5
  44. package/dist/routes/search.js +95 -101
  45. package/dist/routes/search.js.map +1 -1
  46. package/dist/routes/search.test.js +92 -39
  47. package/dist/routes/search.test.js.map +1 -1
  48. package/dist/test/helpers/fastify.d.ts +1 -1
  49. package/dist/test/helpers/fastify.js +2 -3
  50. package/dist/test/helpers/fastify.js.map +1 -1
  51. package/dist/test/integration.setup.d.ts +19 -1
  52. package/dist/test/integration.setup.js +15 -7
  53. package/dist/test/integration.setup.js.map +1 -1
  54. package/dist/test/integration.test.js +368 -2
  55. package/dist/test/integration.test.js.map +1 -1
  56. package/dist/transformers/default.d.ts +10 -18
  57. package/dist/transformers/default.js +41 -15
  58. package/dist/transformers/default.js.map +1 -1
  59. package/dist/transformers/default.test.js +109 -47
  60. package/dist/transformers/default.test.js.map +1 -1
  61. package/dist/transformers/transformer.test.js +12 -34
  62. package/dist/transformers/transformer.test.js.map +1 -1
  63. package/dist/types/access.d.ts +9 -0
  64. package/dist/types/access.js +2 -0
  65. package/dist/types/access.js.map +1 -0
  66. package/dist/types/context.d.ts +6 -0
  67. package/dist/types/context.js +2 -0
  68. package/dist/types/context.js.map +1 -0
  69. package/dist/types/fileHandlers.d.ts +5 -9
  70. package/dist/types/transformers.d.ts +4 -10
  71. package/dist/types/visibility.d.ts +5 -0
  72. package/dist/types/visibility.js +2 -0
  73. package/dist/types/visibility.js.map +1 -0
  74. package/dist/utils/access.d.ts +17 -0
  75. package/dist/utils/access.js +41 -0
  76. package/dist/utils/access.js.map +1 -0
  77. package/dist/utils/errors.d.ts +19 -10
  78. package/dist/utils/errors.js +44 -8
  79. package/dist/utils/errors.js.map +1 -1
  80. package/dist/utils/errors.test.js +14 -1
  81. package/dist/utils/errors.test.js.map +1 -1
  82. package/dist/utils/queryBuilder.d.ts +12 -0
  83. package/dist/utils/queryBuilder.js +9 -0
  84. package/dist/utils/queryBuilder.js.map +1 -1
  85. package/dist/utils/validation.d.ts +2 -0
  86. package/dist/utils/validation.js +8 -0
  87. package/dist/utils/validation.js.map +1 -0
  88. package/dist/utils/visibility.d.ts +18 -0
  89. package/dist/utils/visibility.js +16 -0
  90. package/dist/utils/visibility.js.map +1 -0
  91. package/package.json +34 -33
  92. package/src/app.test.ts +45 -66
  93. package/src/app.ts +92 -58
  94. package/src/errorHandling.test.ts +288 -0
  95. package/src/index.dev.ts +6 -4
  96. package/src/routes/__snapshots__/capabilities.test.ts.snap +34 -0
  97. package/src/routes/__snapshots__/search.test.ts.snap +2 -2
  98. package/src/routes/capabilities.test.ts +102 -0
  99. package/src/routes/capabilities.ts +22 -0
  100. package/src/routes/crate.test.ts +80 -19
  101. package/src/routes/entities.test.ts +16 -12
  102. package/src/routes/entities.ts +40 -59
  103. package/src/routes/entity.test.ts +19 -13
  104. package/src/routes/entity.ts +22 -35
  105. package/src/routes/file.test.ts +117 -22
  106. package/src/routes/file.ts +84 -62
  107. package/src/routes/files.test.ts +52 -26
  108. package/src/routes/files.ts +31 -47
  109. package/src/routes/metadata.ts +64 -58
  110. package/src/routes/search.test.ts +95 -39
  111. package/src/routes/search.ts +120 -125
  112. package/src/test/helpers/fastify.ts +2 -3
  113. package/src/test/integration.setup.ts +18 -7
  114. package/src/test/integration.test.ts +472 -1
  115. package/src/transformers/default.test.ts +139 -47
  116. package/src/transformers/default.ts +103 -83
  117. package/src/transformers/transformer.test.ts +18 -44
  118. package/src/types/access.ts +20 -0
  119. package/src/types/context.ts +15 -0
  120. package/src/types/fileHandlers.ts +5 -13
  121. package/src/types/transformers.ts +4 -32
  122. package/src/types/visibility.ts +18 -0
  123. package/src/utils/access.ts +80 -0
  124. package/src/utils/errors.test.ts +16 -1
  125. package/src/utils/errors.ts +68 -11
  126. package/src/utils/queryBuilder.ts +25 -0
  127. package/src/utils/validation.ts +11 -0
  128. 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"}
@@ -14,6 +14,17 @@ type BoundingBox = {
14
14
  export type QueryBuilderOptions = {
15
15
  aggregations?: Aggregations;
16
16
  };
17
+ export type FilterCapability = {
18
+ type: 'string' | 'date' | 'number' | 'boolean';
19
+ label?: string;
20
+ };
21
+ export type FacetCapability = {
22
+ label?: string;
23
+ };
24
+ export type SearchCapability = {
25
+ filters: Record<string, FilterCapability>;
26
+ facets: Record<string, FacetCapability>;
27
+ };
17
28
  export declare class OpensearchQueryBuilder {
18
29
  aggregations: Aggregations;
19
30
  constructor(opts?: QueryBuilderOptions);
@@ -26,6 +37,7 @@ export declare class OpensearchQueryBuilder {
26
37
  buildAggregations(geohashPrecision?: number, boundingBox?: BoundingBox): {
27
38
  [x: string]: import("@opensearch-project/opensearch/api/_types/_common.aggregations.js").AggregationContainer;
28
39
  };
40
+ searchCapabilities(): SearchCapability;
29
41
  buildSort(sort: string, order: SortOrder): {
30
42
  'name.keyword': SortOrder;
31
43
  }[] | {
@@ -85,6 +85,15 @@ export class OpensearchQueryBuilder {
85
85
  }
86
86
  return aggs;
87
87
  }
88
+ searchCapabilities() {
89
+ const fields = Object.entries(this.aggregations)
90
+ .filter(([, aggregation]) => 'terms' in aggregation)
91
+ .map(([name]) => name);
92
+ return {
93
+ filters: Object.fromEntries(fields.map((name) => [name, { type: 'string' }])),
94
+ facets: Object.fromEntries(fields.map((name) => [name, {}])),
95
+ };
96
+ }
88
97
  buildSort(sort, order) {
89
98
  if (sort === 'relevance') {
90
99
  return;
@@ -1 +1 @@
1
- {"version":3,"file":"queryBuilder.js","sourceRoot":"","sources":["../../src/utils/queryBuilder.ts"],"names":[],"mappings":"AAqBA,MAAM,OAAO,sBAAsB;IACjC,YAAY,CAAe;IAE3B,YAAY,IAA0B;QACpC,IAAI,CAAC,YAAY;YACf,IAAI,EAAE,YAAY;gBAClB,MAAM,CAAC,WAAW,CAChB,CAAC,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;oBAC3E,IAAI;oBACJ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;iBAClD,CAAC,CACH,CAAC;IACN,CAAC;IAED,UAAU,CAAC,UAAkB,EAAE,KAAa,EAAE,OAAkC,EAAE,WAAyB;QACzG,MAAM,IAAI,GAAsB,EAAE,CAAC;QACnC,MAAM,MAAM,GAAwB,EAAE,CAAC;QAEvC,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC;gBACR,WAAW,EAAE;oBACX,KAAK;oBACL,MAAM,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC;oBACjC,IAAI,EAAE,aAAa;oBACnB,SAAS,EAAE,MAAM;oBACjB,gBAAgB,EAAE,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC;gBACR,YAAY,EAAE;oBACZ,KAAK;oBACL,MAAM,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC;oBACjC,gBAAgB,EAAE,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE;gBAClD,MAAM,CAAC,IAAI,CAAC;oBACV,KAAK,EAAE;wBACL,CAAC,KAAK,CAAC,EAAE,MAAM;qBAChB;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC;gBACV,gBAAgB,EAAE;oBAChB,QAAQ,EAAE;wBACR,QAAQ,EAAE;4BACR,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;4BAC7B,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;yBAChC;wBACD,YAAY,EAAE;4BACZ,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;4BAC/B,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;yBAC9B;qBACF;iBACF;aACF,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,IAAI,EAAE;gBACJ,IAAI;gBACJ,MAAM;aACP;SACF,CAAC;IACJ,CAAC;IAED,iBAAiB,CAAC,gBAAyB,EAAE,WAAyB;QACpE,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAGtC,IAAI,gBAAgB,IAAI,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,YAAY,GAAG;gBAClB,YAAY,EAAE;oBACZ,KAAK,EAAE,UAAU;oBACjB,SAAS,EAAE,gBAAgB;oBAC3B,MAAM,EAAE;wBACN,QAAQ,EAAE;4BACR,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;4BAC7B,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;yBAChC;wBACD,YAAY,EAAE;4BACZ,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;4BAC/B,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;yBAC9B;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,KAAgB;QACtC,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QAED,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7B,CAAC;CACF"}
1
+ {"version":3,"file":"queryBuilder.js","sourceRoot":"","sources":["../../src/utils/queryBuilder.ts"],"names":[],"mappings":"AAmCA,MAAM,OAAO,sBAAsB;IACjC,YAAY,CAAe;IAE3B,YAAY,IAA0B;QACpC,IAAI,CAAC,YAAY;YACf,IAAI,EAAE,YAAY;gBAClB,MAAM,CAAC,WAAW,CAChB,CAAC,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;oBAC3E,IAAI;oBACJ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;iBAClD,CAAC,CACH,CAAC;IACN,CAAC;IAED,UAAU,CAAC,UAAkB,EAAE,KAAa,EAAE,OAAkC,EAAE,WAAyB;QACzG,MAAM,IAAI,GAAsB,EAAE,CAAC;QACnC,MAAM,MAAM,GAAwB,EAAE,CAAC;QAEvC,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC;gBACR,WAAW,EAAE;oBACX,KAAK;oBACL,MAAM,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC;oBACjC,IAAI,EAAE,aAAa;oBACnB,SAAS,EAAE,MAAM;oBACjB,gBAAgB,EAAE,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC;gBACR,YAAY,EAAE;oBACZ,KAAK;oBACL,MAAM,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC;oBACjC,gBAAgB,EAAE,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE;gBAClD,MAAM,CAAC,IAAI,CAAC;oBACV,KAAK,EAAE;wBACL,CAAC,KAAK,CAAC,EAAE,MAAM;qBAChB;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC;gBACV,gBAAgB,EAAE;oBAChB,QAAQ,EAAE;wBACR,QAAQ,EAAE;4BACR,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;4BAC7B,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;yBAChC;wBACD,YAAY,EAAE;4BACZ,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;4BAC/B,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;yBAC9B;qBACF;iBACF;aACF,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,IAAI,EAAE;gBACJ,IAAI;gBACJ,MAAM;aACP;SACF,CAAC;IACJ,CAAC;IAED,iBAAiB,CAAC,gBAAyB,EAAE,WAAyB;QACpE,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAGtC,IAAI,gBAAgB,IAAI,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,YAAY,GAAG;gBAClB,YAAY,EAAE;oBACZ,KAAK,EAAE,UAAU;oBACjB,SAAS,EAAE,gBAAgB;oBAC3B,MAAM,EAAE;wBACN,QAAQ,EAAE;4BACR,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;4BAC7B,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;yBAChC;wBACD,YAAY,EAAE;4BACZ,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG;4BAC/B,GAAG,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG;yBAC9B;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kBAAkB;QAChB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC;aAC7C,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,OAAO,IAAI,WAAW,CAAC;aACnD,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;QAEzB,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC7E,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;SAC7D,CAAC;IACJ,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,KAAgB;QACtC,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QAED,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7B,CAAC;CACF"}
@@ -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.1",
4
+ "version": "5.0.0-beta.3",
5
5
  "description": "An RO-Crate API",
6
6
  "main": "dist/app.js",
7
7
  "exports": {
@@ -14,38 +14,38 @@
14
14
  "author": "John Ferlito <johnf@inodes.org>",
15
15
  "license": "ISC",
16
16
  "dependencies": {
17
- "@fastify/sensible": "^6.0.4",
18
- "@opensearch-project/opensearch": "^3.5.1",
19
- "@prisma/config": "^7.5.0",
20
- "dotenv": "^17.3.1",
21
- "fastify": "^5.8.4",
22
- "fastify-type-provider-zod": "^6.1.0",
23
- "zod": "^4.3.6"
17
+ "@fastify/sensible": "^6.0.7",
18
+ "@opensearch-project/opensearch": "^3.9.0",
19
+ "@prisma/config": "^7.10.0",
20
+ "dotenv": "^18.0.7",
21
+ "fastify": "^5.12.5",
22
+ "fastify-type-provider-zod": "^7.0.0",
23
+ "zod": "^4.6.6"
24
24
  },
25
25
  "devDependencies": {
26
- "@biomejs/biome": "^2.4.9",
27
- "@commitlint/cli": "^20.5.0",
28
- "@commitlint/config-conventional": "^20.5.0",
29
- "@prisma/adapter-mariadb": "^7.5.0",
30
- "@prisma/client": "^7.5.0",
31
- "@semantic-release/changelog": "^6.0.3",
32
- "@semantic-release/git": "^10.0.1",
26
+ "@biomejs/biome": "^2.5.15",
27
+ "@commitlint/cli": "^21.2.3",
28
+ "@commitlint/config-conventional": "^21.2.3",
29
+ "@prisma/adapter-mariadb": "^7.10.0",
30
+ "@prisma/client": "^7.10.0",
31
+ "@semantic-release/changelog": "^7.0.0",
32
+ "@semantic-release/git": "^11.0.1",
33
33
  "@total-typescript/ts-reset": "^0.6.1",
34
- "@types/node": "^24.12.0",
35
- "@vitest/coverage-v8": "^4.1.1",
36
- "@vitest/ui": "^4.1.1",
37
- "concurrently": "^9.2.1",
38
- "conventional-changelog-conventionalcommits": "^9.3.0",
34
+ "@types/node": "^26.6.5",
35
+ "@vitest/coverage-v8": "^5.0.3",
36
+ "@vitest/ui": "^5.0.3",
37
+ "concurrently": "^10.0.6",
38
+ "conventional-changelog-conventionalcommits": "^9.3.1",
39
39
  "fastify-tsconfig": "^3.0.0",
40
- "knip": "^6.0.5",
41
- "lefthook": "^2.1.4",
42
- "prisma": "^7.5.0",
43
- "prisma-json-types-generator": "^4.1.1",
44
- "semantic-release": "^25.0.3",
45
- "tsx": "^4.21.0",
46
- "typescript": "^6.0.2",
47
- "vitest": "^4.1.1",
48
- "vitest-mock-extended": "^3.1.0"
40
+ "knip": "^6.41.0",
41
+ "lefthook": "^2.2.1",
42
+ "prisma": "^7.10.0",
43
+ "prisma-json-types-generator": "^5.1.1",
44
+ "semantic-release": "^25.0.9",
45
+ "tsx": "^4.23.15",
46
+ "typescript": "^7.0.2",
47
+ "vitest": "^5.0.3",
48
+ "vitest-mock-extended": "^5.1.1"
49
49
  },
50
50
  "peerDependencies": {
51
51
  "@prisma/client": ">=6"
@@ -69,25 +69,26 @@
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/",
90
91
  "provenance": true
91
92
  },
92
- "packageManager": "pnpm@10.24.0+sha512.01ff8ae71b4419903b65c60fb2dc9d34cf8bb6e06d03bde112ef38f7a34d6904c424ba66bea5cdcf12890230bf39f9580473140ed9c946fef328b6e5238a345a"
93
+ "packageManager": "pnpm@12.11.2"
93
94
  }
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